ooc
Index
Functions
Configure()Destroy()GetEnv()GetEnvCount()GetEnvs()GetNodeHandle()GetRoot()GetSegmentKey()GetShellKey()GetTranslate()IsRoot()PollNodesLoadingOrHaveBeenLoaded()Release()
Namespaces
Classes
Functions
-
bool
ooc::IsRoot(HC_KEY ooc_root) - bool IsRoot(HC_KEY ooc_root)
Reports whether or not the key ooc_root is the root of a point cloud.
Parameters
ooc_root: The key to testReturns
true if ooc_root is the root of a point cloud and false otherwise.
-
bool
ooc::GetEnv(HC_KEY ooc_root, Env &out_env) - bool GetEnv(HC_KEY ooc_root,
Env& out_env)This function is the means to obtain a point cloud’s
ooc::Env. The out_env is modified if and only if this function returns true. This will return the first point cloud only in the order loaded.Parameters
ooc_root: The root key of a point cloud.
out_env: Out parameter for returning the
ooc::Envof a point cloud.Returns
true if ooc_root corresponds to a point cloud. Returns false otherwise.
-
size_t
ooc::GetEnvs(HC_KEY ooc_root, Env *out_envs, size_t count) - size_t GetEnvs(HC_KEY ooc_root,
Env* out_envs, size_t count)Internal use only This function is the means to obtain one or more point cloud
ooc::Env. The out_env is modified if and only if this function returns true. This will return the first point cloud in the order loaded.Parameters
ooc_root: The root key of a point cloud.
out_envs: Out array parameter for returning the
ooc::Envof a point cloud.count: In parameter for the maximum number of point clouds to write to the out_envs array.
Returns
The number of envs written to out_envs.
-
size_t
ooc::GetEnvCount(HC_KEY ooc_root) - size_t GetEnvCount(HC_KEY ooc_root)
Internal use only This function is the means to obtain the number of point clouds that exist.
Parameters
ooc_root: The root key of a point cloud.Returns
The number of point clouds.
-
HC_KEY
ooc::GetRoot(Env env) - HC_KEY GetRoot(
Envenv)Returns the root key of the point cloud referred to by env.
Parameters
env: The environment of the point cloud to get the root key from.Returns
the root key of the point cloud referred to by env.
-
void
ooc::Destroy(Env env) - void Destroy(
Envenv)Destroys a point cloud instance. This both frees memory used by the point cloud as well as deletes the HOOPS segment tree that belonged to the point cloud. Passing env to other API functions after this function is called is illegal.
ooc::Release
ooc::FileInputByKey
Parameters
env: The environment of the point cloud to destroy.
-
void
ooc::Release(Env env) - void Release(
Envenv)Releases a point cloud instance. This both frees memory used by the point cloud as well as removes the node populators from the HOOPS segment tree that belonged to the point cloud. Unlike ooc::Destroy, this function leaves intact the HOOPS segment structure of the point cloud and any node geometry that was already loaded into the segments. Passing env to other API functions after this function is called is illegal.
ooc::Release
ooc::FileInputByKey
Parameters
env: The environment of the point cloud to destroy.
-
bool
ooc::GetNodeHandle(Env env, HC_KEY node_segment_key, NodeHandle &out_node_handle) - bool GetNodeHandle(
Envenv, HC_KEY node_segment_key,NodeHandle& out_node_handle)Retrieves the node handle that corresponds to a segment key through the out parameter out_node_handle.
Parameters
env: The corresponding point cloud environment.
node_segment_key: The segment key to obtain a node handle from.
out_node_handle: Out parameter for the returned node handle.
Returns
true if successful and false otherwise.
-
HC_KEY
ooc::GetSegmentKey(Env env, NodeHandle const &node_handle) - HC_KEY GetSegmentKey(
Envenv,NodeHandle& node_handle)Retrieves the segment key that corresponds to a node handle.
Parameters
env: The point cloud environment for node_handle.
node_handle: The node handle of the segment key to be returned.
Returns
the segment key that corresponds to the input node handle.
-
HC_KEY
ooc::GetShellKey(Env env, NodeHandle const &node_handle) - HC_KEY GetShellKey(
Envenv,NodeHandle& node_handle)Retrieves the shell key that corresponds to a node handle. Returns HC_ERROR_KEY if the node currently has no shell data loaded in memory. Note that the shell keys returned by this function are transient and may be unloaded from memory by the point cloud system.
Parameters
env: The point cloud environment for node_handle.
node_handle: The node handle of the shell key to be returned.
Returns
the shell key that corresponds to a node handle if successful. Returns HC_ERROR_KEY otherwise.
-
bool
ooc::PollNodesLoadingOrHaveBeenLoaded(Env env) - bool PollNodesLoadingOrHaveBeenLoaded(
Envenv)This function is a polling mechanism to provide users a means to determine if updates are needed for a point cloud.
ooc::FileInputByKeyParameters
env: The point cloud environment for node_handle.Returns
true if data is currently being loaded into point cloud nodes. Returns true if data has been loaded into point cloud nodes since the last time this function was called. Returns false otherwise.
-
void
ooc::GetTranslate(Env env, double &x, double &y, double &z) - void GetTranslate(
Envenv, double x, double y, double z)Internal use only
Parameters
x:
y:
z:
-
int
ooc::Configure(char const *in, char *out) - int Configure(char const in, char out)
Internal use only
Parameters
in:
out:
Returns
int