Ovis_Decoration_Type_To_String()
Abstract
Returns a text version of an Ovis decoration type.
Syntax
Ovis_Decoration_Type_To_String (dec_type)
| Argument | Type | Description |
|---|---|---|
dec_type |
OvisT_Decoration_Type |
Decoration type |
Return Type
const char *
Decoration type string
Header
ovis_base.h
Details
This function returns a string describing the decoration type. The following table lists the Ovis decoration types and resulting strings.
Table 17: Ovis Decoration Type Strings
| Decoration | Type | String |
|---|---|---|
| Text | OvisC_Decoration_2D_TextOvisC_Decoration_3D_Text |
"2D Text""3D Text" |
| Shapes | OvisC_Decoration_2D_LineOvisC_Decoration_2D_Segmented_LineOvisC_Decoration_3D_LineOvisC_Decoration_3D_Segmented_Line |
"2D Line""2D Segmented Line""3D Line""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 |
"2D Triangle""2D Circle""2D Square""3D Triangle""3D Sphere""3D Cube""3D Cylinder""3D Area" |
| Information | OvisC_Decoration_Info_Group |
"Info Group" |
| Invalid | OvisC_Decoration_INVALID |
"<Invalid>" |
Example
OvisT_Decoration_Type * dec_type;
char buf [128];
/* …decoration created elsewhere */
sprintf (buf, “Decoration type is %s.“, Ovis_Decoration_Type_To_String (dec_type));
Errors
None.
Reference
- None