Ovis_2D_Polygon_Scale_Set()
Abstract
Specifies the scale of the 2D polygon.
Syntax
Ovis_2D_Polygon_Scale_Set (poly_ptr, x_scale, y_scale)
| Argument | Type | Description |
|---|---|---|
poly_ptr |
OvisT_Polygon * |
Polygon |
x_scale |
double |
Specifies the X scale (>= 0) |
y_scale |
double |
Specifies the Y scale (>= 0) |
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 specifies the x and y scale of the 2D polygon. The 2D polygon can be a square or circle.
The x_scale and y_scale factors are defined in terms of the window width and height. A value of 1.0 means that the circle or square's width or height is going to be equal to the window width or height. Note that a "square" with equal x_scale and y_scale factors will look like a square on the screen only if the 3D rendering window is an actual square. Similarly for a circle.
Note that the pattern is not affected by the scaling. The pattern is always applied over 32 bits vertically after the scaling has been applied.
Example
OvisT_2D_Circle * circle;
/* … circle created previously */
Ovis_2D_Polygon_Scale_Set (circle, 2.0, 5.5);
Errors
- Decoration is not a 2D circle or square.
- Decoration is NIL.
- Invalid X-scale value (
<value>). Scale value must be positive. - Invalid Y-scale value (
<value>). Scale value must be positive.
Reference
- Use the function
Ovis_2D_Polygon_Scale_Get()to obtain the radius for circles or squares.