ooc Namespace Reference

Namespaces

 delta
 
 io
 
 preprocess
 
 query
 

Classes

class  Env
 
class  NodeHandle
 
class  Point
 
class  RGBColor
 

Functions

OOC_API int Configure (char const *in, char *out)
 
OOC_API void Destroy (Env env)
 
OOC_API bool GetEnv (HC_KEY ooc_root, Env &out_env)
 
OOC_API size_t GetEnvCount (HC_KEY ooc_root)
 
OOC_API size_t GetEnvs (HC_KEY ooc_root, Env *out_envs, size_t count)
 
OOC_API bool GetNodeHandle (Env env, HC_KEY node_segment_key, NodeHandle &out_node_handle)
 
OOC_API HC_KEY GetRoot (Env env)
 
OOC_API HC_KEY GetSegmentKey (Env env, NodeHandle const &node_handle)
 
OOC_API HC_KEY GetShellKey (Env env, NodeHandle const &node_handle)
 
OOC_API void GetTranslate (Env env, double &x, double &y, double &z)
 
OOC_API bool IsRoot (HC_KEY ooc_root)
 
OOC_API bool PollNodesLoadingOrHaveBeenLoaded (Env env)
 
OOC_API void Release (Env env)
 

Function Documentation

◆ Configure()

OOC_API int ooc::Configure ( char const *  in,
char *  out 
)

Internal use only

Parameters
in
out
Returns
int

◆ Destroy()

OOC_API void ooc::Destroy ( Env  env)

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.

Parameters
envThe environment of the point cloud to destroy.
See also
ooc::Release
ooc::FileInputByKey

◆ GetEnv()

OOC_API bool ooc::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_rootThe root key of a point cloud.
out_envOut parameter for returning the ooc::Env of a point cloud.
Returns
true if ooc_root corresponds to a point cloud. Returns false otherwise.

◆ GetEnvCount()

OOC_API size_t ooc::GetEnvCount ( HC_KEY  ooc_root)

Internal use only This function is the means to obtain the number of point clouds that exist.

Parameters
ooc_rootThe root key of a point cloud.
Returns
The number of point clouds.

◆ GetEnvs()

OOC_API size_t ooc::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_rootThe root key of a point cloud.
out_envsOut array parameter for returning the ooc::Env of a point cloud.
countIn parameter for the maximum number of point clouds to write to the out_envs array.
Returns
The number of envs written to out_envs.

◆ GetNodeHandle()

OOC_API bool ooc::GetNodeHandle ( Env  env,
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
envThe corresponding point cloud environment.
node_segment_keyThe segment key to obtain a node handle from.
out_node_handleOut parameter for the returned node handle.
Returns
true if successful and false otherwise.

◆ GetRoot()

OOC_API HC_KEY ooc::GetRoot ( Env  env)

Returns the root key of the point cloud referred to by env.

Parameters
envThe environment of the point cloud to get the root key from.
Returns
the root key of the point cloud referred to by env.

◆ GetSegmentKey()

OOC_API HC_KEY ooc::GetSegmentKey ( Env  env,
NodeHandle const &  node_handle 
)

Retrieves the segment key that corresponds to a node handle.

Parameters
envThe point cloud environment for node_handle.
node_handleThe node handle of the segment key to be returned.
Returns
the segment key that corresponds to the input node handle.

◆ GetShellKey()

OOC_API HC_KEY ooc::GetShellKey ( Env  env,
NodeHandle const &  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
envThe point cloud environment for node_handle.
node_handleThe 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.

◆ GetTranslate()

OOC_API void ooc::GetTranslate ( Env  env,
double &  x,
double &  y,
double &  z 
)

Internal use only

Parameters
x
y
z

◆ IsRoot()

OOC_API bool ooc::IsRoot ( HC_KEY  ooc_root)

Reports whether or not the key ooc_root is the root of a point cloud.

Parameters
ooc_rootThe key to test
Returns
true if ooc_root is the root of a point cloud and false otherwise.

◆ PollNodesLoadingOrHaveBeenLoaded()

OOC_API bool ooc::PollNodesLoadingOrHaveBeenLoaded ( Env  env)

This function is a polling mechanism to provide users a means to determine if updates are needed for a point cloud.

Parameters
envThe 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.
See also
ooc::FileInputByKey

◆ Release()

OOC_API void ooc::Release ( Env  env)

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.

Parameters
envThe environment of the point cloud to destroy.
See also
ooc::Release
ooc::FileInputByKey