Ovis_Entity_Rti_Object_Get()
Abstract
Gets the RTI object associated with an Ovis entity.
Syntax
Ovis_Entity_Rti_Object_Get (obj_ptr, handle_ptr)
| Argument | Type | Description |
|---|---|---|
obj_ptr |
OvisT_Entity * |
Entity of interest |
handle_ptr |
RTI::ObjectHandle * |
Area to be filled with a pointer to the desired RTI object |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the RTI object is obtained; OvisC_Compcode_Failure otherwise.
Header
ovis_entity.h
Details
This function is defined only when an appropriate RTI development environment is available. (Riverbed does not provide such an environment.)
Errors
- Entity is NIL.
- Unable to obtain RTI object information.
Reference
- Use the function Ovis_Entity_Animation_Set() to create an RTI object associated with an entity.
- Use the function Ovis_Entity_From_Rti_Create() to associate an entity with a discovered RTI object.