HPS.OOC.PointCloud

class HPS.OOC.PointCloud : public IDisposable 

The PointCloud class provides interactions with a OOC point cloud.

Public Functions

HPS.OOC.IOResult CommitDeltasToFile ()

Saves to disk any changes made to the point cloud. Beware that moving or renaming dependent files will impact the saved delta file (OOCD) because the OOCD file references them. The most likely result would be that the file cannot be loaded.

A file is generated in the directory xxx/yyy_deltas/ as zzz.oocd where

xxx is the root directory for the OOC files
yyy is given by xxx/yyy.ooc
zzz is the generated file_name for the changes saved to disk.

Example: C:/some_dir/ooc_house_root/house.ooc C:/some_dir/ooc_house_root/house_deltas/00535fe253-0000251e.oocd Here

xxx is C:/some_dir/ooc_house_root
yyy is house
zzz is 00535fe253-0000251e

Return: an IOResult return code.

bool DeleteFromPointCloud (HPS.OOC.AreaHighlightTracker tracker)

Deletes points that intersect the areas from the provided tracker.

Return: Returns true if no error occurs Returns false otherwise.

void Destroy (): Releases and removes point cloud. This is automatic when model is deleted.

bool Empty ()

Check the state of the PointCloud.

Return: Returns true if this PointCloud doesn’t exist.

HPS.OOC.NodeHandle GetNodeHandle (HPS.SegmentKey node_key)

Get a NodeHandle associated with a specific segment.

Param node_key: The SegmentKey for the requested Node.
Return: Returns the NodeHandle for the provided segment.

HPS.SegmentKey GetSegment ()

Gets a the top segment for this PointCloud.

Return: Returns the top segment for this PointCloud.

bool HasUncommittedDeltas ()

Queries whether or not there are any uncommitted deltas in memory for a particular PointCloud.

Return: Returns true if there have been any changes made to the point cloud that have not been committed to disk. Returns false otherwise.

PointCloud ()

Constructs an uninitialized point cloud.

Return: The uninitialized point cloud.

PointCloud (HPS.Model in_model)

Constructs a point cloud under an existing Model.

Return: The point cloud.

bool PollUpdateNeeded ()

Used with manual updates load option. If this returns true an Update must be called on the model.

Return: Returns true if the model must be updated otherwise it returns false.

HPS.OOC.QueryIterator QueryPoints (HPS.OOC.QueryFilter filter)

Begin a query.

Param filter: The filter to apply to the query.
Return: Returns the QueryIterator.

void Release (): Removes ooc hooks. This is automatic when model is deleted.

HPS.OOC.SynchronizedActions.Result Synchronize (HPS.OOC.Synchronized synchronized)

Begin a synchronized action.

Param synchronized: The object to synchronize.
Return: Returns the result of the synchronized actions.

Public Static Functions

bool ShowPointClouds (HPS.Model in_model, out HPS.OOC.PointCloud[] out_point_clouds)

Returns an array of PointClouds that exist under this model.

Param in_model: The the model to use.