OIS  1.5
Object-oriented Input System
Public Member Functions | List of all members
OIS::FactoryCreator Class Referenceabstract

#include <OISFactoryCreator.h>

Public Member Functions

virtual ~FactoryCreator ()
 
virtual DeviceList freeDeviceList ()=0
 
virtual int totalDevices (Type iType)=0
 
virtual int freeDevices (Type iType)=0
 
virtual bool vendorExist (Type iType, const std::string &vendor)=0
 
virtual ObjectcreateObject (InputManager *creator, Type iType, bool bufferMode, const std::string &vendor="")=0
 
virtual void destroyObject (Object *obj)=0
 

Detailed Description

Interface for creating devices - all devices ultimately get enumerated/created via a factory. A factory can create multiple types of objects.

Constructor & Destructor Documentation

◆ ~FactoryCreator()

virtual OIS::FactoryCreator::~FactoryCreator ( )
inlinevirtual
Remarks
Virtual Destructor

Member Function Documentation

◆ createObject()

virtual Object* OIS::FactoryCreator::createObject ( InputManager creator,
Type  iType,
bool  bufferMode,
const std::string &  vendor = "" 
)
pure virtual
Remarks
Creates the object
Parameters
iTypeType to create
bufferModeTrue to setup for buffered events
vendorCreate a device with the vendor name, "" means vendor name is unimportant

◆ destroyObject()

virtual void OIS::FactoryCreator::destroyObject ( Object obj)
pure virtual
Remarks
Destroys object
Parameters
objObject to destroy

◆ freeDeviceList()

virtual DeviceList OIS::FactoryCreator::freeDeviceList ( )
pure virtual
Remarks
Return a list of all unused devices the factory maintains

◆ freeDevices()

virtual int OIS::FactoryCreator::freeDevices ( Type  iType)
pure virtual
Remarks
Number of free devices of requested type
Parameters
iTypeType of devices to check

◆ totalDevices()

virtual int OIS::FactoryCreator::totalDevices ( Type  iType)
pure virtual
Remarks
Number of total devices of requested type
Parameters
iTypeType of devices to check

◆ vendorExist()

virtual bool OIS::FactoryCreator::vendorExist ( Type  iType,
const std::string &  vendor 
)
pure virtual
Remarks
Does a Type exist with the given vendor name
Parameters
iTypeType to check
vendorVendor name to test

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