IRockyCloudPoint Struct Reference
Last update: 16.07.2025#include <rocky_point_cloud_api.hpp>
Public Member Functions | |
| ROCKY_FUNCTIONS double3 | get_position () const |
| template<class _data_type = double> | |
| ROCKY_FUNCTIONS _data_type | get_property (int property_index) const |
| ROCKY_FUNCTIONS bool | is_enabled () const |
| ROCKY_FUNCTIONS bool | is_valid () const |
Detailed Description
IRockyCloudPoint is an interface to the data of the nearest point to a given particle or SPH element at a given time.
Member Function Documentation
◆ get_position()
| ROCKY_FUNCTIONS double3 IRockyCloudPoint::get_position | ( | ) | const |
- Returns
- The Cartesian coordinates of the referred point in the cloud point.
◆ get_property()
template<class _data_type >
| 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.
◆ is_enabled()
| ROCKY_FUNCTIONS bool IRockyCloudPoint::is_enabled | ( | ) | const |
- Returns
- True if the current point cloud is enabled, false otherwise.
◆ 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.
