Ovis_3D_Cube_Center_Get()
Abstract
Returns the 3D center of the cube.
Syntax
Ovis_3D_Cube_Center_Get (cube_dec_ptr, center_ptr)
| Argument | Type | Description |
|---|---|---|
cube_dec_ptr |
OvisT_3D_Cube * |
Cube |
center_ptr |
OvisT_3D_Position * |
Center of the cube |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 3D cube. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns coordinates of the center of the 3D cube. The 3D position matches what is currently used to position the cube (geodetic, geocentric, decoration offset, or entry).
Example
OvisT_3D_Position pos;
OvisT_3D_Cube * cube;
/* … cube created at some point */
Ovis_3D_Cube_Center_Get (cube, &pos);
Errors
- Decoration is NIL.
- Decoration is not a 3D cube.
- Return address for center position is NIL.
Reference
- Use the function
Ovis_3D_Cube_Center_Set()to specify the center of the circle.