Inheritance diagram for HPS.OOC.QueryIterator:

Public Types

enum  Status {
Alive = 0, Dead = 1, ErrorUnknownFailure = 2, ErrorFileSystemFailure = 3,
ErrorDeserializationFailure = 4, ErrorCouldNotFindNode = 5, ErrorCorruptNode = 6
}


 
enum  Storage { Memory = 0, Disk = 1 }
 

Public Member Functions

virtual void Dispose ()
 
HPS.OOC.NodeHandle GetNodeHandle ()
 
HPS.Point GetNodePoint ()
 
HPS.RGBColor GetNodePointColor ()
 
ulong GetNodePointIndex ()
 
HPS.OOC.QueryIterator.Status GetStatus ()
 
HPS.OOC.QueryIterator.Storage GetStorage ()
 
void Next ()
 
 QueryIterator ()
 

Protected Member Functions

virtual void deleteCptr ()
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The iterator returned from a call to OOC.PointCloud.QueryPoints.

Member Enumeration Documentation

◆ Status

Designates the status of an QueryIterator.

◆ Storage

Designates the location of an QueryResult.

Constructor & Destructor Documentation

◆ QueryIterator()

HPS.OOC.QueryIterator.QueryIterator ( )
inline

Constructs a dead query iterator.

Returns
The dead iterator

Member Function Documentation

◆ GetNodeHandle()

HPS.OOC.NodeHandle HPS.OOC.QueryIterator.GetNodeHandle ( )
inline

Yields the currently processed point's node handle.

Returns
the node handle of the current result

◆ GetNodePoint()

HPS.Point HPS.OOC.QueryIterator.GetNodePoint ( )
inline

Yields the currently processed point's coordinates in object space.

Returns
the object space coordinates for the point of the current result

◆ GetNodePointColor()

HPS.RGBColor HPS.OOC.QueryIterator.GetNodePointColor ( )
inline

Yields the currently processed point's RGB color.

Returns
the RGB color for the point of the current result

◆ GetNodePointIndex()

ulong HPS.OOC.QueryIterator.GetNodePointIndex ( )
inline

Yields the currently processed point's index.

Returns
the index for the point of the current result.

◆ GetStorage()

HPS.OOC.QueryIterator.Storage HPS.OOC.QueryIterator.GetStorage ( )
inline

Yields the currently processed point's storage.

Returns
the storage for the point of the current result.

◆ Next()

void HPS.OOC.QueryIterator.Next ( )
inline

Advances the iterator to the next point result. This is only legal to call when this->GetStatus() returns OOC.QueryIterator.Status.Alive.


The documentation for this class was generated from the following file:
  • internals/hps_sprk_ooc/source/cs/HPS.OOC.cs