## On this page

  

 

 # Structure IRockyCloudPoint

 Last update: 09.03.2026 

<a id="structIRockyCloudPoint"></a>

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

**\#include &lt;rocky\_point\_cloud\_api.hpp&gt;**

`<a href="structIRockyCloudPoint.md#structIRockyCloudPoint">IRockyCloudPoint</a>` is an interface to the data of the nearest point to a given particle or SPH element at a given time.

## Members

- [add\_property](structIRockyCloudPoint.md#structIRockyCloudPoint_1a9136329c0b219a389b02ae624761b741)
- [add\_property](structIRockyCloudPoint.md#structIRockyCloudPoint_1a2cb5ab14f36601af7337fd8ac71363fa)
- [get\_position](structIRockyCloudPoint.md#structIRockyCloudPoint_1a1d06a1eb80ad0811ab2794f2a494fe17)
- [get\_property](structIRockyCloudPoint.md#structIRockyCloudPoint_1a51d29e82619836ed172e8f3135bf0f51)
- [is\_enabled](structIRockyCloudPoint.md#structIRockyCloudPoint_1ae9e37938664d6977e49593d1ec8f3dbd)
- [is\_valid](structIRockyCloudPoint.md#structIRockyCloudPoint_1a79dfeecd7f7360ed1e25135ed54ed312)
- [set\_property](structIRockyCloudPoint.md#structIRockyCloudPoint_1a0668da5d5605bad7835355c5f6e3d269)
- [set\_property](structIRockyCloudPoint.md#structIRockyCloudPoint_1a92918f0daa29121981d3549569518573)

## Public functions

### Function get\_position

<a id="structIRockyCloudPoint_1a1d06a1eb80ad0811ab2794f2a494fe17"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
ROCKY_FUNCTIONS double3 IRockyCloudPoint::get_position() const

```

**Returns**:

The Cartesian coordinates of the referred point in the cloud point.

**Return type**: ROCKY\_FUNCTIONS double3

### Function get\_property

<a id="structIRockyCloudPoint_1a51d29e82619836ed172e8f3135bf0f51"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
ROCKY_FUNCTIONS _data_type IRockyCloudPoint::get_property(int property_index) const

```

**Returns**:

The value of a property in the cloud point dataset, corresponding to the referred point in the point cloud.

**Parameters**:

- int **property\_index**

**Return type**: ROCKY\_FUNCTIONS \_data\_type

### Function add\_property

<a id="structIRockyCloudPoint_1a9136329c0b219a389b02ae624761b741"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
ROCKY_FUNCTIONS void IRockyCloudPoint::add_property(int property_index, _data_type value) const

```

Adds value to the current property value identified by property\_index. This method is intended to be used only for user-defined point cloud properties of `CollectiveOperationType=cotIntegrated`, because these properties are automatically accumulated at post-forces hook. Using it on properties with a different `CollectiveOperationType` can lead to unexpected results. **Parameters**:

- **property\_index**: The index that identifies the point cloud property
- **value**: Value to add on property

**Parameters**:

- int **property\_index**
- \_data\_type **value**

**Return type**: ROCKY\_FUNCTIONS void

### Function set\_property

<a id="structIRockyCloudPoint_1a0668da5d5605bad7835355c5f6e3d269"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
ROCKY_FUNCTIONS void IRockyCloudPoint::set_property(int property_index, _data_type value) const

```

Set the value of property identified by property\_index to the passed value. This method is intended to be used only for user-defined point cloud properties. **Parameters**:

- **property\_index**: The index that identifies the point cloud property
- **value**: Value to add on property

**Parameters**:

- int **property\_index**
- \_data\_type **value**

**Return type**: ROCKY\_FUNCTIONS void

### Function is\_enabled

<a id="structIRockyCloudPoint_1ae9e37938664d6977e49593d1ec8f3dbd"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
ROCKY_FUNCTIONS bool IRockyCloudPoint::is_enabled() const

```

**Returns**:

True if the current point cloud is enabled, false otherwise.

**Return type**: ROCKY\_FUNCTIONS bool

### Function is\_valid

<a id="structIRockyCloudPoint_1a79dfeecd7f7360ed1e25135ed54ed312"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
bool IRockyCloudPoint::is_valid() const

```

**Returns**:

True if the nearest point is a valid one for the particle passed to get\_particle\_cloud\_point or get\_element\_cloud\_point. Invalid nearest points are only marked when search\_cut\_off\_distance is enabled for the point cloud.

**Return type**: ROCKY\_FUNCTIONS bool

### Function add\_property

<a id="structIRockyCloudPoint_1a2cb5ab14f36601af7337fd8ac71363fa"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void IRockyCloudPoint::add_property(int property_index, const _data_type value) const

```

**Parameters**:

- int **property\_index**
- const \_data\_type **value**

**Return type**: void

### Function set\_property

<a id="structIRockyCloudPoint_1a92918f0daa29121981d3549569518573"></a>

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
void IRockyCloudPoint::set_property(int property_index, _data_type value) const

```

**Parameters**:

- int **property\_index**
- \_data\_type **value**

**Return type**: void