Go to: Related nodes. Attributes.

The character node is a special type of set. It is used to gather together animatable attributes. These attributes can then be animated in unison when the character is current. Character sets are also used to define a set of attributes that a user wishes to animate using nonlinear animation clips.

Character sets may only contain animatable attributes and other characters (called "subcharacters"). Using subcharacters, it is possible to build hierarchical characters. The character node manages all animation data for the attributes it contains. When a key is set on a character, the animation curves are connected to the character node. The character node passes this animation data through to the character's attributes via connections. When animation clips are created, the character is connected to a clipScheduler node and a clipLibrary node that manage and evaluate the clip data. The clipScheduler node is attached to the character via the clipEvaluate function attribute. When a clip is created on a character, all of the animation curves connected to the character are considered part of the new clip. The animation curves are disconnected from the character and connected to the character's associated clipLibrary node. The clipLibrary acts as a repository where all of the available source clips are held. To move a clip's animation curves back onto the character, the clip can be "activated".
Node name Parents MFn type Compatible function sets
character objectSet kCharacter kBase
kNamedObject
kDependencyNode
kSet
kCharacter

Related nodes

characterMap, animClip, clipLibrary, clipScheduler

Attributes (40)

activeClipConnected, angularClipValues, angularValues, animationMapping, clipEvaluate, clipEvaluate_Hidden, clipEvaluate_Inmap, clipEvaluate_InmapFrom, clipEvaluate_InmapTo, clipEvaluate_Outmap, clipEvaluate_OutmapFrom, clipEvaluate_OutmapTo, clipEvaluate_Raw, clipIndexMap, clipStatePercentEval, clipStatePercentEval_Hidden, clipStatePercentEval_Inmap, clipStatePercentEval_InmapFrom, clipStatePercentEval_InmapTo, clipStatePercentEval_Outmap, clipStatePercentEval_OutmapFrom, clipStatePercentEval_OutmapTo, clipStatePercentEval_Raw, evalCharacterKeys, linearClipValues, linearValues, offsetNode, offsetObjectLocalXForm, offsetObjects, referenceMapping, timeClipValues, timeValues, timelineClipEnd, timelineClipStart, translationOffsetIndexX, translationOffsetIndices, translationOffsetY, translationOffsetZ, unitlessClipValues, unitlessValues

Long name (short name) Type Default Flags
clipEvaluate (ce) compound n/a outputinputconnectablestorable
The clip function gets connected to the clip manager who controls it. The character calls the clip function to evaluate the clip. If there is no clip manager, the character plays the default clip.
clipEvaluate_Hidden (ceh) function NULL outputinputhidden
For Internal Use Only
Function being applied at this attribute with the mappings cached for efficiency
clipEvaluate_Raw (cer) function NULL outputinputconnectable
For Internal Use Only
Actual function being applied at this attribute
clipEvaluate_Inmap (cei) compound n/a arrayoutputinputconnectablestorable
For Internal Use Only
Mapping of node's function input parameters to function data input parameters
clipEvaluate_InmapTo (ceit) short 0 outputinputconnectablestorable
For Internal Use Only
Node's internal function input parameter index
clipEvaluate_InmapFrom (ceif) short 0 outputinputconnectablestorable
For Internal Use Only
Function data input parameter index
clipEvaluate_Outmap (ceo) compound n/a arrayoutputinputconnectablestorable
For Internal Use Only
Mapping of node's function output parameters to function data output parameters
clipEvaluate_OutmapTo (ceot) short 0 outputinputconnectablestorable
For Internal Use Only
Node's internal function output parameter index
clipEvaluate_OutmapFrom (ceof) short 0 outputinputconnectablestorable
For Internal Use Only
Function data output parameter index
clipStatePercentEval (cspe) compound n/a outputinputconnectablestorablehidden
The clip function gets connected to the clip manager who controls it. The character calls the clip function to evaluate a single clip at a given percentage varying from 0.0 to 1.0. If no clip manager exists, the character plays the default clip.
clipStatePercentEval_Hidden (cspeh) function NULL outputinputhidden
For Internal Use Only
Function being applied at this attribute with the mappings cached for efficiency
clipStatePercentEval_Raw (csper) function NULL outputinputconnectable
For Internal Use Only
Actual function being applied at this attribute
clipStatePercentEval_Inmap (cspei) compound n/a arrayoutputinputconnectablestorable
For Internal Use Only
Mapping of node's function input parameters to function data input parameters
clipStatePercentEval_InmapTo (cspeit) short 0 outputinputconnectablestorable
For Internal Use Only
Node's internal function input parameter index
clipStatePercentEval_InmapFrom (cspeif) short 0 outputinputconnectablestorable
For Internal Use Only
Function data input parameter index
clipStatePercentEval_Outmap (cspeo) compound n/a arrayoutputinputconnectablestorable
For Internal Use Only
Mapping of node's function output parameters to function data output parameters
clipStatePercentEval_OutmapTo (cspeot) short 0 outputinputconnectablestorable
For Internal Use Only
Node's internal function output parameter index
clipStatePercentEval_OutmapFrom (cspeof) short 0 outputinputconnectablestorable
For Internal Use Only
Function data output parameter index
unitlessValues (uv) double 0.0 arrayoutputinputconnectablestorablekeyable
stores the character's animation data that is of type double
linearValues (lv) distance (double) 0.0cm arrayoutputinputconnectablestorablekeyable
stores the character's animation data that is of type linear
angularValues (av) angle (double) 0.0deg arrayoutputinputconnectablestorablekeyable
stores the character's animation data that is of type angle
timeValues (tv) time 0film arrayoutputinputconnectablestorablekeyable
stores the character's animation data that is of type time
unitlessClipValues (uc) double 0.0 arrayoutputinput
stores the character's clip data that is of type double
linearClipValues (lc) distance (double) 0.0cm arrayoutputinput
stores the character's clip data that is of type linear
angularClipValues (ac) angle (double) 0.0deg arrayoutputinput
stores the character's clip data that is of type angle
timeClipValues (tc) time 0film arrayoutputinput
stores the character's clip data that is of type time
animationMapping (am) characterMapping NULL outputinputconnectablestorablehidden
stores the mapping of set members to their animation data
referenceMapping (rm) characterMapping NULL outputinputconnectablestorablehidden
Stores the mapping of set members to their animation data when the character was referenced. This is used so that if the character contents change later, the animation can be connected to the proper location.
clipIndexMap (cim) intArray empty outputinputstorable
Stores a map between the internal character member index and the index used by the clip scheduler. This attribute is only used when the character is clip-driven.
offsetObjects (ofo) Message n/a arrayinputconnectable
This attribute is used to keep track of offset objects. A connection to the message attribute on any character node indicates that it should be used when calculating and storing offsets between clips.
offsetObjectLocalXForm (oolx) matrix identity outputinputconnectablestorablehidden
This attribute holds the offset object current local xform matrix in order for clip rotation offsets to consider possible pre/post rotations.
activeClipConnected (acc) bool 0 outputinputstorable
When this attribute is on, the character is driven only by the clips. Any keyframes connected to the character, are assumed to be from the active clip.
evalCharacterKeys (eck) bool 1 outputinputstorablehidden
When this attribute is on and the character is driven by clips any keyframes connected to the character will also be considered.
timelineClipStart (tcs) time 0film outputinputstorable
When there are keys on the character, this attribute controls the start of the portion of the timeline range that is considered a clip. This attribute is automatically recomputed every time a key is added, removed, or modified on the character.
timelineClipEnd (tce) time 0film outputinputstorable
When there are keys on the character, this attribute controls the end of the portion of the timeline range that is considered a clip. This attribute is automatically recomputed every time a key is added, removed, or modified on the character.
offsetNode (ofn) Message n/a outputinputconnectablehidden
A connection to the characterOffset node (if there is one).
translationOffsetIndices (toi) compound n/a outputinputconnectablestorablehidden
Indices for the offset object X, Y, and Z translation channels
translationOffsetIndexX (tox) integer -1 outputinputconnectablestorablehidden
Index for the offset object X translation channel
translationOffsetY (toy) integer -1 outputinputconnectablestorablehidden
Index for the offset object Y translation channel
translationOffsetZ (toz) integer -1 outputinputconnectablestorablehidden
Index for the offset object Z translation channel