Ovis_3D_Decoration_Offset_Get()
Abstract
Returns the offset data of the object in the 3D view.
Syntax
Ovis_3D_Decoration_Offset_Get (dec_ptr, x_m_ptr, y_m_ptr, z_m_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_3D_Decoration * |
Offset |
x_m_ptr |
double * |
Offset of X (in meters) from the starting point |
y_m_ptr |
double * |
Offset of Y (in meters) from the starting point |
z_m_ptr |
double * |
Offset of Z (in meters) from the starting point |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid offset. All 3D decorations have an offset (0, 0, 0) by default. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns, in meters, the offsets of the X, Y, and Z coordinates of the 3D decoration.
Example
OvisT_3D_Cylinder * sphere;
Double x, y, z;
/* … sphere created at some point */
Ovis_3D_Decoration_Offset_Get (sphere, &x, &y, &z);
Errors
- Decoration is NIL.
- Decoration type does not support 3D offset.
- Return address for 'x' offset value is NIL.
- Return address for 'y' offset value is NIL.
- Return address for 'z' offset value is NIL.
Reference
- Use the function
Ovis_3D_Decoration_Offset_Set()to set the offset of the decoration.