Ovis_Decoration_Type_Get()
Abstract
Returns the type of the Ovis decoration.
Syntax
Ovis_Decoration_Type_Get (dec_ptr)
| Argument | Type | Description |
|---|---|---|
dec_ptr |
OvisT_Decoration * |
Ovis decoration |
Return Type
OvisT_Decoration_Type
Decoration type
Header
ovis_decoration.h
Details
This function returns the type of the decoration. The following table lists the Ovis decoration types.
Table 20: Ovis Decoration Types
| Decoration | Type |
|---|---|
| Text | OvisC_Decoration_2D_TextOvisC_Decoration_3D_Text |
| Shapes | OvisC_Decoration_2D_LineOvisC_Decoration_2D_Segmented_LineOvisC_Decoration_3D_LineOvisC_Decoration_3D_Segmented_Line |
| Polygon shapes | OvisC_Decoration_2D_TriangleOvisC_Decoration_2D_CircleOvisC_Decoration_2D_SquareOvisC_Decoration_3D_TriangleOvisC_Decoration_3D_SphereOvisC_Decoration_3D_CubeOvisC_Decoration_3D_CylinderOvisC_Decoration_3D_Area |
| Information | OvisC_Decoration_Info_Group |
| Invalid | OvisC_Decoration_INVALID |
Example
OvisT_Decoration * dec;
/* …dec created elsewhere */
if (Ovis_Decoration_Type_Get (dec) == OvisC_Decoration_2D_Line)
{
/* Perform 2D_line specific operation */
}
Errors
Decoration is NIL.
Reference
- None