Ovis_3D_Position_Entity_Set()
Abstract
Defines a position based on an entity.
Syntax
Ovis_3D_Position_Entity_Set (pos_ptr, entity_ptr)
| Argument | Type | Description |
|---|---|---|
pos_ptr |
OvisT_3D_Position * |
Pointer to the position |
entity_ptr |
OvisT_Entity * |
Pointer to the entity |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the position can be set. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function specifies a position as the location of a specific entity at any time. Thus, as the entity moves, the corresponding position is adjusted appropriately.
Example
OvisT_3D_Position pos;
OvisT_Entity * ent_ptr;
/* … ent_ptr created at some point */
Ovis_3D_Position_Entity_Set (&pos, ent_ptr);
Errors
- Position argument is NIL.
- Entity is NIL.
Reference
- Use the function
Ovis_Entity_Position_Get()to set a 3D position to the current position of an entity, but without having the position value updated when the entity moves.