OIS::Object Class Reference

#include <OISObject.h>

Inheritance diagram for OIS::Object:

OIS::JoyStick OIS::Keyboard OIS::Mouse List of all members.

Public Member Functions

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

Protected Member Functions

 Object ()

Protected Attributes

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

Detailed Description

The base class of all input types.


Constructor & Destructor Documentation

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

OIS::Object::Object (  )  [inline, protected]


Member Function Documentation

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

Remarks:
Get the type of device

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

Remarks:
Get the vender string name

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

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

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

Remarks:
Returns this input object's creator

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

Remarks:
Sets buffered mode

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

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

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

Remarks:
Not fully implemented yet

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

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

Remarks:
Internal... Do not call this directly.


Member Data Documentation

std::string OIS::Object::mVendor [protected]

Vendor name if applicable/known.

Type OIS::Object::mType [protected]

Type of controller object.

bool OIS::Object::mBuffered [protected]

Buffered flag.

int OIS::Object::mDevID [protected]

Not fully implemented yet.

InputManager* OIS::Object::mCreator [protected]

The creator who created this object.


The documentation for this class was generated from the following file:
Generated on Fri Jul 13 21:21:06 2007 for OIS by  doxygen 1.5.2