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

#include <OdRcsVisibleVoxelsIterator.h>

Public Member Functions

virtual ~OdRcsVisibleVoxelsIterator ()
 
virtual void start ()=0
 
virtual void step ()=0
 
virtual bool done () const =0
 
virtual void getVoxelBuffer (OdUInt32 componentsToProcess, OdGiPointCloud::ComponentsRaw *&pComponentsRaws, OdUInt32 &rawsNumber, OdUInt32 &flags, OdUInt64 &voxelIndex, OdUInt32 &numberOfPointsToDraw, OdUInt32 &loadedPointsNumber)=0
 
virtual OdUInt32 getNumberOfLoadedPointsToDraw ()=0
 
virtual bool hasPointsLoaded ()=0
 

Detailed Description

<group OdRcs_Classes>

This is an interface class to iterate through the voxels visible in the current viewport.

Definition at line 46 of file OdRcsVisibleVoxelsIterator.h.

Constructor & Destructor Documentation

◆ ~OdRcsVisibleVoxelsIterator()

virtual OdRcsVisibleVoxelsIterator::~OdRcsVisibleVoxelsIterator ( )
inlinevirtual

Default destructor for objects of the OdRcsVisibleVoxelsIterator class.

Definition at line 53 of file OdRcsVisibleVoxelsIterator.h.

Member Function Documentation

◆ done()

virtual bool OdRcsVisibleVoxelsIterator::done ( ) const
pure virtual

details Indicates whether the traversal by this iterator object is complete.

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

◆ getNumberOfLoadedPointsToDraw()

virtual OdUInt32 OdRcsVisibleVoxelsIterator::getNumberOfLoadedPointsToDraw ( )
pure virtual

Returns a number of loaded points to draw.

Returns
Corresponding value of type OdUInt32.

◆ getVoxelBuffer()

virtual void OdRcsVisibleVoxelsIterator::getVoxelBuffer ( OdUInt32 componentsToProcess,
OdGiPointCloud::ComponentsRaw *& pComponentsRaws,
OdUInt32 & rawsNumber,
OdUInt32 & flags,
OdUInt64 & voxelIndex,
OdUInt32 & numberOfPointsToDraw,
OdUInt32 & loadedPointsNumber )
pure virtual

Fills a special structures used in rendering with pointers to point data from the current voxel pointed to by the iterator.

Parameters
componentsToProcess[in] Component flags used by GiPointCloud to obtain the required point attributes.
pComponentsRaws[out] Pointer to a filled special structures stored in the voxel.
rawsNumber[out] Number of special structures.
flags[out] Size flags used to store each component of the point data.
voxelIndex[out] Index of the voxel in scan database.
numberOfPointsToDraw[out] Total number of visible points to be drawn.
loadedPointsNumber[out] Number of points loaded.

◆ hasPointsLoaded()

virtual bool OdRcsVisibleVoxelsIterator::hasPointsLoaded ( )
pure virtual

Returns a boolean value indicating whether any points in the current voxel are loaded.

Returns
Corresponding boolean value.

◆ start()

virtual void OdRcsVisibleVoxelsIterator::start ( )
pure virtual

Moves the current iterator position to the visible voxel in the current viewport that will be iterated first.

◆ step()

virtual void OdRcsVisibleVoxelsIterator::step ( )
pure virtual

Pteps the current iterator position to the next visible voxel in the current viewport.


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