sofa::component::controller::Controller Class Reference

Controller Class. More...

#include <Controller.h>

Inheritance diagram for sofa::component::controller::Controller:

[legend]

Collaboration diagram for sofa::component::controller::Controller:

[legend]

Public Member Functions
	Controller ()
	Default constructor.
virtual void	onMouseEvent (core::objectmodel::MouseEvent *)
	Mouse event callback.
virtual void	onOmniEvent (core::objectmodel::OmniEvent *)
	Omni event callback.
virtual void	onKeyPressedEvent (core::objectmodel::KeypressedEvent *)
	Key Press event callback.
virtual void	onKeyReleasedEvent (core::objectmodel::KeyreleasedEvent *)
	Key Release event callback.
virtual void	onJoystickEvent (core::objectmodel::JoystickEvent *)
	Joystick event callback.
virtual void	onBeginAnimationStep (void)
	Begin Animation event callback.
virtual void	onEndAnimationStep (void)
	End Animation event callback.
Protected Attributes
Data< bool >	handleEventTriggersUpdate
	Event reception triggers object update ?
Private Member Functions
void	handleEvent (core::objectmodel::Event *)
	Handle an event.

---

Detailed Description

Controller Class.

Interface of user interaction on SOFA Components. Provides also an interface for BeginAnimation and EndAnimation events launched at the beginning and the end of a time step.

Definition at line 75 of file Controller.h.

---

Constructor & Destructor Documentation

sofa::component::controller::Controller::Controller

(

)

Default constructor.

Definition at line 62 of file Controller.cpp.

---

Member Function Documentation

void sofa::component::controller::Controller::handleEvent

(

core::objectmodel::Event *

e

)

[private, virtual]

Handle an event.

Reimplemented from sofa::core::objectmodel::BaseObject.

Definition at line 70 of file Controller.cpp.

References onBeginAnimationStep(), onEndAnimationStep(), onJoystickEvent(), onKeyPressedEvent(), onKeyReleasedEvent(), onMouseEvent(), and onOmniEvent().

virtual void sofa::component::controller::Controller::onBeginAnimationStep

(

void

)

[inline, virtual]

Begin Animation event callback.

Reimplemented in sofa::component::controller::ArticulatedHierarchyController, sofa::component::controller::EdgeSetController< DataTypes >, and sofa::component::controller::MechanicalStateController< DataTypes >.

Definition at line 112 of file Controller.h.

Referenced by handleEvent().

virtual void sofa::component::controller::Controller::onEndAnimationStep

(

void

)

[inline, virtual]

End Animation event callback.

Definition at line 117 of file Controller.h.

Referenced by handleEvent().

virtual void sofa::component::controller::Controller::onJoystickEvent

(

core::objectmodel::JoystickEvent *

)

[inline, virtual]

Joystick event callback.

Definition at line 107 of file Controller.h.

Referenced by handleEvent().

virtual void sofa::component::controller::Controller::onKeyPressedEvent

(

core::objectmodel::KeypressedEvent *

)

[inline, virtual]

Key Press event callback.

Reimplemented in sofa::component::controller::ArticulatedHierarchyController, and sofa::component::controller::EdgeSetController< DataTypes >.

Definition at line 97 of file Controller.h.

Referenced by handleEvent().

virtual void sofa::component::controller::Controller::onKeyReleasedEvent

(

core::objectmodel::KeyreleasedEvent *

)

[inline, virtual]

Key Release event callback.

Definition at line 102 of file Controller.h.

Referenced by handleEvent().

virtual void sofa::component::controller::Controller::onMouseEvent

(

core::objectmodel::MouseEvent *

)

[inline, virtual]

Mouse event callback.

Reimplemented in sofa::component::controller::ArticulatedHierarchyController, sofa::component::controller::EdgeSetController< DataTypes >, and sofa::component::controller::MechanicalStateController< DataTypes >.

Definition at line 87 of file Controller.h.

Referenced by handleEvent().

virtual void sofa::component::controller::Controller::onOmniEvent

(

core::objectmodel::OmniEvent *

)

[inline, virtual]

Omni event callback.

Reimplemented in sofa::component::controller::MechanicalStateController< DataTypes >.

Definition at line 92 of file Controller.h.

Referenced by handleEvent().

---

Field Documentation

Data< bool > sofa::component::controller::Controller::handleEventTriggersUpdate [protected]

Event reception triggers object update ?

Definition at line 117 of file Controller.h.

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

---

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

• modules/sofa/component/controller/Controller.h
• modules/sofa/component/controller/Controller.cpp