Ovis_Decoration_2D_Square_Create()
Abstract
Creates a 2D square.
Syntax
Ovis_Decoration_2D_Square_Create (center, x_scale, y_scale, color, filled, layer_ptr, destroy_proc, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
center |
OvisT_2D_Position |
Center of the square |
x_scale |
double |
X scale of the square, typically between 0.0 and 1.0 |
y_scale |
double |
Y scale of the square, typically between 0.0 and 1.0 |
color |
PrgT_Color |
Color |
filled |
OvisT_Boolean |
Indicates fill |
layer_ptr |
OvisT_Layer * |
Ovis layer |
destroy_proc |
OvisT_Decoration_State_Destroy_Proc |
Destroys the data associated with the object and deallocates its memory |
user_state_ptr |
void * |
Optional user-provided state of the decoration |
Return Type
OvisT_2D_Square *
The 2D square
Header
ovis_decoration.h
Details
This function creates an Ovis 2D square. It specifies the attributes of the square. The square has an initial transparency of 0, a solid pattern (all bits enabled if the circle is filled), and is not flashing.
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 square's width or height will 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 only if the 3D rendering window is an actual square.
Example
OvisT_2D_Position pos;
OvisT_2D_Square * square;
PrgT_Color color = prg_color_from_string ("red");
pos.x = pos.y = 0; /* middle of the screen */
square = Ovis_Decoration_2D_Square_Create (pos, 5, 5, color, OvisC_True,
OPC_NIL, OPC_NIL, OPC_NIL);
Errors
- Invalid 2D position <x,y>. 2D position values must be between –128 and 127.
- 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_Center_Set()to modify the center of the square - Use the function
Ovis_Decoration_Color_Set()to modify the color of the square. - Use the function
Ovis_Decoration_Transparency_Set()to modify the transparency of the square. - Use the function
Ovis_Decoration_Flashing_Set()to modify the flashing status. - Use the function
Ovis_Shape_Pattern_Set()to modify the pattern used in the square rendered area. - Use the function
Ovis_Polygon_Fill_Set()to modify the fill status. - Use the function
Ovis_2D_Polygon_Scale_Set()to modify the x and y dimensions for squares. - Use the function
Ovis_2D_Polygon_Rotation_Set()to modify the rotation around a Z-axis perpendicular to the monitor.