Ovis_2D_Polygon_Center_Set()
Abstract
Specifies the center of a 2D polygon (circle, square, or triangle).
Syntax
Ovis_2D_Polygon_Center_Set (poly_dec_ptr, center)
| Argument | Type | Description |
|---|---|---|
poly_dec_ptr |
OvisT_2D_Polygon * |
Polygon |
center |
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 specifies the coordinates of the center of the 2D polygon.
Note: Prior to release 11.5, this functionality was available as Ovis_2D_Circle_Center_Set() and Ovis_2D_Square_Center_Set(). The old names are still available, but they are just a renaming of this function.
Example
OvisT_2D_Position pos;
OvisT_2D_Triangle * triangle;
/* … triangle created at some point */
pos.x = pos.y = 0; /* middle of the screen */
Ovis_2D_Polygon_Center_Set (triangle, pos);
Errors
- Decoration is NIL.
- Decoration is not a 2D polygon.
- Invalid 2D position <x,y>. 2D position values must be between –128 and 127.
Reference
- Use the function
Ovis_2D_Polygon_Center_Get()to obtain the center of a polygon.