CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdPointCloudProjectDatabase Class Referenceabstract

#include <OdPointCloudProjectDatabase.h>

Public Member Functions

virtual ~OdPointCloudProjectDatabase ()
 
virtual OdString getProjectDatabaseFilePath () const =0
 
virtual OdPointCloudScanIteratorPtr getScanIterator () const =0
 
virtual void getAllRcsFilePaths (OdStringArray &list) const =0
 
virtual void getAllRcsRelativeFilePaths (OdStringArray &list) const =0
 
virtual OdGeMatrix3d getGlobalTransformation () const =0
 
virtual OdGeMatrix3d getScanTransform (const OdString &guid) const =0
 
virtual OdUInt32 getTotalRegionsCount () const =0
 
virtual OdUInt32 getTotalScansCount () const =0
 
virtual OdString getCoordinateSystemName () const =0
 
virtual OdInt8 hasRGB () const =0
 
virtual OdInt8 hasNormals () const =0
 
virtual OdInt8 hasIntensity () const =0
 
virtual OdString getRcsFilePath (const OdString &guid) const =0
 
virtual OdString getRcsRelativeFilePath (const OdString &guid) const =0
 
virtual OdUInt64 getTotalAmountOfPoints () const =0
 
virtual OdGeExtents3d getExtents () const =0
 
virtual void writeAllXmlDataToStream (OdStreamBuf *s)=0
 

Detailed Description

<group OdRx_Classes>

This is an interface class for the point cloud project database.

Remarks
Corresponding C++ library: RcsFileServices.

Definition at line 49 of file OdPointCloudProjectDatabase.h.

Constructor & Destructor Documentation

◆ ~OdPointCloudProjectDatabase()

virtual OdPointCloudProjectDatabase::~OdPointCloudProjectDatabase ( )
inlinevirtual

Default destructor for objects of the OdPointCloudProjectDatabase class.

Definition at line 56 of file OdPointCloudProjectDatabase.h.

Member Function Documentation

◆ getAllRcsFilePaths()

virtual void OdPointCloudProjectDatabase::getAllRcsFilePaths ( OdStringArray list) const
pure virtual

Gets the list of paths for all .rcs files associated with the .rcp file.

Parameters
list[in/out] An array of strings to be filled with paths to the .rcs files.

◆ getAllRcsRelativeFilePaths()

virtual void OdPointCloudProjectDatabase::getAllRcsRelativeFilePaths ( OdStringArray list) const
pure virtual

Gets the list of relative paths for all .rcs files associated with the .rcp file.

Parameters
list[in/out] An array of strings to be filled with relative paths to the .rcs files.

◆ getCoordinateSystemName()

virtual OdString OdPointCloudProjectDatabase::getCoordinateSystemName ( ) const
pure virtual

Gets the coordinate system name.

Returns
The coordinate system name.

◆ getExtents()

virtual OdGeExtents3d OdPointCloudProjectDatabase::getExtents ( ) const
pure virtual

Gets the full extents of the point cloud project.

Returns
The extents of the point cloud project.

◆ getGlobalTransformation()

virtual OdGeMatrix3d OdPointCloudProjectDatabase::getGlobalTransformation ( ) const
pure virtual

Gets the global transformation matrix.

Returns
Transformation matrix.

◆ getProjectDatabaseFilePath()

virtual OdString OdPointCloudProjectDatabase::getProjectDatabaseFilePath ( ) const
pure virtual

Gets the path to an .rcp file associated with the database.

Returns
Path to the .rcp file.

◆ getRcsFilePath()

virtual OdString OdPointCloudProjectDatabase::getRcsFilePath ( const OdString guid) const
pure virtual

Gets the path to an .rcs file specified by a guid.

Parameters
guid[in] guid of the .rcs file.
Returns
Path to the .rcs file.

◆ getRcsRelativeFilePath()

virtual OdString OdPointCloudProjectDatabase::getRcsRelativeFilePath ( const OdString guid) const
pure virtual

Gets the relative path to an .rcs file specified by a guid.

Parameters
guid[in] guid of the .rcs file.
Returns
Relative path to the .rcs file.

◆ getScanIterator()

virtual OdPointCloudScanIteratorPtr OdPointCloudProjectDatabase::getScanIterator ( ) const
pure virtual

Creates a new point cloud scan iterator and returns a shared pointer to it.

Returns
Shared pointer to the created scan iterator.

◆ getScanTransform()

virtual OdGeMatrix3d OdPointCloudProjectDatabase::getScanTransform ( const OdString guid) const
pure virtual

Gets the scan transformation matrix.

Parameters
guid[in] ID of the scan (.rcs file) to get the transformation matrix for.
Returns
Transformation matrix.

◆ getTotalAmountOfPoints()

virtual OdUInt64 OdPointCloudProjectDatabase::getTotalAmountOfPoints ( ) const
pure virtual

Gets the total number of points for the point cloud project.

Returns
The total number of points as an OdUInt64 value.

◆ getTotalRegionsCount()

virtual OdUInt32 OdPointCloudProjectDatabase::getTotalRegionsCount ( ) const
pure virtual

Gets the total regions count.

Returns
The number of regions as an OdUInt32 value.

◆ getTotalScansCount()

virtual OdUInt32 OdPointCloudProjectDatabase::getTotalScansCount ( ) const
pure virtual

Gets the total scans count.

Returns
The number of scans as an OdUInt32 value.

◆ hasIntensity()

virtual OdInt8 OdPointCloudProjectDatabase::hasIntensity ( ) const
pure virtual

Indicates whether the associated .rcs files contain intensity.

Returns
1 if all .rcs files associated with the currant .rcp file contains intensity. 0 if at least one .rcs file associated with the currant .rcp file contains intensity. -1 if no .rcs file associated with the currant .rcp file contain intensity.

◆ hasNormals()

virtual OdInt8 OdPointCloudProjectDatabase::hasNormals ( ) const
pure virtual

Indicates whether the associated .rcs files contain normals.

Returns
1 if all .rcs files associated with the currant .rcp file contains normals. 0 if at least one .rcs file associated with the currant .rcp file contains normals. -1 if no .rcs file associated with the currant .rcp file contain normals.

◆ hasRGB()

virtual OdInt8 OdPointCloudProjectDatabase::hasRGB ( ) const
pure virtual

Indicates whether the associated .rcs files contain colors.

Returns
1 if all .rcs files associated with the currant .rcp file contains colors. 0 if at least one .rcs file associated with the currant .rcp file contains colors. -1 if no .rcs file associated with the currant .rcp file contain colors.

◆ writeAllXmlDataToStream()

virtual void OdPointCloudProjectDatabase::writeAllXmlDataToStream ( OdStreamBuf s)
pure virtual

Writes all point cloud project XML data to a specified stream.

Parameters
s[in/out] A stream to write data to.

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