SyncToken

class ooc::delta::SyncToken

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.

ooc::delta::SynchronizeWith

Methods

friend SyncResult SynchronizeWith(Env, std::function<void(SyncToken const&)>)

private

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.

ooc::delta::DeleteNode

ooc::delta::DeleteSpecificPoints

ooc::delta::OptimizeDeltas

Parameters

env: The point cloud environment to synchronize with.

func: The callback to call when the point cloud is in a synchronized state

Returns

an ooc::delta::SyncResult return code.
friend ModifyResult DeleteNode(SyncToken const&, NodeHandle const&)

private

Deletes the given node. Subsequent uses of node_handle are illegal.

ooc::delta::SynchronizeWith

Parameters

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.

Returns

an ooc::delta::ModifyResult return code.
friend ModifyResult DeleteSpecificPoints(SyncToken const&, NodeHandle const&, int32_t const[], size_t)

private

Deletes specific points of the given node. point_indices must satisfy the following:

  • contain no duplicate values
  • contain only values in the inclusive range [0, node_point_count - 1] (see ooc::query::PointCount)
  • be sorted in increasing order

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.

ooc::delta::SynchronizeWith

Parameters

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

Returns

an ooc::delta::ModifyResult return code.
friend OptimizeResult OptimizeDeltas(SyncToken const &sync_token, OptimizeConfig const &config)

private

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.

ooc::delta::DeleteNode

ooc::delta::DeleteSpecificPoints

ooc::delta::SynchronizeWith

Parameters

sync_token: A token passed in to guarantee that synchronization is taking place for a given point cloud.

config: Configuration options for optimization.

Returns

an ooc::delta::OptimizeResult return code
Env ooc::delta::SyncToken::GetEnv() const

const

ooc::delta::SyncToken::SyncToken(Env env, PointCloudWorld &pcw)

private

PointCloudWorld &ooc::delta::SyncToken::GetWorld() const

private const

ooc::delta::SyncToken::SyncToken(SyncToken const&)

private

ooc::delta::SyncToken::SyncToken(SyncToken&&)

private

void ooc::delta::SyncToken::operator=(SyncToken const&)

private

void ooc::delta::SyncToken::operator=(SyncToken&&)

private

void ooc::delta::SyncToken::operator&() const

private const

Variables

Env ooc::delta::SyncToken::env

private

PointCloudWorld &ooc::delta::SyncToken::pcw

private

PointCloudWorld