#include <PointCloudAPI.h>
Public Member Functions | |
Env | GetEnv () const |
Friends | |
ModifyResult | DeleteNode (SyncToken const &, NodeHandle const &) |
ModifyResult | DeleteSpecificPoints (SyncToken const &, NodeHandle const &, int32_t const [], size_t) |
OptimizeResult | OptimizeDeltas (SyncToken const &sync_token, OptimizeConfig const &config) |
SyncResult | SynchronizeWith (Env, std::function< void(SyncToken const &)>) |
A token that is passed into functions that can only be called during a synchronization process. This token helps ensure that such functions cannot be used outside of an OOC synchronization block.
Env ooc::delta::SyncToken::GetEnv | ( | ) | const |
ModifyResult DeleteNode | ( | SyncToken const & | , |
NodeHandle const & | |||
) | [friend] |
Deletes the given node. Subsequent uses of node_handle are illegal.
sync_token | A token passed in to guarantee that synchronization is taking place for a given point cloud. |
node_handle | The handle of the node to be deleted. |
ModifyResult DeleteSpecificPoints | ( | SyncToken const & | , |
NodeHandle const & | , | ||
int32_t | const[], | ||
size_t | |||
) | [friend] |
Deletes specific points of the given node. point_indices must satisfy the following:
If any of the above rules for point_indices are violated, an appropriate error code will be returned through the ooc::delta::ModifyResult return value.
sync_token | A token passed in to guarantee that synchronization is taking place for a given point cloud. |
node_handle | The node handle of the points to be deleted. |
point_indices | The list of point indices to be deleted from the node given by node_handle. |
count | The number of indices in point_indices |
OptimizeResult OptimizeDeltas | ( | SyncToken const & | sync_token, |
OptimizeConfig const & | config | ||
) | [friend] |
Optimizes the internal representation of the changes made to the point cloud. This function is automatically performed when loading in an OOCD file from disk.
sync_token | A token passed in to guarantee that synchronization is taking place for a given point cloud. |
config | Configuration options for optimization. |
SyncResult SynchronizeWith | ( | Env | env, |
std::function< void(SyncToken const &)> | func | ||
) | [friend] |
Allows users to call functions that require synchronization. This is done through the func callback passed into this function. func is called with an ooc::delta::SyncToken reference that corresponds to the environment env passed into this function. Thus the OOC API functions that accept an ooc::delta::SyncToken do not accept an ooc::Env because it is implied by the synchronization token.
env | The point cloud environment to synchronize with. |
func | The callback to call when the point cloud is in a synchronized state |