Structure IRockyCloudPoint
Last update: 09.03.2026
#include <rocky_point_cloud_api.hpp>
IRockyCloudPoint is an interface to the data of the nearest point to a given particle or SPH element at a given time.
Members
Public functions
Function get_position
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
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
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
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
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
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
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
void IRockyCloudPoint::set_property(int property_index, _data_type value) const
Parameters:
- int property_index
- _data_type value
Return type: void
