OrxEvent

Data Structures
struct	orxEVENT
Defines
#define	orxEVENT_INIT(EVENT, TYPE, ID, SENDER, RECIPIENT, PAYLOAD)
#define	orxEVENT_SEND(TYPE, ID, SENDER, RECIPIENT, PAYLOAD)
Typedefs
typedef orxSTATUS(orxFASTCALL *	orxEVENT_HANDLER )(const orxEVENT *_pstEvent)
Enumerations
enum	orxEVENT_TYPE {   orxEVENT_TYPE_ANIM = 0, orxEVENT_TYPE_CLOCK, orxEVENT_TYPE_CONFIG, orxEVENT_TYPE_DISPLAY,   orxEVENT_TYPE_FX, orxEVENT_TYPE_INPUT, orxEVENT_TYPE_LOCALE, orxEVENT_TYPE_OBJECT,   orxEVENT_TYPE_RENDER, orxEVENT_TYPE_PHYSICS, orxEVENT_TYPE_SHADER, orxEVENT_TYPE_SOUND,   orxEVENT_TYPE_SPAWNER, orxEVENT_TYPE_SYSTEM, orxEVENT_TYPE_TEXTURE, orxEVENT_TYPE_CORE_NUMBER,   orxEVENT_TYPE_FIRST_RESERVED = orxEVENT_TYPE_CORE_NUMBER, orxEVENT_TYPE_LAST_RESERVED = 127, orxEVENT_TYPE_USER_DEFINED, orxEVENT_TYPE_NONE = orxENUM_NONE }
Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxEvent_AddHandler (orxEVENT_TYPE _eEventType, orxEVENT_HANDLER _pfnEventHandler)
orxDLLAPI void orxFASTCALL	orxEvent_Exit ()
orxDLLAPI orxSTATUS orxFASTCALL	orxEvent_Init ()
orxDLLAPI orxSTATUS orxFASTCALL	orxEvent_RemoveHandler (orxEVENT_TYPE _eEventType, orxEVENT_HANDLER _pfnEventHandler)
orxDLLAPI orxSTATUS orxFASTCALL	orxEvent_Send (const orxEVENT *_pstEvent)
orxDLLAPI orxSTATUS orxFASTCALL	orxEvent_SendShort (orxEVENT_TYPE _eEventType, orxENUM _eEventID)
orxDLLAPI void orxFASTCALL	orxEvent_Setup ()

---

Detailed Description

Event module Module that handles internal events

---

Define Documentation

#define orxEVENT_INIT	(		EVENT,
			TYPE,
			ID,
			SENDER,
			RECIPIENT,
			PAYLOAD
	)

Value:

do                                                                  \
{                                                                   \
  EVENT.eType       = (orxEVENT_TYPE)(TYPE);                        \
  EVENT.eID         = (orxENUM)(ID);                                \
  EVENT.hSender     = (orxHANDLE)(SENDER);                          \
  EVENT.hRecipient  = (orxHANDLE)(RECIPIENT);                       \
  EVENT.pstPayload  = (void *)(PAYLOAD);                            \
} while(orxFALSE)

Helper defines

Definition at line 50 of file orxEvent.h.

#define orxEVENT_SEND	(		TYPE,
			ID,
			SENDER,
			RECIPIENT,
			PAYLOAD
	)

Value:

do                                                                  \
{                                                                   \
  orxEVENT stEvent;                                                 \
  orxEVENT_INIT(stEvent, TYPE, ID, SENDER, RECIPIENT, PAYLOAD);     \
  orxEvent_Send(&stEvent);                                          \
} while(orxFALSE)

Definition at line 60 of file orxEvent.h.

---

Typedef Documentation

typedef orxSTATUS(orxFASTCALL * orxEVENT_HANDLER)(const orxEVENT *_pstEvent)

Event handler type / return orxSTATUS_FAILURE if events processing should be stopped for the current event, orxSTATUS_FAILURE otherwise

Definition at line 117 of file orxEvent.h.

---

Enumeration Type Documentation

enum orxEVENT_TYPE

Event type enum

Enumerator:

orxEVENT_TYPE_ANIM
orxEVENT_TYPE_CLOCK
orxEVENT_TYPE_CONFIG
orxEVENT_TYPE_DISPLAY
orxEVENT_TYPE_FX
orxEVENT_TYPE_INPUT
orxEVENT_TYPE_LOCALE
orxEVENT_TYPE_OBJECT
orxEVENT_TYPE_RENDER
orxEVENT_TYPE_PHYSICS
orxEVENT_TYPE_SHADER
orxEVENT_TYPE_SOUND
orxEVENT_TYPE_SPAWNER
orxEVENT_TYPE_SYSTEM
orxEVENT_TYPE_TEXTURE
orxEVENT_TYPE_CORE_NUMBER
orxEVENT_TYPE_FIRST_RESERVED
orxEVENT_TYPE_LAST_RESERVED
orxEVENT_TYPE_USER_DEFINED
orxEVENT_TYPE_NONE

Definition at line 71 of file orxEvent.h.

---

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxEvent_AddHandler	(	orxEVENT_TYPE	_eEventType,
		orxEVENT_HANDLER	_pfnEventHandler
	)

Adds an event handler

Parameters:

[in]	_eEventType	Concerned type of event
[in]	_pfnEventHandler	Event handler to add

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxEvent_Exit

(

)

Exits from the event Module

orxDLLAPI orxSTATUS orxFASTCALL orxEvent_Init

(

)

Initializes the event Module

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxEvent_RemoveHandler	(	orxEVENT_TYPE	_eEventType,
		orxEVENT_HANDLER	_pfnEventHandler
	)

Removes an event handler

Parameters:

[in]	_eEventType	Concerned type of event
[in]	_pfnEventHandler	Event handler to remove return orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxEvent_Send

(

const orxEVENT *

_pstEvent )

Sends an event

Parameters:

[in]

_pstEvent

Event to send

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxEvent_SendShort	(	orxEVENT_TYPE	_eEventType,
		orxENUM	_eEventID
	)

Sends a simple event

Parameters:

[in]	_eEventType	Event type
[in]	_eEventID	Event ID

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxEvent_Setup

(

)

Event module setup