The GmEvent class encapsulates all possible events that can be delivered to components in glam.

Public Methods

	GmEvent () Standard constructor
BasicEventType*	getBasicData () Gets the data associated with any event.
FocusEventType*	getFocusData () Gets the data associated with a focus event.
KeyEventType*	getKeyData () Gets the data associated with a keyboard event.
MouseEventType*	getMouseData () Gets the data associated with a mouse event.
GmTypes::EventType	getType () Gets the type of this event.
UserEventType*	getUserData () Gets the data associated with a user-defined event.
WidgetEventType*	getWidgetData () Gets the data associated with a widget event.
virtual void	setFocusEvent (GmTypes::EventType eventType, unsigned short targetId, GmTypes::FocusType focusType) Sets this event as a focus event and fills in all the necessary information about the event.
virtual void	setKeyEvent (GmTypes::EventType eventType, unsigned short targetId, unsigned char key, float x, float y) Sets this event as a keyboard event and fills in all the necessary information about the event.
virtual void	setMouseEvent (GmTypes::EventType eventType, unsigned short targetId, int button, int state, float x, float y) Sets this event as a mouse event and fills in all the necessary information about the event.
virtual	~GmEvent () Virtual destructor

Public Members

typedef struct	The BasicEventType is to store information that every event must have.
typedef struct	The FocusEventType is used for all focus events.
typedef struct	The KeyEventType is used for keyboard events.
typedef struct	The MouseEventType is used for, *gasp* mouse events.
typedef struct	The UserEventType is used for all user-defined events.
typedef struct	The WidgetEventType is used for all widget based events.

Protected Fields

void*	mPayload The payload for the event.
GmTypes::EventType	mType The type of event that this event encapsulates.

Protected Methods

virtual void

freePayload () This method frees the memory associated with the event payload.

Documentation

The GmEvent class encapsulates all possible events that can be delivered to components in glam. An event is usually created by the application and then given to the GmEventDistributor for distribution to the correct component, or set of components. The GmEvent class supports mouse, keyboard and ui events (such as focus, defocus, etc).

typedef struct The BasicEventType is to store information that every event must have.

The BasicEventType is to store information that every event must have. Every specific event must have BasicEventType as the first variable.

ObjectIDType rxId

WidgetIDType txId

typedef struct The MouseEventType is used for, *gasp* mouse events.

The MouseEventType is used for, *gasp* mouse events. It can encapsulate which component the event is to be delivered to as well as which button was pressed, the button's state (pressed/released) and its x and y position in screen coordinates.

BasicEventType basicData

int button

int state

float x

float y

typedef struct The KeyEventType is used for keyboard events.

The KeyEventType is used for keyboard events. It can encapsulate which component the event is to be delivered to as well as which key was pressed and the x and y position in screen coordinates.

BasicEventType basicData

unsigned char key

float x

float y

typedef struct The FocusEventType is used for all focus events.

The FocusEventType is used for all focus events. It can encapsulate which component the event is to be delivered to as well as whether it is a focus or a de-focus event.

BasicEventType basicData

GmTypes::FocusType focusType

typedef struct The WidgetEventType is used for all widget based events.

The WidgetEventType is used for all widget based events. Widget events are fired by widgets to be delivered to other widgets that are registered listeners. Events such as resize, visibility, selection and other non-direct user input functions are encapsulated as widget events.

BasicEventType basicData

GmTypes::WidgetMessageType messageType

float x

float y

typedef struct The UserEventType is used for all user-defined events.

The UserEventType is used for all user-defined events. It can encapsulate which component the event is to be delivered to as well as any information the developer needs to be encapsulated in the message.

BasicEventType basicData

unsigned int userEventId

GmTypes::EventType mType

The type of event that this event encapsulates. See GmTypes for a complete list of possible event types.

void* mPayload

The payload for the event. The payload changes based on the type of event. If the GmEvent object's type is any of the mouse events, then the mPayload is going to be a MouseEventType.

GmEvent()

Standard constructor

virtual ~GmEvent()

Virtual destructor

GmTypes::EventType getType()

Gets the type of this event. Based on this type, you can call a getXXXEvent(), where XXX is Mouse, Key, Focus, etc to get the data associated with the event. For a complete list of all event types see GmTypes::EventType.

Returns:

the type of event that this object encapsulates

BasicEventType* getBasicData()

Gets the data associated with any event.

Returns:

The data associated with any event

MouseEventType* getMouseData()

Gets the data associated with a mouse event.

Returns:

The data associated with a mouse event

FocusEventType* getFocusData()

Gets the data associated with a focus event.

Returns:

The data associated with a focus event

KeyEventType* getKeyData()

Gets the data associated with a keyboard event.

Returns:

The data associated with a keyboard event

WidgetEventType* getWidgetData()

Gets the data associated with a widget event.

Returns:

the data associated with a widget event

UserEventType* getUserData()

Gets the data associated with a user-defined event.

Returns:

The data associated with a user-defined event

virtual void setMouseEvent(GmTypes::EventType eventType, unsigned short targetId, int button, int state, float x, float y)

Sets this event as a mouse event and fills in all the necessary information about the event.

Parameters:

eventType - the type of keyboard event to set the object to
targetId - the widget ID to designate as the target for this event
- button the mouse button that is associated with this mouse event. This value should be one of GLUT_LEFT_BUTTON, GLUT_RIGHT_BUTTON or GLUT_MIDDLE_BUTTON
- state the state of the active button. This value should be one of GLUT_UP or GLUT_DOWN
- x the x position of the pointer in screen coordinates
- y the y position of the pointer in screen coordinates

virtual void setKeyEvent(GmTypes::EventType eventType, unsigned short targetId, unsigned char key, float x, float y)

Sets this event as a keyboard event and fills in all the necessary information about the event.

Parameters:

eventType - the type of keyboard event to set the object to
targetId - the widget ID to designate as the target for this event
- key the key that was pressed
- x the x position of the pointer in screen coordinates
- y the y position of the pointer in screen coordinates

virtual void setFocusEvent(GmTypes::EventType eventType, unsigned short targetId, GmTypes::FocusType focusType)

Sets this event as a focus event and fills in all the necessary information about the event.

Parameters:

eventType - the type of focus event to set the object to
targetId - the widget ID to designate as the target for this event
- focusType the focus type of this event

virtual void freePayload()

This method frees the memory associated with the event payload. The payload size can vary so the freePayload will detect the size of the payload and delete the appropriately sized memory block.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java