Orxonox  0.0.5 Codename: Arcturus
Protected Member Functions | Private Member Functions | Static Private Member Functions | Static Private Attributes | Friends | List of all members
orxonox::JoyStickQuantityListener Class Referenceabstract

Derive from this class to get informed when joy sticks get added/removed. More...

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

Inheritance diagram for orxonox::JoyStickQuantityListener:
orxonox::Listable orxonox::Identifiable orxonox::InputState orxonox::KeyBinder orxonox::KeyDetector

Protected Member Functions

 JoyStickQuantityListener ()
 
virtual ~JoyStickQuantityListener ()=default
 
const std::vector< JoyStick * > & getJoyStickList () const
 Returns a list with all JoySticks currently loaded. More...
 

Private Member Functions

virtual void JoyStickQuantityChanged (const std::vector< JoyStick * > &joyStickList)=0
 Called whenever joy sticks get added/removed. More...
 

Static Private Member Functions

static void changeJoyStickQuantity (const std::vector< JoyStick * > &joyStickList)
 Calls all registered objects and sets the static variable. More...
 

Static Private Attributes

static std::vector< JoyStick * > joyStickList_s
 Static variable that holds the latest distributed information. More...
 

Friends

class InputManager
 

Additional Inherited Members

- 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...
 
ContextgetContext () 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 voidgetDerivedPointer (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...
 
IdentifiergetIdentifier () 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...
 

Detailed Description

Derive from this class to get informed when joy sticks get added/removed.

Constructor & Destructor Documentation

orxonox::JoyStickQuantityListener::JoyStickQuantityListener ( )
protected
virtual orxonox::JoyStickQuantityListener::~JoyStickQuantityListener ( )
protectedvirtualdefault

Member Function Documentation

void orxonox::JoyStickQuantityListener::changeJoyStickQuantity ( const std::vector< JoyStick * > &  joyStickList)
staticprivate

Calls all registered objects and sets the static variable.

const std::vector<JoyStick*>& orxonox::JoyStickQuantityListener::getJoyStickList ( ) const
inlineprotected

Returns a list with all JoySticks currently loaded.

virtual void orxonox::JoyStickQuantityListener::JoyStickQuantityChanged ( const std::vector< JoyStick * > &  joyStickList)
privatepure virtual

Called whenever joy sticks get added/removed.

Implemented in orxonox::InputState, orxonox::KeyBinder, and orxonox::KeyDetector.

Friends And Related Function Documentation

friend class InputManager
friend

Member Data Documentation

std::vector< JoyStick * > orxonox::JoyStickQuantityListener::joyStickList_s
staticprivate

Static variable that holds the latest distributed information.


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