makVrv::DtMouseEvent Class Reference

This class encapsulates a mouse button event.

Public Types
enum	EventType {   NoEvent = 0, LeftButtonPress, LeftButtonRelease, LeftButtonDoubleClick,   MiddleButtonPress, MiddleButtonRelease, MiddleButtonDoubleClick, RightButtonPress,   RightButtonRelease, RightButtonDoubleClick, MouseMove, WheelScroll,   MouseLost }

Public Member Functions
	DtMouseEvent ()
	DtMouseEvent (EventType eventType)
	DtMouseEvent (EventType eventType, const DtMouseState &mouseState)
virtual	~DtMouseEvent ()
	DtMouseEvent (const DtMouseEvent &)
DtMouseEvent &	operator= (const DtMouseEvent &)
virtual int	x () const
virtual int	y () const
virtual DtMouseState::MouseButton	button () const
virtual DtMouseState::MouseModifier	mod () const
virtual void	setX (int x)
virtual void	setY (int y)
virtual DtMouseState	mouseState () const
virtual DtMouseState &	mouseState ()
virtual void	setMouseState (const DtMouseState &mouseState)
virtual EventType	eventType () const
virtual void	setEventType (EventType eventType)

Protected Attributes
EventType	myEventType
DtMouseState	myMouseState

Member Enumeration Documentation

enum makVrv::DtMouseEvent::EventType

Describe the types of mouse events supported.

Enumerator
NoEvent
LeftButtonPress
LeftButtonRelease
LeftButtonDoubleClick
MiddleButtonPress
MiddleButtonRelease
MiddleButtonDoubleClick
RightButtonPress
RightButtonRelease
RightButtonDoubleClick
MouseMove
WheelScroll
MouseLost

Constructor & Destructor Documentation

makVrv::DtMouseEvent::DtMouseEvent

(

)

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.

Member Function Documentation

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.

Member Data Documentation

EventType makVrv::DtMouseEvent::myEventType

protected

DtMouseState makVrv::DtMouseEvent::myMouseState

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtMouseEvent.h