Ovis_2D_Polygon_Rotation_Get()
Abstract
Returns the rotation of the 2D polygon.
Syntax
Ovis_2D_Polygon_Rotation_Get (poly_ptr, z_rotation_ptr)
| Argument | Type | Description |
|---|---|---|
poly_ptr |
OvisT_2D_Polygon * |
Polygon |
z_rotation_ptr |
double * |
Rotation setting in degrees |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 2D polygon (circle or square). Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns the rotation of the polygon. The 2D polygon can be a square or circle.
Example
OvisT_2D_Square * square;
double z_rotation;
/* … square created previously */
Ovis_2D_Polygon_Rotation_Get (square, &z_rotation);
Errors
- Decoration is not a 2D circle or square.
- Decoration is NIL.
- Return address for Z rotation value is NIL.
Reference
- Use the function
Ovis_2D_Polygon_Rotation_Set()to modify the rotation of circles or squares.