Inherits SimObject, and SimObject.

Inherited by GlobalActionMap, and GlobalActionMap.

Methods
void	bind (device, action,[modifier, mod...], command)

void	bind (device, action,[modifier, mod...], command)

void	bindCmd (device, action, makeCmd, breakCmd)

void	bindCmd (device, action, makeCmd, breakCmd)

void	bindObj (device, action,[modifier spec, mod...], command, object)

void	bindObj (device, action,[modifier spec, mod...], command, object)

string	getBinding (command)

string	getBinding (command)

string	getCommand (device, action)

string	getCommand (device, action)

string	getDeadZone (device, action)

string	getDeadZone (device, action)

float	getScale (device, action)

float	getScale (device, action)

bool	isInverted (device, action)

bool	isInverted (device, action)

void	pop ()

void	pop ()

void	push ()

void	push ()

void	save ([fileName][, append])

void	save ([fileName][, append])

void	unbind (device, action)

void	unbind (device, action)

void	unbindObj (device, action, object)

void	unbindObj (device, action, object)

Methods inherited from SimObject
void	addFieldFilter (fieldName)

void	addFieldFilter (fieldName)

string	call (%args)

string	call (%args)

int	clone ([bool copyDynamicFields?=false])

int	clone ([bool copyDynamicFields?=false])

void	delete ()

void	delete ()

void	dump ()

void	dump ()

void	dumpClassHierarchy ()

void	dumpClassHierarchy ()

string	getClassName ()

string	getClassName ()

string	getClassNamespace ()

string	getClassNamespace ()

string	getDynamicField (index)

string	getDynamicField (index)

int	getDynamicFieldCount ()

int	getDynamicFieldCount ()

string	getField (int index)

string	getField (int index)

int	getFieldCount ()

int	getFieldCount ()

string	getFieldType (fieldName)

string	getFieldType (fieldName)

string	getFieldValue (fieldName)

string	getFieldValue (fieldName)

int	getGroup ()

int	getGroup ()

int	getId ()

int	getId ()

string	getInternalName ()

string	getInternalName ()

string	getName ()

string	getName ()

string	getProgenitorFile ()

string	getProgenitorFile ()

string	getSuperClassNamespace ()

string	getSuperClassNamespace ()

int	getType ()

int	getType ()

bool	isChildOfGroup ()

bool	isChildOfGroup ()

bool	isMemberOfClass (string classname)

bool	isMemberOfClass (string classname)

bool	isMethod (string method name)

bool	isMethod (string method name)

bool	isTimerActive ()

bool	isTimerActive ()

void	removeFieldFilter (fieldName)

void	removeFieldFilter (fieldName)

bool	save (fileName,[selectedOnly])

bool	save (fileName,[selectedOnly])

int	schedule (time, command,< arg1...argN >)

int	schedule (time, command,< arg1...argN >)

void	setClassNamespace ()

void	setClassNamespace ()

bool	setFieldValue (fieldName, value)

bool	setFieldValue (fieldName, value)

void	setInternalName ()

void	setInternalName ()

void	setName (newName)

void	setName (newName)

void	setProgenitorFile (file)

void	setProgenitorFile (file)

void	setSuperClassNamespace ()

void	setSuperClassNamespace ()

bool	startTimer (callbackFunction, float timePeriod,[repeat])

bool	startTimer (callbackFunction, float timePeriod,[repeat])

void	stopTimer ()

void	stopTimer ()

Fields
SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

void ActionMap::bind	(	device	,
		action	,
		command
	)

Use the bind method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed.

Parameters

device	Name of the device to bind the command to.
action	Name of the action to watch for.
modifier	Special modifiers (mouse only), such as dead spot, etc.
command	The function to be called on make and break.

Returns: No return value.

See Also: bindCmd, getBinding, unbind

void ActionMap::bind	(	device	,
		action	,
		command
	)

Use the bind method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed.

Parameters

device	Name of the device to bind the command to.
action	Name of the action to watch for.
modifier	Special modifiers (mouse only), such as dead spot, etc.
command	The function to be called on make and break.

Returns: No return value.

See Also: bindCmd, getBinding, unbind

void ActionMap::bindCmd	(	device	,
		action	,
		makeCmd	,
		breakCmd
	)

Use the bindCmd method to associate up to two functions to a keystroke or other device input. The makeCmd is bound to the make event and the breakCmd is bound to the break event and in both cases, the commands are specified as complete scripts, with all arguments, elipses, and the terminating semi-colon. Either of these commands may be non-specified (NULL strings). For clarification, see 'Bind Sample' example below.

Parameters

device	Name of the device to bind the command to (see 'Device Table' below).
action	Name of the action to watch for(see 'Action Table' below).
makeCmd	The function to be called on make event.
breakCmd	The function to be called on break event.

Returns: No return value.

See Also: bind, getBinding, unbind

void ActionMap::bindCmd	(	device	,
		action	,
		makeCmd	,
		breakCmd
	)

Use the bindCmd method to associate up to two functions to a keystroke or other device input. The makeCmd is bound to the make event and the breakCmd is bound to the break event and in both cases, the commands are specified as complete scripts, with all arguments, elipses, and the terminating semi-colon. Either of these commands may be non-specified (NULL strings). For clarification, see 'Bind Sample' example below.

Parameters

device	Name of the device to bind the command to (see 'Device Table' below).
action	Name of the action to watch for(see 'Action Table' below).
makeCmd	The function to be called on make event.
breakCmd	The function to be called on break event.

Returns: No return value.

See Also: bind, getBinding, unbind

void ActionMap::bindObj	(	device	,
		action	,
		command	,
		object
	)

Use the bindObj method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed.

Parameters

device	Name of the device to bind the command to.
action	Name of the action to watch for.
modifier	Special modifiers (mouse only), such as dead spot, etc.
command	The function to be called on make and break.
object	The explicit object (it defaults to NULL when you call bind() )

Returns: No return value.

See Also: bindCmd, getBinding, unbind

void ActionMap::bindObj	(	device	,
		action	,
		command	,
		object
	)

Use the bindObj method to associate a function to a keystroke or other device input. The command bound via the bind function must be specified as a flat name with no elipses or semi-colon termination and will be called on make and break events (i.e. key press and release for a mapped key). Args: Warning: When a function is bound to a keystroke or other device input, and no other versions of the binding are provided, the function will be called even if a modifier key like CTRL, ALT, or SHIFT is also pressed.

Parameters

device	Name of the device to bind the command to.
action	Name of the action to watch for.
modifier	Special modifiers (mouse only), such as dead spot, etc.
command	The function to be called on make and break.
object	The explicit object (it defaults to NULL when you call bind() )

Returns: No return value.

See Also: bindCmd, getBinding, unbind

string ActionMap::getBinding ( command )

Use the getBinding method to get the binding for a specified command.

Parameters

command The function to seek a binding for.

Returns: Returns a string containing the binding as a field (TAB separated string), or a NULL string meaning 'no binding found'.

See Also: bind, bindCmd

string ActionMap::getBinding ( command )

Use the getBinding method to get the binding for a specified command.

Parameters

command The function to seek a binding for.

Returns: Returns a string containing the binding as a field (TAB separated string), or a NULL string meaning 'no binding found'.

See Also: bind, bindCmd

string ActionMap::getCommand	(	device	,
		action
	)

Use the getCommand method to get the function associated with a specific device + action pair.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns the function name or specification associated with the specified device + action pair, or a NULL-string meaning 'no binding found'.

See Also: bind, bindCmd, getBinding

string ActionMap::getCommand	(	device	,
		action
	)

Use the getCommand method to get the function associated with a specific device + action pair.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns the function name or specification associated with the specified device + action pair, or a NULL-string meaning 'no binding found'.

See Also: bind, bindCmd, getBinding

string ActionMap::getDeadZone	(	device	,
		action
	)

Use the getDeadZone method to get the dead-zone associated with a specific device + action pair.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns a dead-zone specification, or "0 0" meaning that there is no dead-zone, or a NULL string meaning the mapping was not found.

See Also: bind, bindCmd

string ActionMap::getDeadZone	(	device	,
		action
	)

Use the getDeadZone method to get the dead-zone associated with a specific device + action pair.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns a dead-zone specification, or "0 0" meaning that there is no dead-zone, or a NULL string meaning the mapping was not found.

See Also: bind, bindCmd

float ActionMap::getScale	(	device	,
		action
	)

Use the getScale method to get the scale associated with a specific device + action pair.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns 1 if no scale is associated with the specified device + action pair, or the mapping was not found.

See Also: bind, bindCmd

float ActionMap::getScale	(	device	,
		action
	)

Use the getScale method to get the scale associated with a specific device + action pair.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns 1 if no scale is associated with the specified device + action pair, or the mapping was not found.

See Also: bind, bindCmd

bool ActionMap::isInverted	(	device	,
		action
	)

Use the Purpose method to determine if a specific device + action pair in inverted. This only applies to scrolling devices.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns 1 if the mouse (or other scrolling device) is inverted, 0 otherwise.

See Also: bind, bindCmd

bool ActionMap::isInverted	(	device	,
		action
	)

Use the Purpose method to determine if a specific device + action pair in inverted. This only applies to scrolling devices.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: Returns 1 if the mouse (or other scrolling device) is inverted, 0 otherwise.

See Also: bind, bindCmd

void ActionMap::pop ( )

Use the pop method to de-activate an ActionMap and remove it from non-global ActionMap stack.

Returns: No return value.

See Also: push

void ActionMap::pop ( )

Use the pop method to de-activate an ActionMap and remove it from non-global ActionMap stack.

Returns: No return value.

See Also: push

void ActionMap::push ( )

Use the push method to activate an ActionMap and place it at the top of the non-global ActionMap stack.

Returns: No return value.

See Also: pop

void ActionMap::push ( )

Use the push method to activate an ActionMap and place it at the top of the non-global ActionMap stack.

Returns: No return value.

See Also: pop

void ActionMap::save ( )

Use the save method to save an entire action map specification to a file. If append is not specified, or specified as false, fileName will be overwritten, otherwise the action map will be appended to the file.

Parameters

fileName	Full path to file in which to store action map definition.
append	If true, do not overwrite the file, else start from scratch.

Returns: No return value

void ActionMap::save ( )

Use the save method to save an entire action map specification to a file. If append is not specified, or specified as false, fileName will be overwritten, otherwise the action map will be appended to the file.

Parameters

fileName	Full path to file in which to store action map definition.
append	If true, do not overwrite the file, else start from scratch.

Returns: No return value

void ActionMap::unbind	(	device	,
		action
	)

Use the unbind method to remove a previosly specified device + action pair from the action map.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: No return value.

See Also: bind, bindCmd

void ActionMap::unbind	(	device	,
		action
	)

Use the unbind method to remove a previosly specified device + action pair from the action map.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).

Returns: No return value.

See Also: bind, bindCmd

void ActionMap::unbindObj	(	device	,
		action	,
		object
	)

Use the unbind method to remove a previosly specified device + action pair from the action map.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).
object	Explicit object (it defaults to NULL when you call unbind() ).

Returns: No return value.

See Also: bind, bindCmd

void ActionMap::unbindObj	(	device	,
		action	,
		object
	)

Use the unbind method to remove a previosly specified device + action pair from the action map.

Parameters

device	Name of the device to bound to a command (see 'Device Table' below).
action	Name of the action to watch for (see 'Action Table' below).
object	Explicit object (it defaults to NULL when you call unbind() ).

Returns: No return value.

See Also: bind, bindCmd

Member Data Documentation

bool ActionMap::canSaveDynamicFields

string ActionMap::class

Script SuperClass of object.

string ActionMap::internalName

SimObjectPtr ActionMap::parentGroup

Group hierarchy parent of the object.

string ActionMap::superclass

Script Class of object.