Ovis_Entity_Aggregate_Dimension_Get()
Abstract
Obtains the dimension of an aggregate's 3D volume in 3D Network Visualizer.
Syntax
Ovis_Entity_Aggregate_Dimension_Get (ent_ptr, x_ptr, y_ptr, z_ptr)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Entity |
x_ptr |
double * |
X dimension |
y_ptr |
double * |
Y dimension |
z ptr |
double * |
Z dimension |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the dimensions could be retrieved; OvisC_Compcode_Failure otherwise.
Header
ovis_entity.h
Details
This function retrieves the dimension of the 3D volume used to represent the aggregate in 3D Network Visualizer.
Example
OvisT_Entity * agg_ptr;
double x, y, z;
/* Entity was created as an aggregate at some point */
Ovis_Entity_Aggregate_Dimension_Get (agg_ptr, &x, &y, &z);
Errors
- Entity is NIL.
Reference
- Use the function Ovis_Entity_Aggregate_Dimension_Set() to specify the 3D volume of the aggregate in 3D Network Visualizer.