OgreHaptics::DeviceEvent Class Reference

Class containing information about a device event. More...

#include <OgreHapticsDevice.h>

Inheritance diagram for OgreHaptics::DeviceEvent:

OgreHaptics::EventArgs

List of all members.

Public Member Functions

 DeviceEvent (EventType type, Device *devic, DeviceState state, DeviceButton btn, DeviceCalibrationState calState)
 Default constructor.
virtual ~DeviceEvent ()
 Virtual destructor.

Public Attributes

Devicedevice
 Pointer to the Device from which the event was fired.
DeviceState cachedState
 Contains the state of the device at the time the event occurred in the device.
DeviceButton button
 ID of the button causing the event.
DeviceCalibrationState calibrationState
 The new calibration state of the device.
EventType eventType
 The type of event for which the event arguments are passed.


Detailed Description

Class containing information about a device event.

Definition at line 200 of file OgreHapticsDevice.h.


Constructor & Destructor Documentation

OgreHaptics::DeviceEvent::DeviceEvent ( EventType  type,
Device devic,
DeviceState  state,
DeviceButton  btn,
DeviceCalibrationState  calState 
)

Default constructor.

Definition at line 204 of file OgreHapticsDevice.h.

virtual OgreHaptics::DeviceEvent::~DeviceEvent (  )  [virtual]

Virtual destructor.

Definition at line 213 of file OgreHapticsDevice.h.


Member Data Documentation

Pointer to the Device from which the event was fired.

Definition at line 216 of file OgreHapticsDevice.h.

Contains the state of the device at the time the event occurred in the device.

This state is usefull since the time the event listener is called may be changed, thus the state of the device might be different from the actual current state.

Remarks:
The values of the state are transformed to world coordinates by the inverse of the given (if any) view to touch matrix.
See also:
Device::setWorldTouchMatrix

Definition at line 227 of file OgreHapticsDevice.h.

ID of the button causing the event.

Definition at line 229 of file OgreHapticsDevice.h.

The new calibration state of the device.

Definition at line 231 of file OgreHapticsDevice.h.

The type of event for which the event arguments are passed.

Remarks:
Does not have to be unique, do not assume.

Definition at line 54 of file OgreHapticsEvent.h.


The documentation for this class was generated from the following file:

Last modified Tue Jan 6 22:31:25 2009