Ovis_3D_Cylinder_Endpoints_Set()
Abstract
Specifies the cylinder endpoints in a 3D view.
Syntax
Ovis_3D_Cylinder_Endpoints_Set (cylinder_dec_ptr, from, to)
| Argument | Type | Description |
|---|---|---|
cylinder_dec_ptr |
OvisT_3D_Cylinder * |
Cylinder |
from |
OvisT_3D_Position |
Start of the cylinder |
to |
OvisT_3D_Position |
End of the cylinder |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 3D cylinder. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function specifies the cylinder endpoints—the “from” and “to” endpoints—of the 3D cylinder.
Note that you cannot have both endpoints of the cylinder positioned as “relative-to-decorations”, even with two distinct decorations.
Example
OvisT_3D_Position from, to;
OvisT_3D_Cylinder * cyl;
/* … cyl created at some point */
Ovis_3D_Position_Geodetic_Set (&from, 0, 0, 100);
Ovis_3D_Position_Geodetic_Set (&to, 0, 0, 200);
Ovis_3D_Cylinder_Endpoints_Set (cyl, from, to);
Errors
- Decoration is NIL.
- Decoration is not a 3D cylinder.
Reference
- Use the function
Ovis_3D_Cylinder_Endpoints_Get()to obtain the endpoints of the cylinder.