Torque2D Reference
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
DInputDevice Class Reference

#include <winDInputDevice.h>

+ Inheritance diagram for DInputDevice:

Public Member Functions

 DInputDevice (const DIDEVICEINSTANCE *deviceInst)
 
 ~DInputDevice ()
 
bool create ()
 
void destroy ()
 
bool acquire ()
 
bool unacquire ()
 
bool isAcquired ()
 
bool isPolled ()
 
U8 getDeviceType ()
 
U8 getDeviceID ()
 
const char * getName ()
 
const char * getProductName ()
 
void rumble (float x, float y)
 
const char * getJoystickAxesString ()
 
bool process ()
 
- Public Member Functions inherited from InputDevice
const char * getDeviceName ()
 
- Public Member Functions inherited from SimObject
StringTableEntry getClassNamespace () const
 
StringTableEntry getSuperClassNamespace () const
 
void setClassNamespace (const char *classNamespace)
 
void setSuperClassNamespace (const char *superClassNamespace)
 
void pushScriptCallbackGuard (void)
 
void popScriptCallbackGuard (void)
 
S32 getScriptCallbackGuard (void)
 
virtual SimObjectfindObject (const char *name)
 
NamespacegetNamespace ()
 Return the object's namespace. More...
 
const char * tabComplete (const char *prevText, S32 baseLen, bool)
 
virtual void dump ()
 
virtual void dumpClassHierarchy ()
 
SimObjectclone (const bool copyDynamicFields)
 
virtual void copyTo (SimObject *object)
 
template<typename T >
bool isType (void)
 
virtual bool handlesConsoleMethod (const char *fname, S32 *routingId)
 
 DECLARE_CONOBJECT (SimObject)
 
NotifyremoveNotify (void *ptr, Notify::Type)
 Remove a notification from the list. More...
 
void deleteNotify (SimObject *obj)
 Notify an object when we are deleted. More...
 
void clearNotify (SimObject *obj)
 Notify an object when we are cleared. More...
 
void clearAllNotifications ()
 Remove all notifications for this object. More...
 
void processDeleteNotifies ()
 Send out deletion notifications. More...
 
void registerReference (SimObject **obj)
 
void unregisterReference (SimObject **obj)
 
const char * getDataField (StringTableEntry slotName, const char *array)
 
void setDataField (StringTableEntry slotName, const char *array, const char *value)
 
const char * getPrefixedDataField (StringTableEntry fieldName, const char *array)
 
void setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value)
 
const char * getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
 
void setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1)
 
StringTableEntry getDataFieldPrefix (StringTableEntry fieldName)
 
U32 getDataFieldType (StringTableEntry slotName, const char *array)
 
SimFieldDictionarygetFieldDictionary ()
 
void clearDynamicFields (void)
 Clear all dynamic fields. More...
 
void setCanSaveDynamicFields (bool bCanSave)
 Set whether fields created at runtime should be saved. Default is true. More...
 
bool getCanSaveDynamicFields (void) const
 Get whether fields created at runtime should be saved. Default is true. More...
 
void setInternalName (const char *newname)
 
StringTableEntry getInternalName ()
 Get the internal of of this control. More...
 
virtual bool save (const char *pcFilePath, bool bOnlySelected=false)
 Save object as a TorqueScript File. More...
 
virtual bool isMethod (const char *methodName)
 Check if a method exists in the objects current namespace. More...
 
SimObjectId getId (void) const
 
StringTableEntry getIdString (void) const
 
U32 getType () const
 
const StringTableEntry getName (void) const
 
void setId (SimObjectId id)
 
void assignName (const char *name)
 
SimGroupgetGroup () const
 
bool isChildOfGroup (SimGroup *pGroup)
 
bool isProperlyAdded () const
 
bool isDeleted () const
 
bool isRemoved () const
 
bool isLocked ()
 
void setLocked (bool b)
 
bool isHidden ()
 
void setHidden (bool b)
 
void setProgenitorFile (const char *pFile)
 
StringTableEntry getProgenitorFile (void) const
 
void setPeriodicTimerID (const S32 timerID)
 
S32 getPeriodicTimerID (void) const
 
bool isPeriodicTimerActive (void) const
 
bool isSelected () const
 
bool isExpanded () const
 
void setSelected (bool sel)
 
void setExpanded (bool exp)
 
void setModDynamicFields (bool dyn)
 
void setModStaticFields (bool sta)
 
 SimObject ()
 
virtual ~SimObject ()
 
virtual bool processArguments (S32 argc, const char **argv)
 Process constructor options. (ie, new SimObject(1,2,3)) More...
 
virtual bool onAdd ()
 Called when the object is added to the sim. More...
 
virtual void onRemove ()
 Called when the object is removed from the sim. More...
 
virtual void onGroupAdd ()
 Called when the object is added to a SimGroup. More...
 
virtual void onGroupRemove ()
 Called when the object is removed from a SimGroup. More...
 
virtual void onNameChange (const char *name)
 Called when the object's name is changed. More...
 
virtual void onStaticModified (const char *slotName, const char *newValue=NULL)
 
virtual void inspectPreApply ()
 
virtual void inspectPostApply ()
 
virtual void onDeleteNotify (SimObject *object)
 
virtual void onEditorEnable ()
 Called when the editor is activated. More...
 
virtual void onEditorDisable ()
 Called when the editor is deactivated. More...
 
bool registerObject ()
 
bool registerObject (U32 id)
 
bool registerObject (const char *name)
 
bool registerObject (const char *name, U32 id)
 
void unregisterObject ()
 
void deleteObject ()
 
bool addToSet (SimObjectId)
 
bool addToSet (const char *)
 
bool removeFromSet (SimObjectId)
 
bool removeFromSet (const char *)
 
virtual bool writeField (StringTableEntry fieldname, const char *value)
 
virtual void write (Stream &stream, U32 tabStop, U32 flags=0)
 
virtual void writeFields (Stream &stream, U32 tabStop)
 
virtual bool writeObject (Stream *stream)
 
virtual bool readObject (Stream *stream)
 
virtual void buildFilterList ()
 
void addFieldFilter (const char *fieldName)
 
void removeFieldFilter (const char *fieldName)
 
void clearFieldFilters ()
 
bool isFiltered (const char *fieldName)
 
void assignFieldsFrom (SimObject *obj)
 
void assignDynamicFieldsFrom (SimObject *obj)
 
- Public Member Functions inherited from ConsoleObject
const AbstractClassRep::FieldfindField (StringTableEntry fieldName) const
 Get a reference to a field by name. More...
 
virtual AbstractClassRepgetClassRep () const
 Gets the ClassRep. More...
 
bool setField (const char *fieldName, const char *value)
 Set the value of a field. More...
 
virtual ~ConsoleObject ()
 
const AbstractClassRep::FieldListgetFieldList () const
 Get a list of all the fields. This information cannot be modified. More...
 
AbstractClassRep::FieldListgetModifiableFieldList ()
 
bool & getDynamicGroupExpand ()
 
S32 getClassId (U32 netClassGroup) const
 
const char * getClassName () const
 

Static Public Member Functions

static void init ()
 
static void resetModifierKeys ()
 
static bool joystickDetected ()
 
static U8 getJoystickCount ()
 
- Static Public Member Functions inherited from SimObject
static void initPersistFields ()
 
- Static Public Member Functions inherited from ConsoleObject
static const char * lookupClassName (const U32 in_classTag)
 Get the classname from a class tag. More...
 
static void initPersistFields ()
 
static void consoleInit ()
 
static ConsoleObjectcreate (const char *in_pClassName)
 
static ConsoleObjectcreate (const U32 groupId, const U32 typeId, const U32 in_classId)
 
static AbstractClassRepgetStaticClassRep ()
 Get the abstract class information for this class. More...
 
static AbstractClassRepgetParentStaticClassRep ()
 Get the abstract class information for this class's superclass. More...
 

Static Public Attributes

static LPDIRECTINPUT8 smDInputInterface
 

Protected Types

enum  Constants {
  QUEUED_BUFFER_SIZE = 128, SIZEOF_BUTTON = 1, SIZEOF_KEY = 1, SIZEOF_AXIS = 4,
  SIZEOF_POV = 4
}
 

Protected Member Functions

bool enumerateObjects ()
 
bool processAsync ()
 
bool processImmediate ()
 
bool processKeyEvent (InputEvent &event)
 
void syncKeyboardState ()
 
DWORD findObjInstance (DWORD offset)
 
bool buildEvent (DWORD offset, S32 newData, S32 oldData)
 
- Protected Member Functions inherited from SimObject
virtual void onTamlPreWrite (void)
 Taml callbacks. More...
 
virtual void onTamlPostWrite (void)
 Called after Taml has finished writing the object. More...
 
virtual void onTamlPreRead (void)
 Called prior to Taml reading the object. More...
 
virtual void onTamlPostRead (const TamlCustomNodes &customNodes)
 
virtual void onTamlAddParent (SimObject *pParentObject)
 Called after Taml has finished reading the object and has added the object to any parent. More...
 
virtual void onTamlCustomWrite (TamlCustomNodes &customNodes)
 Called during the writing of the object to allow custom properties to be written. More...
 
virtual void onTamlCustomRead (const TamlCustomNodes &customNodes)
 Called during the reading of the object to allow custom properties to be read. More...
 
void linkNamespaces ()
 
void unlinkNamespaces ()
 
- Protected Member Functions inherited from ConsoleObject
 ConsoleObject ()
 
 ConsoleObject (const ConsoleObject &)
 

Static Protected Member Functions

static BOOL CALLBACK EnumObjectsProc (const DIDEVICEOBJECTINSTANCE *doi, LPVOID pvRef)
 
- Static Protected Member Functions inherited from SimObject
static bool setClass (void *obj, const char *data)
 
static bool setSuperClass (void *obj, const char *data)
 
static bool writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
 
static bool writeInternalName (void *obj, StringTableEntry pFieldName)
 
static bool setParentGroup (void *obj, const char *data)
 
static bool writeParentGroup (void *obj, StringTableEntry pFieldName)
 
static bool writeSuperclass (void *obj, StringTableEntry pFieldName)
 
static bool writeClass (void *obj, StringTableEntry pFieldName)
 
static SimObject::NotifyallocNotify ()
 Get a free Notify structure. More...
 
static void freeNotify (SimObject::Notify *)
 Mark a Notify structure as free. More...
 
- Static Protected Member Functions inherited from ConsoleObject
static void addGroup (const char *in_pGroupname, const char *in_pGroupDocs=NULL)
 
static void endGroup (const char *in_pGroupname)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char *in_pFieldDocs)
 
static void addFieldV (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator *v, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char *in_pFieldDocs=NULL)
 
static void addDepricatedField (const char *fieldName)
 
static bool removeField (const char *in_pFieldname)
 

Protected Attributes

LPDIRECTINPUTDEVICE8 mDevice
 
DIDEVICEINSTANCE mDeviceInstance
 
DIDEVCAPS mDeviceCaps
 
U8 mDeviceType
 
U8 mDeviceID
 
bool mAcquired
 
bool mNeedSync
 
LPDIRECTINPUTEFFECT mForceFeedbackEffect
 Holds our DirectInput FF Effect. More...
 
DWORD mNumForceFeedbackAxes
 

axes (we only support 0, 1, or 2

More...
 
DWORD mForceFeedbackAxes [2]
 Force Feedback axes offsets into DIOBJECTFORMAT. More...
 
DIDEVICEOBJECTINSTANCE * mObjInstance
 
DIOBJECTDATAFORMAT * mObjFormat
 
ObjInfomObjInfo
 
U8 * mObjBuffer1
 
U8 * mObjBuffer2
 
U8 * mPrevObjBuffer
 
S32 mPrevPOVPos
 
U32 mObjBufferSize
 
U32 mObjCount
 
U32 mObjEnumCount
 
U32 mObjBufferOfs
 
- Protected Attributes inherited from InputDevice
char mName [30]
 
- Protected Attributes inherited from SimObject
SimObjectId mId
 Id number for this object. More...
 
StringTableEntry mIdString
 
NamespacemNameSpace
 
U32 mTypeMask
 
S32 mScriptCallbackGuard
 Whether the object is executing a script callback. More...
 
bool mCanSaveFieldDictionary
 true if dynamic fields (added at runtime) should be saved, defaults to true More...
 
StringTableEntry mInternalName
 Stores object Internal Name. More...
 
StringTableEntry mClassName
 Stores the class name to link script class namespaces. More...
 
StringTableEntry mSuperClassName
 Stores super class name to link script class namespaces. More...
 

Static Protected Attributes

static U8 smKeyboardCount
 
static U8 smMouseCount
 
static U8 smJoystickCount
 
static U8 smUnknownCount
 
static U8 smModifierKeys
 
static bool smKeyStates [256]
 
static bool smInitialized = false
 
- Static Protected Attributes inherited from SimObject
static SimObject::NotifymNotifyFreeList = NULL
 

Additional Inherited Members

- Public Types inherited from SimObject
enum  WriteFlags { SelectedOnly = BIT(0) }
 

Member Enumeration Documentation

enum Constants
protected
Enumerator
QUEUED_BUFFER_SIZE 
SIZEOF_BUTTON 
SIZEOF_KEY 
SIZEOF_AXIS 
SIZEOF_POV 

Constructor & Destructor Documentation

DInputDevice ( const DIDEVICEINSTANCE *  deviceInst)

Member Function Documentation

bool acquire ( )
bool buildEvent ( DWORD  offset,
S32  newData,
S32  oldData 
)
protected
bool create ( void  )
void destroy ( )
bool enumerateObjects ( )
protected
BOOL CALLBACK EnumObjectsProc ( const DIDEVICEOBJECTINSTANCE *  doi,
LPVOID  pvRef 
)
staticprotected
DWORD findObjInstance ( DWORD  offset)
protected
U8 getDeviceID ( )
inline
U8 getDeviceType ( )
inline
const char * getJoystickAxesString ( )
U8 getJoystickCount ( )
static
const char * getName ( void  )
const char * getProductName ( )
void init ( )
static
bool isAcquired ( )
inline
bool isPolled ( )
inline
bool joystickDetected ( )
static
bool process ( )
virtual

Implements InputDevice.

bool processAsync ( )
protected
bool processImmediate ( )
protected
bool processKeyEvent ( InputEvent event)
protected
void resetModifierKeys ( )
static
void rumble ( float  x,
float  y 
)
void syncKeyboardState ( )
protected
bool unacquire ( )

Member Data Documentation

bool mAcquired
protected
LPDIRECTINPUTDEVICE8 mDevice
protected
DIDEVCAPS mDeviceCaps
protected
U8 mDeviceID
protected
DIDEVICEINSTANCE mDeviceInstance
protected
U8 mDeviceType
protected
DWORD mForceFeedbackAxes[2]
protected

Force Feedback axes offsets into DIOBJECTFORMAT.

LPDIRECTINPUTEFFECT mForceFeedbackEffect
protected

Holds our DirectInput FF Effect.

bool mNeedSync
protected
DWORD mNumForceFeedbackAxes
protected

axes (we only support 0, 1, or 2

U8* mObjBuffer1
protected
U8* mObjBuffer2
protected
U32 mObjBufferOfs
protected
U32 mObjBufferSize
protected
U32 mObjCount
protected
U32 mObjEnumCount
protected
DIOBJECTDATAFORMAT* mObjFormat
protected
ObjInfo* mObjInfo
protected
DIDEVICEOBJECTINSTANCE* mObjInstance
protected
U8* mPrevObjBuffer
protected
S32 mPrevPOVPos
protected
LPDIRECTINPUT8 smDInputInterface
static
bool smInitialized = false
staticprotected
U8 smJoystickCount
staticprotected
U8 smKeyboardCount
staticprotected
bool smKeyStates
staticprotected
U8 smModifierKeys
staticprotected
U8 smMouseCount
staticprotected
U8 smUnknownCount
staticprotected

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