pymel.core.animation.characterMap

characterMap(*args, **kwargs)

This command is used to create a correlation between the attributes of 2 or more characters.

Flags:

Long name (short name)		Argument Types	Properties
mapAttr (ma)		unicode, unicode
	In query mode, this flag can be used to query the mapping stored by the specified map node. It returns an array of strings. In non-query mode, this flag can be used to create a mapping between the specified character members. Any previous mapping on the attributes is removed in favor of the newly specified mapping.
mapMethod (mm)		unicode
	This is is valid in create mode only. It specifies how the mapping should be done. Valid options are: “byNodeName”, “byAttrName”, and “byAttrOrder”. “byAttrOrder” is the default. The flags mean the following: “byAttrOrder” maps using the order that the character stores the attributes internally, “byAttrName” uses the attribute name to find a correspondence, “byNodeName” uses the node name *and* the attribute name to find a correspondence.
mapNode (mn)		unicode, unicode
	This flag can be used to map all the attributes on the source node to their matching attributes on the destination node.
mapping (m)		unicode
	This flag is valid in query mode only. It must be used before the query flag with a string argument. It is used for querying the mapping for a particular attribute. A string array is returned.
proposedMapping (pm)		bool
	This flag is valid in query mode only. It is used to get an array of the mapping that the character map would prvide if called with the specified characters and the (optional) specified mappingMethod. If a character map exists on the characters, the map is not affected by the query operation. A string array is returned.
unmapAttr (ua)		unicode, unicode
	This flag can be used to unmap the mapping stored by the specified map node.
unmapNode (umn)		unicode, unicode
	This flag can be used to unmap all the attributes on the source node to their matching attributes on the destination node. Note that mapped attributes which do not have matching names, will not be unmapped.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.characterMap

Example:

import pymel.core as pm

# Create a mapping between character1 and character2, or if a map already
# exists, update the mapping between any unmapped members.
#
pm.characterMap( 'character1', 'character2' )
# Query as to whether a mapping exists between two characters
#
pm.characterMap( 'character1', 'character2', query=True )
# Query which attributes are mapped between two characters
#
pm.characterMap( 'character1', 'character2', query=True, mapAttr=True )
# Delete the mapping between two pairs of attributes. If no mapping
# exists between the attributes, nothing will happen.
#
pm.characterMap( 'character1', 'character2', unmapAttr=('sphere1.tx','sphere2.tx') )
# Add a mapping between two attributes.  Only attributes that
# are members of characters can be mapped.
#
pm.characterMap( 'character1', 'character2', mapAttr=('sphere1.tx','sphere2.tx') )
# Query what attribute(s) are mapped to sphere1.tx between character1 and
# character2
#
pm.characterMap( 'character1', 'character2', mapping='sphere1.tx' )