Public Member Functions | Static Public Member Functions | List of all members
HPS::OOC::PointCloud Class Reference

#include <sprk_ooc.h>

Public Member Functions

IOResult CommitDeltasToFile ()
 
IOResult CommitDeltasToFile (HPS::UTF8 &out_delta_file_name)
 
bool DeleteFromPointCloud (HPS::OOC::AreaHighlightTracker &tracker)
 
void Destroy ()
 
bool Empty ()
 
bool Equals (PointCloud const &other) const
 
NodeHandle GetNodeHandle (HPS::SegmentKey const &node_key)
 
HPS::SegmentKey GetSegment ()
 
bool HasUncommittedDeltas ()
 
bool operator!= (PointCloud const &other) const
 
PointCloud & operator= (PointCloud &&other)
 
bool operator== (PointCloud const &other) const
 
 PointCloud ()
 
 PointCloud (HPS::Model const &in_model)
 
 PointCloud (PointCloud &&that)
 
bool PollUpdateNeeded ()
 
OOC::QueryIterator QueryPoints (QueryFilter &filter)
 
void Release ()
 
HPS::OOC::SynchronizedActions::Result Synchronize (Synchronized &synchronized)
 

Static Public Member Functions

static bool ShowPointClouds (HPS::Model const &in_model, HPS::OOC::PointCloudArray &out_point_clouds)
 

Detailed Description

The PointCloud class provides interactions with a OOC point cloud.

Constructor & Destructor Documentation

◆ PointCloud() [1/3]

HPS::OOC::PointCloud::PointCloud ( )

Constructs an uninitialized point cloud.

Returns
The uninitialized point cloud.

◆ PointCloud() [2/3]

HPS::OOC::PointCloud::PointCloud ( HPS::Model const &  in_model)

Constructs a point cloud under an existing Model.

Returns
The point cloud.

◆ PointCloud() [3/3]

HPS::OOC::PointCloud::PointCloud ( PointCloud &&  that)

Move constructs a point cloud from an existing one.

Returns
The point cloud.

Member Function Documentation

◆ CommitDeltasToFile()

IOResult HPS::OOC::PointCloud::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
Returns
an IOResult return code.

◆ DeleteFromPointCloud()

bool HPS::OOC::PointCloud::DeleteFromPointCloud ( HPS::OOC::AreaHighlightTracker &  tracker)

Deletes points that intersect the areas from the provided tracker.

Returns
Returns true if no error occurs Returns false otherwise.

◆ Destroy()

void HPS::OOC::PointCloud::Destroy ( )

Releases and removes point cloud. This is automatic when model is deleted.

◆ Empty()

bool HPS::OOC::PointCloud::Empty ( )

Check the state of the PointCloud.

Returns
Returns true if this PointCloud doesn't exist.

◆ GetNodeHandle()

NodeHandle HPS::OOC::PointCloud::GetNodeHandle ( HPS::SegmentKey const &  node_key)

Get a NodeHandle associated with a specific segment.

Parameters
node_keyThe SegmentKey for the requested Node.
Returns
Returns the NodeHandle for the provided segment.

◆ GetSegment()

HPS::SegmentKey HPS::OOC::PointCloud::GetSegment ( )

Gets a the top segment for this PointCloud.

Returns
Returns the top segment for this PointCloud.

◆ HasUncommittedDeltas()

bool HPS::OOC::PointCloud::HasUncommittedDeltas ( )

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

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

◆ PollUpdateNeeded()

bool HPS::OOC::PointCloud::PollUpdateNeeded ( )

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

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

◆ QueryPoints()

OOC::QueryIterator HPS::OOC::PointCloud::QueryPoints ( QueryFilter &  filter)

Begin a query.

Parameters
filterThe filter to apply to the query.
Returns
Returns the QueryIterator.

◆ Release()

void HPS::OOC::PointCloud::Release ( )

Removes ooc hooks. This is automatic when model is deleted.

◆ ShowPointClouds()

static bool HPS::OOC::PointCloud::ShowPointClouds ( HPS::Model const &  in_model,
HPS::OOC::PointCloudArray &  out_point_clouds 
)
static

Returns an array of PointClouds that exist under this model.

Parameters
in_modelThe the model to use.

◆ Synchronize()

HPS::OOC::SynchronizedActions::Result HPS::OOC::PointCloud::Synchronize ( Synchronized &  synchronized)

Begin a synchronized action.

Parameters
synchronizedThe object to synchronize.
Returns
Returns the result of the synchronized actions.
The documentation for this class was generated from the following file: