 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
This class encapsulates a mouse button event. More...
Public Types | |
| enum | EventType { NoEvent = 0, LeftButtonPress, LeftButtonRelease, LeftButtonDoubleClick, MiddleButtonPress, MiddleButtonRelease, MiddleButtonDoubleClick, RightButtonPress, RightButtonRelease, RightButtonDoubleClick, MouseMove, WheelScroll, MouseLost } |
| Describe the types of mouse events supported. More... | |
Public Member Functions | |
| DtMouseEvent () | |
| Default constructor. | |
| DtMouseEvent (EventType eventType) | |
| Construct a mouse event. | |
| DtMouseEvent (EventType eventType, const DtMouseState &mouseState) | |
| Construct a mouse event. | |
| virtual | ~DtMouseEvent () |
| Destructor. | |
| DtMouseEvent (const DtMouseEvent &) | |
| Copy constructor. | |
| DtMouseEvent & | operator= (const DtMouseEvent &) |
| Assignment operator. | |
| virtual int | x () const |
| Return the X-axis coorindate of the mouse event. | |
| virtual int | y () const |
| Return the Y-axis coorindate of the mouse event. | |
| virtual DtMouseState::MouseButton | button () const |
| Return which mouse button was pressed / released. | |
| virtual DtMouseState::MouseModifier | mod () const |
| Return which modifier keys were pressed with the mouse event. | |
| virtual void | setX (int x) |
| Set the X-axis value. | |
| virtual void | setY (int y) |
| Set the Y-axis value. | |
| virtual DtMouseState | mouseState () const |
| Get the mouse state. | |
| virtual DtMouseState & | mouseState () |
| Get the mouse state. | |
| virtual void | setMouseState (const DtMouseState &mouseState) |
| Set the mouse state. | |
| virtual EventType | eventType () const |
| Get the type of mouse event that occurred. | |
| virtual void | setEventType (EventType eventType) |
| Set the type of mouse event that occurred. | |
Protected Attributes | |
| EventType | myEventType |
| DtMouseState | myMouseState |
This class encapsulates a mouse button event.
Default constructor.
| makVrv::DtMouseEvent::DtMouseEvent | ( | EventType | eventType | ) |
Construct a mouse event.
| makVrv::DtMouseEvent::DtMouseEvent | ( | EventType | eventType, |
| const DtMouseState & | mouseState | ||
| ) |
Construct a mouse event.
| virtual makVrv::DtMouseEvent::~DtMouseEvent | ( | ) | [virtual] |
Destructor.
| makVrv::DtMouseEvent::DtMouseEvent | ( | const DtMouseEvent & | ) |
Copy constructor.
| DtMouseEvent& makVrv::DtMouseEvent::operator= | ( | const DtMouseEvent & | ) |
Assignment operator.
| virtual int makVrv::DtMouseEvent::x | ( | ) | const [virtual] |
Return the X-axis coorindate of the mouse event.
| virtual int makVrv::DtMouseEvent::y | ( | ) | const [virtual] |
Return the Y-axis coorindate of the mouse event.
| virtual DtMouseState::MouseButton makVrv::DtMouseEvent::button | ( | ) | const [virtual] |
Return which mouse button was pressed / released.
| virtual DtMouseState::MouseModifier makVrv::DtMouseEvent::mod | ( | ) | const [virtual] |
Return which modifier keys were pressed with the mouse event.
| virtual void makVrv::DtMouseEvent::setX | ( | int | x | ) | [virtual] |
Set the X-axis value.
| virtual void makVrv::DtMouseEvent::setY | ( | int | y | ) | [virtual] |
Set the Y-axis value.
| virtual DtMouseState makVrv::DtMouseEvent::mouseState | ( | ) | const [virtual] |
Get the mouse state.
| virtual DtMouseState& makVrv::DtMouseEvent::mouseState | ( | ) | [virtual] |
Get the mouse state.
| virtual void makVrv::DtMouseEvent::setMouseState | ( | const DtMouseState & | mouseState | ) | [virtual] |
Set the mouse state.
| virtual EventType makVrv::DtMouseEvent::eventType | ( | ) | const [virtual] |
Get the type of mouse event that occurred.
| virtual void makVrv::DtMouseEvent::setEventType | ( | EventType | eventType | ) | [virtual] |
Set the type of mouse event that occurred.
EventType makVrv::DtMouseEvent::myEventType [protected] |
DtMouseState makVrv::DtMouseEvent::myMouseState [protected] |