Ovis_3D_Cylinder_Endpoints_Get()
Abstract
Returns the cylinder endpoints in a 3D view.
Syntax
Ovis_3D_Cylinder_Endpoints_Get (cylinder_dec_ptr, from_ptr, to_ptr)
| Argument | Type | Description |
|---|---|---|
cylinder_dec_ptr |
OvisT_3D_Cylinder * |
Cylinder |
from_ptr |
OvisT_3D_Position * |
Start of the cylinder |
to_ptr |
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 returns the cylinder endpoints—the “from” and “to” endpoints—of the 3D cylinder.
Example
OvisT_3D_Position from, to;
OvisT_3D_Cylinder * cyl;
/* … cyl created a some point */
Ovis_3D_Cylinder_Endpoints_Get (cyl, &from, &to);
Errors
- Decoration is NIL.
- Decoration is not a 3D cylinder.
- Return address for 'from' position is NIL.
- Return address for 'to' position is NIL.
Reference
- Use the function
Ovis_3D_Cylinder_Endpoints_Set()to specify the endpoints of the cylinder.