#include <actionMap.h>

Inheritance diagram for ActionMap:

Classes
struct	Node
struct	DeviceMap
	Used to represent a devices. More...
struct	BreakEntry

Public Member Functions
	ActionMap ()
	~ActionMap ()
void	dumpActionMap (const char *fileName, const bool append) const
bool	processBind (const U32 argc, const char *argv, SimObject object=NULL)
bool	processBindCmd (const char device, const char action, const char makeCmd, const char breakCmd)
bool	processUnbind (const char device, const char action, SimObject *object=NULL)
bool	processAction (const InputEvent *)
bool	processGesture (const InputEvent *)
bool	processTouch (const InputEvent *)
bool	processButton (const InputEvent *)
bool	processMove (const InputEvent *)
bool	processMotion (const InputEvent *)
bool	processXInput (const InputEvent *)
	DECLARE_CONOBJECT (ActionMap)
Console Interface Functions
const char *	getBinding (const char *command)
	Find what the given command is bound to.
const char *	getCommand (const char device, const char action)
	Find what command is bound to the given event descriptor .
bool	isInverted (const char device, const char action)
F32	getScale (const char device, const char action)
const char *	getDeadZone (const char device, const char action)
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 SimObject *	findObject (const char *name)
Namespace *	getNamespace ()
	Return the object's namespace.
const char *	tabComplete (const char *prevText, S32 baseLen, bool)
virtual void	dump ()
virtual void	dumpClassHierarchy ()
SimObject *	clone (const bool copyDynamicFields)
virtual void	copyTo (SimObject *object)
SimObject *	deepClone ()
template<typename T>
bool	isType (void)
virtual bool	handlesConsoleMethod (const char fname, S32 routingId)
	DECLARE_CONOBJECT (SimObject)
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	copyFieldsFrom (SimObject *obj, const U32 flags)
void	assignDynamicFieldsFrom (SimObject *obj)
Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list.
void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted.
void	clearNotify (SimObject *obj)
	Notify an object when we are cleared.
void	clearAllNotifications ()
	Remove all notifications for this object.
void	processDeleteNotifies ()
	Send out deletion notifications.
void	registerReference (SimObject **obj)
void	unregisterReference (SimObject **obj)
void	addListener (std::string objID)
void	removeListener (std::string objID)
void	removeAllListeners ()
void	postEvent (std::string eventName, std::string data)
const char *	getDataField (StringTableEntry slotName, const char *array)
virtual 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)
SimFieldDictionary *	getFieldDictionary ()
void	clearDynamicFields (void)
	Clear all dynamic fields.
void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true.
bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true.
void	setInternalName (const char *newname)
StringTableEntry	getInternalName ()
	Get the internal of of this control.
virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File.
virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace.
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)
SimGroup *	getGroup () const
bool	isChildOfGroup (SimGroup *pGroup)
bool	isProperlyAdded () const
bool	isDeleted () const
bool	isRemoved () const
bool	isLocked () const
void	setLocked (bool b)
bool	isHidden () const
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)).
virtual void	onRemove ()
	Called when the object is removed from the sim.
virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup.
virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup.
virtual void	onNameChange (const char *name)
	Called when the object's name is changed.
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.
virtual void	onEditorDisable ()
	Called when the editor is deactivated.
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 *)
Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name.
virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep.
bool	setField (const char fieldName, const char value)
	Set the value of a field.
virtual	~ConsoleObject ()
const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified.
AbstractClassRep::FieldList &	getModifiableFieldList ()
bool &	getDynamicGroupExpand ()
S32	getClassId (U32 netClassGroup) const
const char *	getClassName () const

Static Public Member Functions
static bool	createEventDescriptor (const char pEventString, EventDescriptor pDescriptor)
static const char *	swapCtrlForCmd (const char *input)
	A simple helper function that takes Ctrl and turns it to Cmd on Mac.
static bool	getKeyString (const U32 action, char *buffer)
static bool	getDeviceName (const U32 deviceType, const U32 deviceInstance, char *buffer)
static const char *	buildActionString (const InputEvent *event)
static bool	checkBreakTable (const InputEvent *)
static bool	handleEvent (const InputEvent *)
static bool	handleEventGlobal (const InputEvent *)
static bool	getDeviceTypeAndInstance (const char *device, U32 &deviceType, U32 &deviceInstance)
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.
static void	initPersistFields ()
static void	consoleInit ()
static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class.
static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass.
static ConsoleObject *	create (const char *in_pClassName)
static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)

Protected Member Functions
bool	onAdd ()
	Called when the object is added to the sim.
const Node *	findNode (const U32 inDeviceType, const U32 inDeviceInst, const U32 inModifiers, const U32 inAction)
bool	findBoundNode (const char *function, U32 &devMapIndex, U32 &nodeIndex)
bool	nextBoundNode (const char *function, U32 &devMapIndex, U32 &nodeIndex)
Node *	getNode (const U32 inDeviceType, const U32 inDeviceInst, const U32 inModifiers, const U32 inAction, SimObject *object=NULL)
void	removeNode (const U32 inDeviceType, const U32 inDeviceInst, const U32 inModifiers, const U32 inAction, SimObject *object=NULL)
void	enterBreakEvent (const InputEvent pEvent, const Node pNode)
Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks.
virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object.
virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object.
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.
virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written.
virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read.
void	linkNamespaces ()
void	unlinkNamespaces ()
virtual SimObject *	allocClone ()
	A registered but empty object of this object's class.
void	cloneInto (SimObject *clone)
virtual void	deepCloneChildren (SimObject *clone)
Protected Member Functions inherited from ConsoleObject
	ConsoleObject ()
	ConsoleObject (const ConsoleObject &)

Static Protected Member Functions
static const char *	getModifierString (const U32 modifiers)
static void	fireBreakEvent (U32 idx, F32 value=0.f)
	Pass index to a break entry, and this function will fire it off.
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	writeObjectName (void *obj, StringTableEntry pFieldName)
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 bool	setProtectedName (void obj, const char data)
static const char *	getProtectedName (void obj, const char data)
static SimObject::Notify *	allocNotify ()
	Get a free Notify structure.
static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free.
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
Vector< DeviceMap * >	mDeviceMaps
Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object.
StringTableEntry	mIdString
Namespace *	mNameSpace
U32	mTypeMask
S32	mScriptCallbackGuard
	Whether the object is executing a script callback.
bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true
StringTableEntry	mInternalName
	Stores object Internal Name.
StringTableEntry	mClassName
	Stores the class name to link script class namespaces.
StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces.

Static Protected Attributes
static Vector< BreakEntry >	smBreakTable
static SimObject::Notify *	mNotifyFreeList = NULL

Additional Inherited Members
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }
enum	CopyFieldsFlags { CopyFields_SkipName = BIT(0) , CopyFields_SkipParentGroup = BIT(1) , CopyFields_SkipScriptClass = BIT(2) }
	What copyFieldsFrom may be told to leave alone. More...
static bool	disableNameChanging = false

Detailed Description

Map raw inputs to a variety of actions. This is used for all keymapping in the engine.

See also: ActionMap::Node

Constructor & Destructor Documentation

◆ ActionMap()

ActionMap ( )

◆ ~ActionMap()

~ActionMap ( )

Member Function Documentation

◆ buildActionString()

const char * buildActionString ( const InputEvent * event )

static

◆ checkBreakTable()

bool checkBreakTable ( const InputEvent * pEvent )

static

◆ createEventDescriptor()

bool createEventDescriptor	(	const char *	pEventString,
		EventDescriptor *	pDescriptor )

static

◆ DECLARE_CONOBJECT()

DECLARE_CONOBJECT ( ActionMap )

◆ dumpActionMap()

void dumpActionMap	(	const char *	fileName,
		const bool	append ) const

◆ enterBreakEvent()

void enterBreakEvent	(	const InputEvent *	pEvent,
		const Node *	pNode )

protected

◆ findBoundNode()

bool findBoundNode	(	const char *	function,
		U32 &	devMapIndex,
		U32 &	nodeIndex )

protected

◆ findNode()

const ActionMap::Node * findNode	(	const U32	inDeviceType,
		const U32	inDeviceInst,
		const U32	inModifiers,
		const U32	inAction )

protected

◆ fireBreakEvent()

void fireBreakEvent	(	U32	idx,
		F32	value = 0.f )

staticprotected

Pass index to a break entry, and this function will fire it off.

◆ getBinding()

const char * getBinding ( const char * command )

Find what the given command is bound to.

◆ getCommand()

const char * getCommand	(	const char *	device,
		const char *	action )

Find what command is bound to the given event descriptor .

◆ getDeadZone()

const char * getDeadZone	(	const char *	device,
		const char *	action )

◆ getDeviceName()

bool getDeviceName	(	const U32	deviceType,
		const U32	deviceInstance,
		char *	buffer )

static

◆ getDeviceTypeAndInstance()

bool getDeviceTypeAndInstance	(	const char *	device,
		U32 &	deviceType,
		U32 &	deviceInstance )

static

◆ getKeyString()

bool getKeyString	(	const U32	action,
		char *	buffer )

static

◆ getModifierString()

const char * getModifierString ( const U32 modifiers )

staticprotected

◆ getNode()

ActionMap::Node * getNode	(	const U32	inDeviceType,
		const U32	inDeviceInst,
		const U32	inModifiers,
		const U32	inAction,
		SimObject *	object = NULL )

protected

◆ getScale()

F32 getScale	(	const char *	device,
		const char *	action )

◆ handleEvent()

bool handleEvent ( const InputEvent * pEvent )

static

◆ handleEventGlobal()

bool handleEventGlobal ( const InputEvent * pEvent )

static

◆ isInverted()

bool isInverted	(	const char *	device,
		const char *	action )

◆ nextBoundNode()

bool nextBoundNode	(	const char *	function,
		U32 &	devMapIndex,
		U32 &	nodeIndex )

protected

◆ onAdd()

bool onAdd ( void )

protectedvirtual

Called when the object is added to the sim.

Reimplemented from SimObject.

◆ processAction()

bool processAction ( const InputEvent * pEvent )

◆ processBind()

bool processBind	(	const U32	argc,
		const char **	argv,
		SimObject *	object = NULL )

◆ processBindCmd()

bool processBindCmd	(	const char *	device,
		const char *	action,
		const char *	makeCmd,
		const char *	breakCmd )

◆ processButton()

bool processButton ( const InputEvent * pEvent )

◆ processGesture()

bool processGesture ( const InputEvent * pEvent )

◆ processMotion()

bool processMotion ( const InputEvent * pEvent )

◆ processMove()

bool processMove ( const InputEvent * pEvent )

◆ processTouch()

bool processTouch ( const InputEvent * pEvent )

◆ processUnbind()

bool processUnbind	(	const char *	device,
		const char *	action,
		SimObject *	object = NULL )

◆ processXInput()

bool processXInput ( const InputEvent * pEvent )

◆ removeNode()

void removeNode	(	const U32	inDeviceType,
		const U32	inDeviceInst,
		const U32	inModifiers,
		const U32	inAction,
		SimObject *	object = NULL )

protected

◆ swapCtrlForCmd()

const char * swapCtrlForCmd ( const char * input )

static

A simple helper function that takes Ctrl and turns it to Cmd on Mac.

Member Data Documentation

◆ mDeviceMaps

Vector<DeviceMap*> mDeviceMaps

protected

◆ smBreakTable

Vector< ActionMap::BreakEntry > smBreakTable

staticprotected

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

input/actionMap.h
input/actionMap.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ActionMap()

◆ ~ActionMap()

Member Function Documentation

◆ buildActionString()

◆ checkBreakTable()

◆ createEventDescriptor()

◆ DECLARE_CONOBJECT()

◆ dumpActionMap()

◆ enterBreakEvent()

◆ findBoundNode()

◆ findNode()

◆ fireBreakEvent()

◆ getBinding()

◆ getCommand()

◆ getDeadZone()

◆ getDeviceName()

◆ getDeviceTypeAndInstance()

◆ getKeyString()

◆ getModifierString()

◆ getNode()

◆ getScale()

◆ handleEvent()

◆ handleEventGlobal()

◆ isInverted()

◆ nextBoundNode()

◆ onAdd()

◆ processAction()

◆ processBind()

◆ processBindCmd()

◆ processButton()

◆ processGesture()

◆ processMotion()

◆ processMove()

◆ processTouch()

◆ processUnbind()

◆ processXInput()

◆ removeNode()

◆ swapCtrlForCmd()

Member Data Documentation

◆ mDeviceMaps

◆ smBreakTable