sofa::core::objectmodel::MouseEvent Class Reference

MouseEvent Class. More...

#include <MouseEvent.h>

Inheritance diagram for sofa::core::objectmodel::MouseEvent:

[legend]

Collaboration diagram for sofa::core::objectmodel::MouseEvent:

[legend]

Accessors
State	m_state
	Mouse State on the event propagation.
int	m_wheelDelta
	Mouse wheel delta.
int	m_posX
int	m_posY
	Mouse coordinates.
int	getPosX (void) const
int	getPosY (void) const
int	getWheelDelta (void) const
State	getState (void) const
Public Types
enum	State {   Move = 0, LeftPressed, LeftReleased, RightPressed,   RightReleased, Wheel, Reset }
	Defines possible Mouse states. More...
Public Member Functions
	MouseEvent (State state, int wheelDelta=0)
	Wheel Mouse Event constructor.
	MouseEvent (State state, int posX, int posY)
	Default constructor.
virtual	~MouseEvent ()
	Default destructor.

---

Detailed Description

MouseEvent Class.

Implements an Event that notifies about a Mouse Interaction.

Definition at line 57 of file MouseEvent.h.

---

Member Enumeration Documentation

enum sofa::core::objectmodel::MouseEvent::State

Defines possible Mouse states.

Enumerator:

Move
LeftPressed
LeftReleased
RightPressed
RightReleased
Wheel
Reset

Definition at line 64 of file MouseEvent.h.

---

Constructor & Destructor Documentation

sofa::core::objectmodel::MouseEvent::MouseEvent	(	State	state,
		int	wheelDelta = 0
	)

Wheel Mouse Event constructor.

Definition at line 50 of file MouseEvent.cpp.

References m_posX, and m_posY.

sofa::core::objectmodel::MouseEvent::MouseEvent	(	State	state,
		int	posX,
		int	posY
	)

Default constructor.

Definition at line 61 of file MouseEvent.cpp.

sofa::core::objectmodel::MouseEvent::~MouseEvent

(

)

[virtual]

Default destructor.

Definition at line 72 of file MouseEvent.cpp.

---

Member Function Documentation

int sofa::core::objectmodel::MouseEvent::getPosX

(

void

)

const [inline]

Definition at line 94 of file MouseEvent.h.

References m_posX.

Referenced by sofa::component::controller::MechanicalStateController< DataTypes >::onMouseEvent().

int sofa::core::objectmodel::MouseEvent::getPosY

(

void

)

const [inline]

Definition at line 95 of file MouseEvent.h.

References m_posY.

Referenced by sofa::component::controller::MechanicalStateController< DataTypes >::onMouseEvent().

State sofa::core::objectmodel::MouseEvent::getState

(

void

)

const [inline]

Definition at line 97 of file MouseEvent.h.

Referenced by sofa::component::controller::MechanicalStateController< DataTypes >::onMouseEvent(), sofa::component::controller::EdgeSetController< DataTypes >::onMouseEvent(), and sofa::component::controller::ArticulatedHierarchyController::onMouseEvent().

int sofa::core::objectmodel::MouseEvent::getWheelDelta

(

void

)

const [inline]

Definition at line 96 of file MouseEvent.h.

References m_wheelDelta.

Referenced by sofa::component::controller::EdgeSetController< DataTypes >::onMouseEvent(), and sofa::component::controller::ArticulatedHierarchyController::onMouseEvent().

---

Field Documentation

int sofa::core::objectmodel::MouseEvent::m_posX [private]

Definition at line 104 of file MouseEvent.h.

Referenced by getPosX(), and MouseEvent().

int sofa::core::objectmodel::MouseEvent::m_posY [private]

Mouse coordinates.

Definition at line 104 of file MouseEvent.h.

Referenced by getPosY(), and MouseEvent().

State sofa::core::objectmodel::MouseEvent::m_state [private]

Mouse State on the event propagation.

Definition at line 97 of file MouseEvent.h.

int sofa::core::objectmodel::MouseEvent::m_wheelDelta [private]

Mouse wheel delta.

Definition at line 103 of file MouseEvent.h.

Referenced by getWheelDelta().

---

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

• framework/sofa/core/objectmodel/MouseEvent.h
• framework/sofa/core/objectmodel/MouseEvent.cpp