sofa::core::objectmodel::OmniEvent Class Reference

This event notifies about SensAble PHANTOM® device interaction. More...

#include <OmniEvent.h>

Inheritance diagram for sofa::core::objectmodel::OmniEvent:

[legend]

Collaboration diagram for sofa::core::objectmodel::OmniEvent:

[legend]

Public Types
enum	State { Button1 = 0, Button2 }
	Define the SensAble PHANTOM® state (which button is pressed). More...
Public Member Functions
	OmniEvent (State state, double posX, double posY, double posZ)
	Constructor.
	OmniEvent (State state, Vector3 position, Quat orientation)
	Constructor.
virtual	~OmniEvent ()
	Destructor.
double	getPosX (void) const
	Get the PHANTOM® X coordinate.
double	getPosY (void) const
	Get the PHANTOM® Y coordinate.
double	getPosZ (void) const
	Get the PHANTOM® Z coordinate.
State	getState (void) const
	Get the PHANTOM® state.
Vector3	getPosition (void) const
	Get the PHANTOM® coordinates.
Quat	getOrientation (void) const
	Get the PHANTOM® orientation.
Private Attributes
State	m_state
	SensAble PHANTOM® buttons state on the event propagation.
double	m_posX
double	m_posY
double	m_posZ
	SensAble PHANTOM® coordinates.
Vector3	m_position
	SensAble PHANTOM® coordinates in a Vec3d type.
Quat	m_orientation
	SensAble PHANTOM® orientation.

---

Detailed Description

This event notifies about SensAble PHANTOM® device interaction.

Definition at line 48 of file OmniEvent.h.

---

Member Enumeration Documentation

enum sofa::core::objectmodel::OmniEvent::State

Define the SensAble PHANTOM® state (which button is pressed).

Enumerator:

Button1
Button2

Definition at line 55 of file OmniEvent.h.

---

Constructor & Destructor Documentation

sofa::core::objectmodel::OmniEvent::OmniEvent	(	State	state,
		double	posX,
		double	posY,
		double	posZ
	)

Constructor.

Definition at line 39 of file OmniEvent.cpp.

sofa::core::objectmodel::OmniEvent::OmniEvent	(	State	state,
		Vector3	position,
		Quat	orientation
	)

Constructor.

Definition at line 49 of file OmniEvent.cpp.

References m_posX, m_posY, and m_posZ.

sofa::core::objectmodel::OmniEvent::~OmniEvent

(

)

[virtual]

Destructor.

Definition at line 60 of file OmniEvent.cpp.

---

Member Function Documentation

Quat sofa::core::objectmodel::OmniEvent::getOrientation

(

void

)

const [inline]

Get the PHANTOM® orientation.

Definition at line 104 of file OmniEvent.h.

References m_orientation.

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

Vector3 sofa::core::objectmodel::OmniEvent::getPosition

(

void

)

const [inline]

Get the PHANTOM® coordinates.

Definition at line 99 of file OmniEvent.h.

References m_position.

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

double sofa::core::objectmodel::OmniEvent::getPosX

(

void

)

const [inline]

Get the PHANTOM® X coordinate.

Definition at line 79 of file OmniEvent.h.

References m_posX.

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

double sofa::core::objectmodel::OmniEvent::getPosY

(

void

)

const [inline]

Get the PHANTOM® Y coordinate.

Definition at line 84 of file OmniEvent.h.

References m_posY.

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

double sofa::core::objectmodel::OmniEvent::getPosZ

(

void

)

const [inline]

Get the PHANTOM® Z coordinate.

Definition at line 89 of file OmniEvent.h.

References m_posZ.

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

State sofa::core::objectmodel::OmniEvent::getState

(

void

)

const [inline]

Get the PHANTOM® state.

Definition at line 94 of file OmniEvent.h.

References m_state.

---

Field Documentation

Quat sofa::core::objectmodel::OmniEvent::m_orientation [private]

SensAble PHANTOM® orientation.

Definition at line 111 of file OmniEvent.h.

Referenced by getOrientation().

Vector3 sofa::core::objectmodel::OmniEvent::m_position [private]

SensAble PHANTOM® coordinates in a Vec3d type.

Definition at line 110 of file OmniEvent.h.

Referenced by getPosition().

double sofa::core::objectmodel::OmniEvent::m_posX [private]

Definition at line 109 of file OmniEvent.h.

Referenced by getPosX(), and OmniEvent().

double sofa::core::objectmodel::OmniEvent::m_posY [private]

Definition at line 109 of file OmniEvent.h.

Referenced by getPosY(), and OmniEvent().

double sofa::core::objectmodel::OmniEvent::m_posZ [private]

SensAble PHANTOM® coordinates.

Definition at line 109 of file OmniEvent.h.

Referenced by getPosZ(), and OmniEvent().

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

SensAble PHANTOM® buttons state on the event propagation.

Definition at line 108 of file OmniEvent.h.

Referenced by getState().

---

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

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