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

#include <OdPointCloudScanIterator.h>

Public Member Functions

virtual ~OdPointCloudScanIterator ()
 
virtual void start ()=0
 
virtual void step ()=0
 
virtual bool done () const =0
 
virtual OdPointCloudScanDatabasePtr getScanDb ()=0
 
virtual OdString getScanTitle () const =0
 
virtual bool getScanIsVisible () const =0
 
virtual OdGeMatrix3d getScanTransform () const =0
 

Detailed Description

<group OdRcs_Classes>

This class is an interface class for the points cloud scan iterator that enables getting scans from a project.

Remarks
Corresponding C++ library: RcsFileServices.

Definition at line 46 of file OdPointCloudScanIterator.h.

Constructor & Destructor Documentation

◆ ~OdPointCloudScanIterator()

virtual OdPointCloudScanIterator::~OdPointCloudScanIterator ( )
inlinevirtual

Default destructor for objects of the OdPointCloudScanIterator class.

Definition at line 53 of file OdPointCloudScanIterator.h.

Member Function Documentation

◆ done()

virtual bool OdPointCloudScanIterator::done ( ) const
pure virtual

Returns true if and only if the traversal by this iterator object is complete.

Returns
True if the traversal by this iterator object is complete; false otherwise.

◆ getScanDb()

virtual OdPointCloudScanDatabasePtr OdPointCloudScanIterator::getScanDb ( )
pure virtual

Returns the pointer to the point cloud scan database that is currently pointed at by the iterator.

Returns
The pointer to the point cloud scan database.

◆ getScanIsVisible()

virtual bool OdPointCloudScanIterator::getScanIsVisible ( ) const
pure virtual

Gets the value of the IsVisible flag of the scan, currently pointed by the iterator. The flag indicates whether the scan is visible.

Returns
True if the scan is visible; false otherwise.

◆ getScanTitle()

virtual OdString OdPointCloudScanIterator::getScanTitle ( ) const
pure virtual

Gets the title of the scan, currently pointed by the iterator.

Returns
The scan title string.

◆ getScanTransform()

virtual OdGeMatrix3d OdPointCloudScanIterator::getScanTransform ( ) const
pure virtual

Returns the complete transformation matrix specified in the project data for the current scan pointed by the iterator.

Returns
Transformation matrix.

◆ start()

virtual void OdPointCloudScanIterator::start ( )
pure virtual

Moves the current position to the beginning of the scan data within the current point cloud project database.

◆ step()

virtual void OdPointCloudScanIterator::step ( )
pure virtual

Moves forward the current position to the next record of the scan data within the current point cloud project database.


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