Ovis_Entity_Parent_Set()
Abstract
Specifies the parent of an Ovis entity.
Syntax
Ovis_Entity_Parent_Set (entity_ptr, parent_ptr)
| Argument | Type | Description |
|---|---|---|
entity_ptr |
OvisT_Entity * |
Ovis entity |
parent_ptr |
OvisT_Entity * |
Ovis parent entity |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the parent can be set; OvisC_Compcode_Failure otherwise.
Header
ovis_entity.h
Details
This function accesses the entity hierarchy and specifies the parent of the Ovis entity in the hierarchy. In 3D Network Visualizer, this relationship is shown by having the child entities displayed in a subtree of the parent entity.
Example
OvisT_Entity * parent, * child;
/* …child and parent created elsewhere */
Ovis_Entity_Parent_Set (child, parent);
Errors
- Child entity is NIL.
- Parent entity must be an aggregate.
Reference
- Use the function
Ovis_Entity_Parent_Get()to get the parent entity of an entity. - Use the function
Ovis_Entity_Child_Entity_Count()to get the number of child entities of an entity. - Use the function
Ovis_Entity_Child_Entity_Nth()to get one child entity of an entity.