SCENE C++ API  2.0.22
Public Member Functions | List of all members
LSPointCloud Class Reference

Interface class to access information and functionality of project point clouds. More...

#include <lspointcloud.h>

+ Inheritance diagram for LSPointCloud:

Public Member Functions

int getPointCloudVersion () const
 Returns the internal version number of this point cloud. More...
 
LSIterator< LSPointXYZRGBgetPointCloudIterator ()
 Gets an iterator to run over all points which are part of the point cloud. More...
 
LSIterator< LSPointXYZRGBgetPointCloudIterator (const LSSphereVolume &volume) const
 Gets an iterator to run over all points which are contained in a volume. More...
 
LSIterator< LSPointXYZRGBgetPointCloudIterator (ref_ptr< LSVolumeDefinition > volume) const
 Gets an iterator to run over all points which are contained in a user-defined volume. More...
 
ref_ptr< LSPointCloudRenderercreatePointCloudRenderer () const
 Creates a renderer instance for this point cloud. More...
 
void determineBoundingBox (Eigen::Vector3d &minOut, Eigen::Vector3d &maxOut) const
 Determines the bounding box in global coordinates of this point cloud. More...
 
uint64_t getNumberOfPoints () const
 Retrieves the number of points of the this point cloud. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

Interface class to access information and functionality of project point clouds.

Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ getPointCloudVersion()

int getPointCloudVersion ( ) const

Returns the internal version number of this point cloud.

Version 1 is a point cloud created with SCENE 5.X Version 2 is a point cloud created with SCENE 6.0 Version 3 is a point cloud created with SCENE >= 6.1 and contains point normals information

Returns
internal version number or -1 in case of an invalid point cloud
Version
SCENE API Version 2.0.14.

◆ getPointCloudIterator() [1/3]

LSIterator<LSPointXYZRGB> getPointCloudIterator ( )

Gets an iterator to run over all points which are part of the point cloud.

The returned points are in global coordinates.

Returns
The iterator instance.
Version
SCENE API Version 2.0.0.

◆ getPointCloudIterator() [2/3]

LSIterator<LSPointXYZRGB> getPointCloudIterator ( const LSSphereVolume volume) const

Gets an iterator to run over all points which are contained in a volume.

The returned points are in global coordinates.

Parameters
volumeThe volume to search.
Returns
The iterator instance.
Version
SCENE API Version 2.0.9.

◆ getPointCloudIterator() [3/3]

LSIterator<LSPointXYZRGB> getPointCloudIterator ( ref_ptr< LSVolumeDefinition volume) const

Gets an iterator to run over all points which are contained in a user-defined volume.

The returned points are in global coordinates.

Parameters
volumeThe user-defined volume to search.
Returns
The iterator instance.
Version
SCENE API Version 2.0.14.

◆ createPointCloudRenderer()

ref_ptr<LSPointCloudRenderer> createPointCloudRenderer ( ) const

Creates a renderer instance for this point cloud.

Returns
The ref_ptr to the renderer instance for point clouds with internal version number greater or equal to 2
A nullptr in case of internal point cloud version 1
A nullptr in case no extended permissions are available.
Version
SCENE API Version 2.0.14.

◆ determineBoundingBox()

void determineBoundingBox ( Eigen::Vector3d &  minOut,
Eigen::Vector3d &  maxOut 
) const

Determines the bounding box in global coordinates of this point cloud.

Parameters
minOutOutput parameter describing the minimum of the bounding box.
maxOutOutput parameter describing the maximum of the bounding box.
Version
SCENE API Version 2.0.14.

◆ getNumberOfPoints()

uint64_t getNumberOfPoints ( ) const

Retrieves the number of points of the this point cloud.

Returns
Number of points of the point cloud
Version
SCENE API Version 2.0.20.