Ovis_Entity_Animation_Get()
Abstract
Retrieves the Ovis entity animation information.
Syntax
Ovis_Entity_Animation_Get (ent_ptr, buf_size_ptr, name_buffer, animated_ptr, agg_ptr, type_ptr, force_ptr, dead_reckoning_ptr)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Entity |
buf_size_ptr |
size_t * |
Size of the buffer |
name_buffer |
char * |
Buffer for name |
animated_ptr |
OvisT_Boolean |
Indicates entity is animated |
agg_ptr |
OvisT_Aggregation_Mode * |
Aggregation mode |
type_ptr |
OvisT_DIS_Type * |
Entity type |
force_ptr |
OvisT_DIS_Force * |
DIS force |
dead_reckoning_ptr |
OvisT_DIS_Dead_Reckoning * |
DIS dead reckoning |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the entity is valid; otherwise, OvisC_Compcode_Failure.
Header
ovis_entity.h
Details
This function retrieves the Ovis entity animation information. If * buf_siz_ptr is not big enough to store the name in name_buffer, the function returns failure and * buf_size_ptr is set to the minimum size needed to store the name.
Any of the return arguments can be set to OVISC_NIL, in which case the corresponding value is not returned.
Example
OvisT_Entity * ent_ptr;
char name [100];
size_t size = 100;
OvisT_DIS_Type type;
/* Entity was created at some point */
Ovis_Entity_Animation_Get (ent_ptr, &size, name, OVISC_NIL, &type, OVISC_NIL, OVISC_NIL);
Errors
- Entity is NIL.
Reference
- Use the function Ovis_Entity_Animation_Set() to specify how the entity is supposed to appear in 3D Network Visualizer.