OvisT_Anim_Receiver_Init_Proc
Abstract
Callback: Invoked after the simulation kernel creates a receiver object.
Syntax
<anim_receiver_init_proc_name> (rx_ptr)
| Argument | Type | Description |
|---|---|---|
rx_ptr |
OvisT_Receiver * |
Pointer to the receiver object just created by the simulation kernel |
Return Type
void *
Pointer to the user state associated with the receiver object.
Header
ovis_transmission_anim.h
Details
This callback is invoked by the simulation kernel after a receiver object has been created. This happens when a new callback set is associated with a transmitter channel of an Ovis Entity by model code using Ovis_Bus_Transmitter_Animation_Enable(), Ovis_Ptpt_Link_Transmitter_Animation_Enable(), or Ovis_Wireless_Transmitter_Animation_Enable(). Each receiver channel in the receiver group of that transmitter channel will have an associated Receiver object created if one doesn't already exist for the same callback set.
This allows the creation of an appropriate user state structure to associate with the transmitter object.
The user state is returned by the function, and can be later accessed using Ovis_Receiver_State_Get(). The user state can also be replaced later on using Ovis_Receiver_State_Set().