OIS::Object Class Reference

#include <src/ois/OISObject.h>

Inheritance diagram for OIS::Object:

OIS::JoyStick OIS::Keyboard OIS::Mouse OIS::LinuxJoyStick OIS::Win32JoyStick OIS::LinuxKeyboard OIS::MacKeyboard OIS::Win32Keyboard OIS::LinuxMouse OIS::MacMouse OIS::Win32Mouse

List of all members.

Public Member Functions

virtual void _initialize ()=0
virtual bool buffered () const
virtual void capture ()=0
InputManagergetCreator () const
virtual int getID () const
virtual InterfacequeryInterface (Interface::IType type)=0
virtual void setBuffered (bool buffered)=0
Type type () const
const std::stringvendor () const
virtual ~Object ()

Protected Member Functions

 Object (const std::string &vendor, Type iType, bool buffered, int devID, InputManager *creator)

Protected Attributes

bool mBuffered
 Buffered flag.
InputManagermCreator
 The creator who created this object.
int mDevID
 Not fully implemented yet.
Type mType
 Type of controller object.
std::string mVendor
 Vendor name if applicable/known.


Detailed Description

The base class of all input types.

Constructor & Destructor Documentation

virtual OIS::Object::~Object (  )  [inline, virtual]

OIS::Object::Object ( const std::string vendor,
Type  iType,
bool  buffered,
int  devID,
InputManager creator 
) [inline, protected]


Member Function Documentation

virtual void OIS::Object::_initialize (  )  [pure virtual]

virtual bool OIS::Object::buffered (  )  const [inline, virtual]

Remarks:
Get buffered mode - true is buffered, false otherwise

virtual void OIS::Object::capture (  )  [pure virtual]

Remarks:
Used for updating call once per frame before checking state or to update events

Implemented in OIS::LinuxJoyStick, OIS::LinuxKeyboard, OIS::LinuxMouse, OIS::MacKeyboard, OIS::MacMouse, OIS::Win32JoyStick, OIS::Win32Keyboard, and OIS::Win32Mouse.

Referenced by orxonox::InputManager::update().

InputManager* OIS::Object::getCreator (  )  const [inline]

Remarks:
Returns this input object's creator

virtual int OIS::Object::getID (  )  const [inline, virtual]

Remarks:
This may/may not) differentiate the different controllers based on (for instance) a port number (useful for console InputManagers)

Referenced by orxonox::InputManager::_initialiseJoySticks().

virtual Interface* OIS::Object::queryInterface ( Interface::IType  type  )  [pure virtual]

Remarks:
If available, get an interface to write to some devices. Examples include, turning on and off LEDs, ForceFeedback, etc
Parameters:
type The type of interface you are looking for

Implemented in OIS::LinuxJoyStick, OIS::LinuxKeyboard, OIS::LinuxMouse, OIS::MacKeyboard, OIS::MacMouse, OIS::Win32JoyStick, OIS::Win32Keyboard, and OIS::Win32Mouse.

virtual void OIS::Object::setBuffered ( bool  buffered  )  [pure virtual]

Type OIS::Object::type (  )  const [inline]

Remarks:
Get the type of device

Referenced by OIS::LinuxJoyStick::capture(), and OIS::LinuxInputManager::destroyObject().

const std::string& OIS::Object::vendor (  )  const [inline]

Remarks:
Get the vender string name


Member Data Documentation

bool OIS::Object::mBuffered [protected]

int OIS::Object::mDevID [protected]

Not fully implemented yet.

Referenced by OIS::LinuxJoyStick::_getJoyInfo(), and OIS::Win32JoyStick::~Win32JoyStick().

Type OIS::Object::mType [protected]

Type of controller object.

Vendor name if applicable/known.

Referenced by OIS::LinuxJoyStick::_getJoyInfo(), and OIS::Win32JoyStick::~Win32JoyStick().


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

Generated on Tue Jul 28 16:22:18 2009 for Orxonox by  doxygen 1.5.6