OIS::Object Class Reference

#include <OISObject.h>

Inheritance diagram for OIS::Object:

[legend]

Collaboration diagram for OIS::Object:

[legend]

List of all members.

Public Member Functions
virtual	~Object ()
Type	type () const
const std::string &	vendor () const
virtual bool	buffered () const
InputManager *	getCreator ()
virtual void	setBuffered (bool buffered)=0
virtual void	capture ()=0
virtual int	getID () const
virtual Interface *	queryInterface (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.
InputManager *	mCreator
	The creator who created this object.

---

Detailed Description

The base class of all input types.

Definition at line 32 of file OISObject.h.

---

Constructor & Destructor Documentation

virtual OIS::Object::~Object

(

)

[inline, virtual]

Definition at line 35 of file OISObject.h.

OIS::Object::Object

(

)

[inline, protected]

Definition at line 71 of file OISObject.h.

---

Member Function Documentation

Type OIS::Object::type

(

)

const [inline]

Remarks:

Get the type of device

Definition at line 38 of file OISObject.h.

Referenced by OIS::SDLMouse::capture(), OIS::LinuxJoyStick::capture(), OIS::Win32InputManager::destroyInputObject(), and OIS::LinuxInputManager::destroyInputObject().

const std::string& OIS::Object::vendor

(

)

const [inline]

Remarks:

Get the vender string name

Definition at line 41 of file OISObject.h.

virtual bool OIS::Object::buffered

(

)

const [inline, virtual]

Remarks:

Get buffered mode - true is buffered, false otherwise

Definition at line 44 of file OISObject.h.

Referenced by DlgProc(), main(), and WinMain().

InputManager* OIS::Object::getCreator

(

)

[inline]

Remarks:

Returns this input object's creator

Definition at line 47 of file OISObject.h.

virtual void OIS::Object::setBuffered

(

bool

buffered

)

[pure virtual]

Remarks:

Sets buffered mode

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

Referenced by DlgProc().

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::LinuxJoyStick, OIS::LinuxKeyboard, OIS::LinuxMouse, OIS::MacKeyboard, OIS::MacMouse, OIS::SDLKeyboard, OIS::SDLMouse, OIS::Win32JoyStick, OIS::Win32Keyboard, and OIS::Win32Mouse.

Referenced by main(), and WinMain().

virtual int OIS::Object::getID

(

)

const [inline, virtual]

Remarks:

Not fully implemented yet

Definition at line 56 of file OISObject.h.

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::LinuxJoyStick, OIS::LinuxKeyboard, OIS::LinuxMouse, OIS::MacKeyboard, OIS::MacMouse, OIS::SDLKeyboard, OIS::SDLMouse, OIS::Win32JoyStick, OIS::Win32Keyboard, and OIS::Win32Mouse.

virtual void OIS::Object::_initialize

(

)

[pure virtual]

Remarks:

Internal... Do not call this directly.

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

Referenced by OIS::Win32InputManager::createInputObject(), OIS::SDLInputManager::createInputObject(), OIS::MacInputManager::createInputObject(), and OIS::LinuxInputManager::createInputObject().

---

Member Data Documentation

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

Vendor name if applicable/known.

Definition at line 74 of file OISObject.h.

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

Type OIS::Object::mType [protected]

Type of controller object.

Definition at line 77 of file OISObject.h.

Referenced by OIS::LinuxJoyStick::LinuxJoyStick(), OIS::LinuxKeyboard::LinuxKeyboard(), OIS::LinuxMouse::LinuxMouse(), OIS::MacMouse::MacMouse(), OIS::SDLKeyboard::SDLKeyboard(), OIS::SDLMouse::SDLMouse(), OIS::Win32JoyStick::Win32JoyStick(), OIS::Win32Keyboard::Win32Keyboard(), and OIS::Win32Mouse::Win32Mouse().

bool OIS::Object::mBuffered [protected]

Buffered flag.

Definition at line 80 of file OISObject.h.

Referenced by OIS::Win32Mouse::_doMouseClick(), OIS::Win32Keyboard::_initialize(), OIS::Win32JoyStick::_initialize(), OIS::LinuxKeyboard::_injectKeyDown(), OIS::LinuxMouse::_processXEvents(), OIS::Win32Mouse::capture(), OIS::Win32Keyboard::capture(), OIS::Win32JoyStick::capture(), OIS::SDLMouse::capture(), OIS::SDLKeyboard::capture(), OIS::MacMouse::capture(), OIS::MacKeyboard::capture(), OIS::LinuxMouse::capture(), OIS::LinuxJoyStick::capture(), OIS::MacKeyboard::injectEvent(), OIS::LinuxJoyStick::LinuxJoyStick(), OIS::LinuxKeyboard::LinuxKeyboard(), OIS::LinuxMouse::LinuxMouse(), OIS::MacKeyboard::MacKeyboard(), OIS::MacMouse::MacMouse(), OIS::SDLKeyboard::SDLKeyboard(), OIS::SDLMouse::SDLMouse(), OIS::Win32Mouse::setBuffered(), OIS::Win32Keyboard::setBuffered(), OIS::Win32JoyStick::setBuffered(), OIS::SDLMouse::setBuffered(), OIS::SDLKeyboard::setBuffered(), OIS::MacMouse::setBuffered(), OIS::MacKeyboard::setBuffered(), OIS::LinuxMouse::setBuffered(), OIS::LinuxJoyStick::setBuffered(), OIS::Win32JoyStick::Win32JoyStick(), OIS::Win32Keyboard::Win32Keyboard(), and OIS::Win32Mouse::Win32Mouse().

int OIS::Object::mDevID [protected]

Not fully implemented yet.

Definition at line 83 of file OISObject.h.

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

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

The creator who created this object.

Definition at line 86 of file OISObject.h.

Referenced by OIS::Win32Mouse::_initialize(), OIS::Win32Keyboard::_initialize(), OIS::MacMouse::_initialize(), OIS::MacKeyboard::_initialize(), OIS::LinuxMouse::_initialize(), OIS::LinuxKeyboard::_initialize(), OIS::LinuxMouse::_processXEvents(), OIS::LinuxMouse::capture(), OIS::LinuxKeyboard::capture(), OIS::LinuxKeyboard::LinuxKeyboard(), OIS::LinuxMouse::LinuxMouse(), OIS::MacKeyboard::MacKeyboard(), OIS::MacMouse::MacMouse(), OIS::Win32JoyStick::Win32JoyStick(), OIS::Win32Keyboard::Win32Keyboard(), and OIS::Win32Mouse::Win32Mouse().

---

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

• E:/Download/ois-1.0RC1/includes/OISObject.h

---