MeVisLab Toolbox Reference
Public Member Functions | List of all members
ml::MLPCLObjectPtrsContainer Struct Reference

A container with pointers from the PCL (Point Cloud Library) passed in BaseObjects between PCL modules. More...

#include <mlPCLObjectPtrsContainer.h>

Public Member Functions

 MLPCLObjectPtrsContainer ()
 Default constructor initializing all pointers to defaults.
 
void clearPCLObjectPointers ()
 Sets all pointers to nullptr.
 
bool hasValidPointCloudPointer () const
 Returns true if at least one of all point cloud pointers is valid.
 
bool hasValidPolygonMeshPointer () const
 Returns true if at least one of all polygon mesh pointers is valid.
 
bool hasValidPCLObjectPointer () const
 Returns true if at least one of all PCL object pointer is valid.
 
std::string getScalarMemberValueAsString (size_t pointIdx, size_t memberIdx) const
 From the first valid pointer return the memberIdx'th scalar member as string, regardless of its types or whether it is stored in a structures, arrays or single member.
 
std::string getScalarMemberNameAsString (size_t memberIdx) const
 From the first valid member pointer the memberIdx'th scalar member is returned as string, regardless of its types or whether it is stored in a structures, arrays or single member.
 
 MLPCLObjectPtrsContainer (MLPointCloudXYZPtr pcPtr)
 Specific constructor for the given object type setting all other objects to nullptr.
 
 MLPCLObjectPtrsContainer (MLPointCloudXYZLNormalPtr pcPtr)
 
 MLPCLObjectPtrsContainer (MLPointCloudXYZRGBNormalPtr pcPtr)
 
 MLPCLObjectPtrsContainer (MLPointCloudXYZINormalPtr pcPtr)
 
 MLPCLObjectPtrsContainer (MLPolygonMeshPtr pMeshPtr)
 
void setPCLObjectPointer (MLPointCloudXYZPtr pcPtr)
 Setting a new container object clearing all other ones.
 
void setPCLObjectPointer (MLPointCloudXYZLNormalPtr pcPtr)
 
void setPCLObjectPointer (MLPointCloudXYZRGBNormalPtr pcPtr)
 
void setPCLObjectPointer (MLPointCloudXYZINormalPtr pcPtr)
 
void setPCLObjectPointer (MLPolygonMeshPtr pMeshPtr)
 
void getPCLObjectPointer (MLPointCloudXYZPtr &pcPtr) const
 Method returning the cloud pointer matching the given pointer type.
 
void getPCLObjectPointer (MLPointCloudXYZLNormalPtr &pcPtr) const
 
void getPCLObjectPointer (MLPointCloudXYZRGBNormalPtr &pcPtr) const
 
void getPCLObjectPointer (MLPointCloudXYZINormalPtr &pcPtr) const
 

Public Attributes

Supported and precompiled point cloud and mesh types.
MLPointCloudXYZPtr pointCloudXYZ
 Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], data[3] should usually be 1, see pcl::PointXYZ for details.
 
MLPointCloudXYZLNormalPtr pointCloudXYZLNormal
 Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], and a normal of four floats normal[0]-normal[2], data_n[3], or alternatively data_n[0]-data_n[3], a float curvature, an uint32 label; data[3] should usually be set to 1 and data_n[3] to 0, see pcl::PointXYZLNormal for details.
 
MLPointCloudXYZRGBNormalPtr pointCloudXYZRGBNormal
 Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], and a normal of four floats normal[0]-normal[2], data_n[3], or alternatively data_n[0]-data_n[3], and an rgba uint32 packed color value (alternatively and deprecated as float rgb); a float curvature, data[3] should usually be set to 1 and data_n[3] to 0, see pcl::PointXYZRGBNormal for details.
 
MLPointCloudXYZINormalPtr pointCloudXYZINormal
 Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], and a normal of four floats normal[0]-normal[2], data_n[3], or alternatively data_n[0]-data_n[3], a float curvature, and an intensity float value; data[3] should usually be set to 1 and data_n[3] to 0, see pcl::PointXYZINormal for details.
 
MLPolygonMeshPtr polygonMesh
 Pointer to a pcl::Polygon mesh, see pcl::Polygon for details.
 

Detailed Description

A container with pointers from the PCL (Point Cloud Library) passed in BaseObjects between PCL modules.

Definition at line 21 of file mlPCLObjectPtrsContainer.h.

Constructor & Destructor Documentation

◆ MLPCLObjectPtrsContainer() [1/6]

ml::MLPCLObjectPtrsContainer::MLPCLObjectPtrsContainer ( )

Default constructor initializing all pointers to defaults.

◆ MLPCLObjectPtrsContainer() [2/6]

ml::MLPCLObjectPtrsContainer::MLPCLObjectPtrsContainer ( MLPointCloudXYZPtr pcPtr)

Specific constructor for the given object type setting all other objects to nullptr.

◆ MLPCLObjectPtrsContainer() [3/6]

ml::MLPCLObjectPtrsContainer::MLPCLObjectPtrsContainer ( MLPointCloudXYZLNormalPtr pcPtr)

◆ MLPCLObjectPtrsContainer() [4/6]

ml::MLPCLObjectPtrsContainer::MLPCLObjectPtrsContainer ( MLPointCloudXYZRGBNormalPtr pcPtr)

◆ MLPCLObjectPtrsContainer() [5/6]

ml::MLPCLObjectPtrsContainer::MLPCLObjectPtrsContainer ( MLPointCloudXYZINormalPtr pcPtr)

◆ MLPCLObjectPtrsContainer() [6/6]

ml::MLPCLObjectPtrsContainer::MLPCLObjectPtrsContainer ( MLPolygonMeshPtr pMeshPtr)

Member Function Documentation

◆ clearPCLObjectPointers()

void ml::MLPCLObjectPtrsContainer::clearPCLObjectPointers ( )

Sets all pointers to nullptr.

◆ getPCLObjectPointer() [1/4]

void ml::MLPCLObjectPtrsContainer::getPCLObjectPointer ( MLPointCloudXYZINormalPtr & pcPtr) const
inline

Definition at line 87 of file mlPCLObjectPtrsContainer.h.

References mlrange_cast().

◆ getPCLObjectPointer() [2/4]

void ml::MLPCLObjectPtrsContainer::getPCLObjectPointer ( MLPointCloudXYZLNormalPtr & pcPtr) const
inline

Definition at line 85 of file mlPCLObjectPtrsContainer.h.

References mlrange_cast().

◆ getPCLObjectPointer() [3/4]

void ml::MLPCLObjectPtrsContainer::getPCLObjectPointer ( MLPointCloudXYZPtr & pcPtr) const
inline

Method returning the cloud pointer matching the given pointer type.

Definition at line 84 of file mlPCLObjectPtrsContainer.h.

References mlrange_cast().

◆ getPCLObjectPointer() [4/4]

void ml::MLPCLObjectPtrsContainer::getPCLObjectPointer ( MLPointCloudXYZRGBNormalPtr & pcPtr) const
inline

Definition at line 86 of file mlPCLObjectPtrsContainer.h.

References mlrange_cast().

◆ getScalarMemberNameAsString()

std::string ml::MLPCLObjectPtrsContainer::getScalarMemberNameAsString ( size_t memberIdx) const

From the first valid member pointer the memberIdx'th scalar member is returned as string, regardless of its types or whether it is stored in a structures, arrays or single member.

Invalid indexes are allowed and lead to the return of an empty string.

◆ getScalarMemberValueAsString()

std::string ml::MLPCLObjectPtrsContainer::getScalarMemberValueAsString ( size_t pointIdx,
size_t memberIdx ) const

From the first valid pointer return the memberIdx'th scalar member as string, regardless of its types or whether it is stored in a structures, arrays or single member.

Invalid indexes are allowed and lead to the return of an empty string.

◆ hasValidPCLObjectPointer()

bool ml::MLPCLObjectPtrsContainer::hasValidPCLObjectPointer ( ) const

Returns true if at least one of all PCL object pointer is valid.

◆ hasValidPointCloudPointer()

bool ml::MLPCLObjectPtrsContainer::hasValidPointCloudPointer ( ) const

Returns true if at least one of all point cloud pointers is valid.

◆ hasValidPolygonMeshPointer()

bool ml::MLPCLObjectPtrsContainer::hasValidPolygonMeshPointer ( ) const

Returns true if at least one of all polygon mesh pointers is valid.

◆ setPCLObjectPointer() [1/5]

void ml::MLPCLObjectPtrsContainer::setPCLObjectPointer ( MLPointCloudXYZINormalPtr pcPtr)

◆ setPCLObjectPointer() [2/5]

void ml::MLPCLObjectPtrsContainer::setPCLObjectPointer ( MLPointCloudXYZLNormalPtr pcPtr)

◆ setPCLObjectPointer() [3/5]

void ml::MLPCLObjectPtrsContainer::setPCLObjectPointer ( MLPointCloudXYZPtr pcPtr)

Setting a new container object clearing all other ones.

◆ setPCLObjectPointer() [4/5]

void ml::MLPCLObjectPtrsContainer::setPCLObjectPointer ( MLPointCloudXYZRGBNormalPtr pcPtr)

◆ setPCLObjectPointer() [5/5]

void ml::MLPCLObjectPtrsContainer::setPCLObjectPointer ( MLPolygonMeshPtr pMeshPtr)

Member Data Documentation

◆ pointCloudXYZ

MLPointCloudXYZPtr ml::MLPCLObjectPtrsContainer::pointCloudXYZ

Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], data[3] should usually be 1, see pcl::PointXYZ for details.

Definition at line 28 of file mlPCLObjectPtrsContainer.h.

◆ pointCloudXYZINormal

MLPointCloudXYZINormalPtr ml::MLPCLObjectPtrsContainer::pointCloudXYZINormal

Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], and a normal of four floats normal[0]-normal[2], data_n[3], or alternatively data_n[0]-data_n[3], a float curvature, and an intensity float value; data[3] should usually be set to 1 and data_n[3] to 0, see pcl::PointXYZINormal for details.

Definition at line 52 of file mlPCLObjectPtrsContainer.h.

◆ pointCloudXYZLNormal

MLPointCloudXYZLNormalPtr ml::MLPCLObjectPtrsContainer::pointCloudXYZLNormal

Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], and a normal of four floats normal[0]-normal[2], data_n[3], or alternatively data_n[0]-data_n[3], a float curvature, an uint32 label; data[3] should usually be set to 1 and data_n[3] to 0, see pcl::PointXYZLNormal for details.

Definition at line 36 of file mlPCLObjectPtrsContainer.h.

◆ pointCloudXYZRGBNormal

MLPointCloudXYZRGBNormalPtr ml::MLPCLObjectPtrsContainer::pointCloudXYZRGBNormal

Cloud with four floats x,y,z,data[3], or alternatively data[0]-data[3], and a normal of four floats normal[0]-normal[2], data_n[3], or alternatively data_n[0]-data_n[3], and an rgba uint32 packed color value (alternatively and deprecated as float rgb); a float curvature, data[3] should usually be set to 1 and data_n[3] to 0, see pcl::PointXYZRGBNormal for details.

Definition at line 44 of file mlPCLObjectPtrsContainer.h.

◆ polygonMesh

MLPolygonMeshPtr ml::MLPCLObjectPtrsContainer::polygonMesh

Pointer to a pcl::Polygon mesh, see pcl::Polygon for details.

Definition at line 55 of file mlPCLObjectPtrsContainer.h.

The documentation for this struct was generated from the following file: