makVrv::DtMouseState Class Reference

This class encapsulates the state associated with a mouse button event.

Public Types
enum	MouseButton { NoButton = 0x0, LeftButton = 0x1, MiddleButton = 0x2, RightButton = 0x4 }
enum	MouseModifier { NoModifier = 0x0, AltModifier = 0x1, CtrlModifier = 0x2, ShiftModifier = 0x4 }

Public Member Functions
	DtMouseState ()
	DtMouseState (int x, int y, double nx, double ny, int wheel, MouseButton buttonState, MouseModifier modState)
virtual	~DtMouseState ()
	DtMouseState (const DtMouseState &)
DtMouseState &	operator= (const DtMouseState &)
virtual int	x () const
virtual void	setX (int x)
virtual int	y () const
virtual void	setY (int y)
virtual double	normalizedX () const
virtual void	setNormalizedX (double nx)
virtual double	normalizedY () const
virtual void	setNormalizedY (double ny)
virtual int	wheel () const
virtual void	setWheel (int wheel)
virtual bool	leftDown () const
virtual void	setLeftDown (bool leftDown)
virtual bool	middleDown () const
virtual void	setMiddleDown (bool middleDown)
virtual bool	rightDown () const
virtual void	setRightDown (bool rightDown)
virtual MouseButton	buttonState () const
virtual void	setButtonState (MouseButton buttonState)
virtual bool	altDown () const
virtual void	setAltDown (bool altDown)
virtual bool	ctrlDown () const
virtual void	setCtrlDown (bool ctrlDown)
virtual bool	shiftDown () const
virtual void	setShiftDown (bool shiftDown)
virtual MouseModifier	modifiers () const
virtual void	setModifiers (MouseModifier modifiers)

Protected Attributes
unsigned int	myX
unsigned int	myY
double	myNormalizedX
double	myNormalizedY
int	myWheel
MouseButton	myButtonState
MouseModifier	myModifiers

Member Enumeration Documentation

enum makVrv::DtMouseState::MouseButton

Describe which mouse button(s) are pressed or released.

Enumerator
NoButton
LeftButton
MiddleButton
RightButton

enum makVrv::DtMouseState::MouseModifier

Describe which modifier(s) are pressed.

Enumerator
NoModifier
AltModifier
CtrlModifier
ShiftModifier

Constructor & Destructor Documentation

makVrv::DtMouseState::DtMouseState

(

)

Default constructor.

makVrv::DtMouseState::DtMouseState	(	int	x,
		int	y,
		double	nx,
		double	ny,
		int	wheel,
		MouseButton	buttonState,
		MouseModifier	modState
	)

Construct a mouse event.

virtual makVrv::DtMouseState::~DtMouseState ( )

virtual

Destructor.

makVrv::DtMouseState::DtMouseState

(

const DtMouseState &

)

Copy constructor.

Member Function Documentation

DtMouseState& makVrv::DtMouseState::operator=

(

const DtMouseState &

)

Assignment operator.

virtual int makVrv::DtMouseState::x ( ) const

virtual

Return the X-axis coorindate of the mouse.

virtual void makVrv::DtMouseState::setX ( int  x )

virtual

Set the X-axis value.

virtual int makVrv::DtMouseState::y ( ) const

virtual

Return the Y-axis coorindate of the mouse.

virtual void makVrv::DtMouseState::setY ( int  y )

virtual

Set the Y-axis value.

virtual double makVrv::DtMouseState::normalizedX ( ) const

virtual

Get the X value normalized ( -1 .. 1)

virtual void makVrv::DtMouseState::setNormalizedX ( double  nx )

virtual

Set the normalized X value.

virtual double makVrv::DtMouseState::normalizedY ( ) const

virtual

Get the Y value normalized ( -1 .. 1)

virtual void makVrv::DtMouseState::setNormalizedY ( double  ny )

virtual

Set the normalized Y value.

virtual int makVrv::DtMouseState::wheel ( ) const

virtual

Returns the wheel value of the mouse.

virtual void makVrv::DtMouseState::setWheel ( int  wheel )

virtual

Set the wheel value.

virtual bool makVrv::DtMouseState::leftDown ( ) const

virtual

Return state of the left button.

virtual void makVrv::DtMouseState::setLeftDown ( bool  leftDown )

virtual

Set the state of the left mouse button.

virtual bool makVrv::DtMouseState::middleDown ( ) const

virtual

Return state of the middle button.

virtual void makVrv::DtMouseState::setMiddleDown ( bool  middleDown )

virtual

Set the state of the middle mouse button.

virtual bool makVrv::DtMouseState::rightDown ( ) const

virtual

Return state of the right button.

virtual void makVrv::DtMouseState::setRightDown ( bool  rightDown )

virtual

Set the state of the right mouse button.

virtual MouseButton makVrv::DtMouseState::buttonState ( ) const

virtual

get the entire state vector instead of using the boolean accessors

virtual void makVrv::DtMouseState::setButtonState ( MouseButton  buttonState )

virtual

set the entire state vector instead of using the boolean mutators

virtual bool makVrv::DtMouseState::altDown ( ) const

virtual

Return if the alt modifier key was pressed with the mouse event.

virtual void makVrv::DtMouseState::setAltDown ( bool  altDown )

virtual

Set the alt (modifier) variable.

virtual bool makVrv::DtMouseState::ctrlDown ( ) const

virtual

Return if the ctrl modifier key was pressed with the mouse event.

virtual void makVrv::DtMouseState::setCtrlDown ( bool  ctrlDown )

virtual

Set the ctrl (modifier) variable.

virtual bool makVrv::DtMouseState::shiftDown ( ) const

virtual

Return if the shift modifier key was pressed with the mouse event.

virtual void makVrv::DtMouseState::setShiftDown ( bool  shiftDown )

virtual

Set the shift (modifier) variable.

virtual MouseModifier makVrv::DtMouseState::modifiers ( ) const

virtual

Get the entire modifier vector instead of using the boolean accessors.

virtual void makVrv::DtMouseState::setModifiers ( MouseModifier  modifiers )

virtual

Set the entire modifier vector instead of using the boolean mutators.

Member Data Documentation

unsigned int makVrv::DtMouseState::myX

protected

unsigned int makVrv::DtMouseState::myY

protected

double makVrv::DtMouseState::myNormalizedX

protected

double makVrv::DtMouseState::myNormalizedY

protected

int makVrv::DtMouseState::myWheel

protected

MouseButton makVrv::DtMouseState::myButtonState

protected

MouseModifier makVrv::DtMouseState::myModifiers

protected

---

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

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