Ovis_Decoration_Info_Group_Create()
Abstract
Creates the instance of the Ovis group.
Syntax
Ovis_Decoration_Info_Group_Create (tmpl_ptr, position, color, layer_ptr, destroy_proc, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
tmpl_ptr |
OvisT_Info_Template * |
Ovis template |
position |
OvisT_3D_Position |
Position |
color |
PrgT_Color |
Color |
layer_ptr |
OvisT_Layer * |
Ovis layer |
destroy_proc |
OvisT_Decoration_State_Destroy_Proc |
Destroys the data associated with the decoration and deallocates its memory |
user_state_ptr |
void * |
Optional user-provided state of the decoration |
Return Type
OvisT_Info_Group *
Ovis group
Header
ovis_decoration.h
Details
This function creates the instance of the Ovis group. It specifies the attributes of the group, attributes such as the particular template used to create the group, and the position, color, and layer of the group. For information about the Ovis template, see Ovis_Decoration_Info_Template_Create().
Example
#define INCOMING_PACKET_FIELD "Incoming"
OvisT_Info_Template * template;
OvisT_Info_Group * info;
OvisT_3D_Position pos;
template = Ovis_Decoration_Info_Template_Create ("Packet count");
Ovis_Decoration_Info_Template_Scalar_Element_Add (template, INCOMING_PACKET_FIELD);
Ovis_Position_Geodetic_Set (&pos, 0, 0, 100);
info = Ovis_Decoration_Info_Group_Create (template, pos,
prg_color_from_string ("blue"), OPC_NIL, OPC_NIL, OPC_NIL);
Ovis_Decoration_Info_Group_Scalar_Element_Value_Set (info, INCOMING_PACKET_FIELD,
10);
Errors
- Template is NIL.
Reference
- Use the functions
Ovis_Decoration_Info_Group_Scalar_Element_Value_Set()andOvis_Decoration_Info_Group_Vector_Element_Value_Set()to update the data in the info group.