CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdRxRcsFileServices Class Referenceabstract

#include <RxRcsFileServices.h>

Inheritance diagram for OdRxRcsFileServices:
OdRxModule OdRxObject

Public Member Functions

virtual OdPointCloudScanDatabasePtr readRcsFile (const OdString &filePath, OdPointCloudDatabaseReceiver *pDbReceiver=nullptr) const =0
 
virtual OdPointCloudScanDatabasePtr readRcsFile (OdStreamBufPtr pFile, OdPointCloudDatabaseReceiver *pDbReceiver=nullptr) const =0
 
virtual OdPointCloudProjectDatabasePtr readRcpFile (const OdString &filePath, OdPointCloudProjectScanStorage *pScanStorage, OdPointCloudDatabaseReceiver *pDbReceiver=nullptr) const =0
 
virtual OdPointCloudProjectDatabasePtr readRcpFile (OdStreamBufPtr pFile, OdPointCloudProjectScanStorage *pScanStorage, OdPointCloudDatabaseReceiver *pDbReceiver=nullptr) const =0
 
virtual OdPointCloudConverterPtr getPointCloudConverter (OdPointCloudDataSourcePtr pDataSource, OdPointCloudConverterParamsPtr pParams=nullptr) const =0
 
virtual OdRcsDataManagerPtr getRcsDataManager (OdPointCloudScanDatabasePtr pScanDb, OdPointCloudProjectDatabasePtr pHostProjectDb=nullptr) const =0
 
virtual OdPointCloudDataSourcePtr getPointCloudDataSource (const OdString &filePath, OdPointCloudDataSource::Units units=OdPointCloudDataSource::kMeter, ODCOLORREF defaultColor=0, OdPointCloudDataSource::ColorRange colorRange=OdPointCloudDataSource::kColorRange255, const OdUInt32Array &xyzIndexes={}, const OdUInt32Array &rgbIndexes={}, OdUInt32 intensityIndex=3, OdUInt32 skipLines=0, const OdString &separator=" ") const =0
 
- Public Member Functions inherited from OdRxModule
 ODRX_DECLARE_MEMBERS (OdRxModule)
 
virtual voidsysData ()=0
 
virtual void deleteModule ()=0
 
virtual void initApp ()=0
 
virtual void uninitApp ()=0
 
virtual OdString moduleName () const =0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

<group OdRx_Classes>

This is an interface class for the module that provides loading point cloud data from and to .rcs/.rcp files.

Remarks
Corresponding C++ library: RcsFileServices.

Definition at line 55 of file RxRcsFileServices.h.

Member Function Documentation

◆ getPointCloudConverter()

virtual OdPointCloudConverterPtr OdRxRcsFileServices::getPointCloudConverter ( OdPointCloudDataSourcePtr pDataSource,
OdPointCloudConverterParamsPtr pParams = nullptr ) const
pure virtual

Creates a new point cloud converter with user implemented data source and with converter parameters to convert user point cloud data to .rcs file.

Parameters
pDataSource[in] Pointer to point cloud data source instance.
pParams[in] Pointer to conversion parameters.
Returns
The pointer to the OdPointCloudConverter object.

◆ getPointCloudDataSource()

virtual OdPointCloudDataSourcePtr OdRxRcsFileServices::getPointCloudDataSource ( const OdString & filePath,
OdPointCloudDataSource::Units units = OdPointCloudDataSource::kMeter,
ODCOLORREF defaultColor = 0,
OdPointCloudDataSource::ColorRange colorRange = OdPointCloudDataSource::kColorRange255,
const OdUInt32Array & xyzIndexes = {},
const OdUInt32Array & rgbIndexes = {},
OdUInt32 intensityIndex = 3,
OdUInt32 skipLines = 0,
const OdString & separator = " " ) const
pure virtual

Creates a point cloud data source for the specified point cloud file.

Parameters
filePath[in] Path to the point cloud file.
units[in] Measurement units for the point cloud coordinates.
defaultColor[in] Default color of points in the point cloud.
colorRange[in] Color range for points in the point cloud. Only for pts and xyz (optional).
xyzIndexes[in] Indexes of points coordinates in each point data, e.g. { 0, 1, 2 }. Only for pts and xyz (optional).
rgbIndexes[in] Indexes of points colors components in each point data, e.g. { 4, 5, 6 }. Only for pts and xyz (optional).
intensity[in] Index of intensity component in each point data, e.g. 3. Only for pts and xyz (optional).
skipLines[in] Number of lines in the file above the points data. Only for xyz (optional).
separator[in] Separator between each point' fields. Only for xyz (optional).
Returns
The pointer to OdPointCloudDataSource object.

◆ getRcsDataManager()

virtual OdRcsDataManagerPtr OdRxRcsFileServices::getRcsDataManager ( OdPointCloudScanDatabasePtr pScanDb,
OdPointCloudProjectDatabasePtr pHostProjectDb = nullptr ) const
pure virtual

Creates a new data manager object for the specified point cloud scan database.

Parameters
pScanDb[in] Pointer to the point cloud scan database.
pHostProjectDb[in] Pointer to the host point cloud project database.
Returns
The pointer to OdRcsDataManager object.

◆ readRcpFile() [1/2]

virtual OdPointCloudProjectDatabasePtr OdRxRcsFileServices::readRcpFile ( const OdString & filePath,
OdPointCloudProjectScanStorage * pScanStorage,
OdPointCloudDatabaseReceiver * pDbReceiver = nullptr ) const
pure virtual

Creates a new point cloud project database object and populates it with the data from the corresponding point cloud project file (.rcp file) specified by its file path.

Parameters
filePath[in] Path to the .rcp file.
pScanStorage[out] Point cloud project scan storage.
pDbReceiver[out] (optional) Point cloud database receiver.
Returns
The pointer to the OdPointCloudProjectDatabase object.

◆ readRcpFile() [2/2]

virtual OdPointCloudProjectDatabasePtr OdRxRcsFileServices::readRcpFile ( OdStreamBufPtr pFile,
OdPointCloudProjectScanStorage * pScanStorage,
OdPointCloudDatabaseReceiver * pDbReceiver = nullptr ) const
pure virtual

Creates a new point cloud project database object and populates it with the data from the corresponding point cloud project file (.rcp file) represented by stream.

Parameters
pFile[in] Stream corresponding to .rcp file.
pScanStorage[out] Point cloud project scan storage.
pDbReceiver[out] (optional) Point cloud database receiver.
Returns
The pointer to the OdPointCloudProjectDatabase object.

◆ readRcsFile() [1/2]

virtual OdPointCloudScanDatabasePtr OdRxRcsFileServices::readRcsFile ( const OdString & filePath,
OdPointCloudDatabaseReceiver * pDbReceiver = nullptr ) const
pure virtual

Creates a new point cloud scan database object and populates it with the data read from a point cloud scan file (.rcs file) specified by its file path.

Parameters
filePath[in] Path to the .rcs file.
pDbReceiver[out] (optional) Point cloud database receiver.
Returns
The pointer to the OdPointCloudScanDatabase object.

◆ readRcsFile() [2/2]

virtual OdPointCloudScanDatabasePtr OdRxRcsFileServices::readRcsFile ( OdStreamBufPtr pFile,
OdPointCloudDatabaseReceiver * pDbReceiver = nullptr ) const
pure virtual

Creates a new point cloud scan database object and populates it with the data read from a point cloud scan file (.rcs file) represented by stream.

Parameters
pFile[in] Stream corresponding to .rcs file.
pDbReceiver[out] (optional) Point cloud database receiver.
Returns
The pointer to the OdPointCloudScanDatabase object.

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