Wraps around an OIS::Mouse and forwards the input events to a list of input states. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/libraries/core/input/Mouse.h>

Inheritance diagram for orxonox::Mouse:

Public Member Functions
	Mouse (unsigned int id, OIS::InputManager *oisInputManager)
	Only sets the clipping size. Initialising is done in the base class. More...

	~Mouse ()

void	grab ()

void	ungrab ()

Public Member Functions inherited from orxonox::InputDeviceTemplated< MouseTraits >
	InputDeviceTemplated (unsigned int id, OIS::InputManager *oisInputManager)
	Creates the OIS device. More...

virtual	~InputDeviceTemplated ()
	Destroys the OIS device. More...

virtual void	clearBuffers () override
	Clears the list of pressed buttons and calls the derived class's method. More...

virtual std::string	getClassName () const override
	Returns the device class (derived) name as string. More...

OISDeviceClass *	getOISDevice ()

virtual void	update (const Clock &time) override
	Captures OIS events (which then get distributed to the derived class) and creates the button held events. More...

Public Member Functions inherited from orxonox::InputDevice
	InputDevice (unsigned int id)
	Only resets the members. More...

virtual	~InputDevice ()=default

unsigned int	getDeviceID () const
	Returns the ID of the device (the same as in InputDeviceEnumerator for mouse and keyboard) More...

std::vector< InputState * > &	getStateListRef ()
	Returns a reference to the internal input state vector. Use with care! More...

bool	isCalibrating () const
	Tells whether the device is in calibration mode. More...

void	startCalibration ()
	Start calibrating (only useful for joy sticks) More...

void	stopCalibration ()
	Stop calibrating and evaluate the data (only useful for joy sticks) More...

Public Member Functions inherited from OIS::MouseListener
virtual	~MouseListener ()

Public Member Functions inherited from orxonox::Listable
	Listable ()
	Constructor: Allocates space in the element list. More...

	Listable (Context *context)
	Constructor: Allocates space in the element list and assigns the context. More...

virtual	~Listable ()
	Destructor: Removes the object from the object-lists. More...

Context *	getContext () const

void	setContext (Context *context)
	Changes the context. More...

void	unregisterObject ()
	Removes this object from the object-lists. More...

Public Member Functions inherited from orxonox::Identifiable
	Identifiable ()
	Constructor: Sets the default values. More...

virtual	~Identifiable ()

ORX_FORCEINLINE void *	getDerivedPointer (unsigned int classID)
	Returns a valid pointer of any derived type that is registered in the class hierarchy. More...

template<class T >
ORX_FORCEINLINE T *	getDerivedPointer (unsigned int classID)
	Version of getDerivedPointer with template. More...

template<class T >
ORX_FORCEINLINE const T *	getDerivedPointer (unsigned int classID) const
	Const version of getDerivedPointer with template. More...

Identifier *	getIdentifier () const
	Returns the Identifier of the object. More...

bool	isA (const Identifier *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

template<class B >
bool	isA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isA (const Identifiable *object)
	Returns true if the object's class is of the given type or a derivative. More...

bool	isChildOf (const Identifier *identifier)
	Returns true if the object's class is a child of the given type. More...

template<class B >
bool	isChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a child of the given type. More...

bool	isChildOf (const Identifiable *object)
	Returns true if the object's class is a child of the given type. More...

bool	isDirectChildOf (const Identifier *identifier)
	Returns true if the object's class is a direct child of the given type. More...

template<class B >
bool	isDirectChildOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectChildOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isDirectParentOf (const Identifier *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

template<class B >
bool	isDirectParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a direct parent of the given type. More...

bool	isDirectParentOf (const Identifiable *object)
	Returns true if the object's class is a direct child of the given type. More...

bool	isExactlyA (const Identifier *identifier)
	Returns true if the object's class is exactly of the given type. More...

template<class B >
bool	isExactlyA (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is exactly of the given type. More...

bool	isExactlyA (const Identifiable *object)
	Returns true if the object's class is exactly of the given type. More...

bool	isParentOf (const Identifier *identifier)
	Returns true if the object's class is a parent of the given type. More...

template<class B >
bool	isParentOf (const SubclassIdentifier< B > *identifier)
	Returns true if the object's class is a parent of the given type. More...

bool	isParentOf (const Identifiable *object)
	Returns true if the object's class is a parent of the given type. More...

Private Types
typedef InputDeviceTemplated< MouseTraits >	super
	Super class alias. More...

Private Member Functions
virtual bool	mouseMoved (const OIS::MouseEvent &arg) override
	OIS event handler. More...

virtual bool	mousePressed (const OIS::MouseEvent &arg, OIS::MouseButtonID id) override
	OIS event handler. More...

virtual bool	mouseReleased (const OIS::MouseEvent &arg, OIS::MouseButtonID id) override
	OIS event handler. More...

virtual void	windowResized (unsigned int newWidth, unsigned int newHeight) override
	Window has resized. More...

Static Private Member Functions
static std::string	getClassNameImpl ()

Friends
class	InputDeviceTemplated< MouseTraits >

Additional Inherited Members
Protected Member Functions inherited from orxonox::InputDeviceTemplated< MouseTraits >
ORX_FORCEINLINE void	buttonPressed (ButtonTypeParam button)
	Common code for all button pressed events (updates pressed buttons list and calls the input states) More...

ORX_FORCEINLINE void	buttonReleased (ButtonTypeParam button)
	Common code for all button released events (updates pressed buttons list and calls the input states) More...

Protected Member Functions inherited from orxonox::InputDevice
virtual void	calibrationStarted ()
	To be ovrridden by the subclass. More...

virtual void	calibrationStopped ()
	To be ovrridden by the subclass. More...

Protected Member Functions inherited from orxonox::WindowEventListener
	WindowEventListener ()

virtual	~WindowEventListener ()=default

unsigned int	getWindowHeight () const
	Returns the current render window height. More...

unsigned int	getWindowWidth () const
	Returns the current render window width. More...

Protected Attributes inherited from orxonox::InputDeviceTemplated< MouseTraits >
OISDeviceClass *	oisDevice_
	Managed pointer to the OIS device. More...

Protected Attributes inherited from orxonox::InputDevice
std::vector< InputState * >	inputStates_
	List of all input states that receive events from this device. More...

Detailed Description

Wraps around an OIS::Mouse and forwards the input events to a list of input states.

Member Typedef Documentation

typedef InputDeviceTemplated<MouseTraits> orxonox::Mouse::super

private

Super class alias.

Constructor & Destructor Documentation

orxonox::Mouse::Mouse	(	unsigned int	id,
		OIS::InputManager *	oisInputManager
	)

Only sets the clipping size. Initialising is done in the base class.

orxonox::Mouse::~Mouse ( )

Member Function Documentation

static std::string orxonox::Mouse::getClassNameImpl ( )

inlinestaticprivate

void orxonox::Mouse::grab ( )

bool orxonox::Mouse::mouseMoved ( const OIS::MouseEvent & arg )

overrideprivatevirtual

OIS event handler.

Implements OIS::MouseListener.

virtual bool orxonox::Mouse::mousePressed	(	const OIS::MouseEvent &	arg,
		OIS::MouseButtonID	id
	)

inlineoverrideprivatevirtual

OIS event handler.

Implements OIS::MouseListener.

virtual bool orxonox::Mouse::mouseReleased	(	const OIS::MouseEvent &	arg,
		OIS::MouseButtonID	id
	)

inlineoverrideprivatevirtual

OIS event handler.

Implements OIS::MouseListener.

void orxonox::Mouse::ungrab ( )

void orxonox::Mouse::windowResized	(	unsigned int	newWidth,
		unsigned int	newHeight
	)

overrideprivatevirtual

Window has resized.

Reimplemented from orxonox::WindowEventListener.

Friends And Related Function Documentation

friend class InputDeviceTemplated< MouseTraits >

friend

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

libraries/core/input/Mouse.h
libraries/core/input/Mouse.cc

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation