Ovis_2D_Polygon_Center_Get()
Abstract
Returns the center of a 2D polygon (circle, square, or triangle).
Syntax
Ovis_2D_Polygon_Center_Get (poly_dec_ptr, center_ptr)
| Argument | Type | Description |
|---|---|---|
poly_dec_ptr |
OvisT_2D_Polygon * |
Polygon |
center_ptr |
OvisT_2D_Position * |
Center of the polygon |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 2D polygon; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the coordinates of the center of the 2D polygon (circle, square, or triangle).
Note: Prior to release 11.5, this functionality was available as Ovis_2D_Circle_Center_Get() and Ovis_2D_Square_Center_Get(). The old names are still available, but they are just a renaming of this function.
Example
OvisT_2D_Position pos;
OvisT_2D_Circle * circle;
/* … circle created at some point */
Ovis_2D_Polygon_Center_Get (circle, &pos);
Errors
- Decoration is NIL.
- Decoration is not a 2D polygon.
- Return address for center position is NIL.
Reference
- Use the function
Ovis_2D_Polygon_Center_Set()to specify the center of a polygon.