character

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".

Related nodes

characterMap, animClip, clipLibrary, clipScheduler

Attributes (49)

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, copyAngularValues, copyLinearValues, copyTimeValues, copyUnitlessValues, evalCharacterKeys, linearClipValues, linearValues, matchNode, offsetNode, offsetObjectLocalXForm, offsetObjectLocalXForms, offsetObjects, referenceMapping, timeClipValues, timeValues, timelineClipEnd, timelineClipStart, translationOffsetIndexX, translationOffsetIndices, translationOffsetIndicesX, translationOffsetIndicesY, translationOffsetIndicesZ, translationOffsetY, translationOffsetZ, unitlessClipValues, unitlessValues

Long name (short name)	Type	Default	Flags
clipEvaluate (ce)	compound	n/a
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 For Internal Use Only Function being applied at this attribute with the mappings cached for efficiency
clipEvaluate_Raw (cer) function NULL For Internal Use Only Actual function being applied at this attribute
clipEvaluate_Inmap (cei) compound n/a For Internal Use Only Mapping of node's function input parameters to function data input parameters clipEvaluate_InmapTo (ceit) short 0 For Internal Use Only Node's internal function input parameter index clipEvaluate_InmapFrom (ceif) short 0 For Internal Use Only Function data input parameter index
clipEvaluate_Outmap (ceo) compound n/a For Internal Use Only Mapping of node's function output parameters to function data output parameters clipEvaluate_OutmapTo (ceot) short 0 For Internal Use Only Node's internal function output parameter index clipEvaluate_OutmapFrom (ceof) short 0 For Internal Use Only Function data output parameter index
clipStatePercentEval (cspe)	compound	n/a
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 For Internal Use Only Function being applied at this attribute with the mappings cached for efficiency
clipStatePercentEval_Raw (csper) function NULL For Internal Use Only Actual function being applied at this attribute
clipStatePercentEval_Inmap (cspei) compound n/a For Internal Use Only Mapping of node's function input parameters to function data input parameters clipStatePercentEval_InmapTo (cspeit) short 0 For Internal Use Only Node's internal function input parameter index clipStatePercentEval_InmapFrom (cspeif) short 0 For Internal Use Only Function data input parameter index
clipStatePercentEval_Outmap (cspeo) compound n/a For Internal Use Only Mapping of node's function output parameters to function data output parameters clipStatePercentEval_OutmapTo (cspeot) short 0 For Internal Use Only Node's internal function output parameter index clipStatePercentEval_OutmapFrom (cspeof) short 0 For Internal Use Only Function data output parameter index
unitlessValues (uv)	double	0.0
stores the character's animation data that is of type double
linearValues (lv)	distance (double)	0.0cm
stores the character's animation data that is of type linear
angularValues (av)	angle (double)	0.0deg
stores the character's animation data that is of type angle
timeValues (tv)	time	0film
stores the character's animation data that is of type time
unitlessClipValues (uc)	double	0.0
stores the character's clip data that is of type double
linearClipValues (lc)	distance (double)	0.0cm
stores the character's clip data that is of type linear
angularClipValues (ac)	angle (double)	0.0deg
stores the character's clip data that is of type angle
timeClipValues (tc)	time	0film
stores the character's clip data that is of type time
animationMapping (am)	characterMapping	NULL
stores the mapping of set members to their animation data
referenceMapping (rm)	characterMapping	NULL
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
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
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.
offsetObjectLocalXForms (oolxs)	matrix	identity
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
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
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
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
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
A connection to the characterOffset node (if there is one).
translationOffsetIndicesX (toix)	integer	-1
Index for the offset object X translation channel
translationOffsetIndicesY (toiy)	integer	-1
Index for the offset object Y translation channel
translationOffsetIndicesZ (toiz)	integer	-1
Index for the offset object Z translation channel
matchNode (mn)	Message	n/a
This attribute is used to keep track of the current match node when performing clip matching.
copyUnitlessValues (cuv)	double	0.0
Copy of unitlessValues to preserve values during file open, so they can be restored if connected and then disconnected. Used if the character set is referenced (see referenceMapping).
copyLinearValues (clv)	distance (double)	0.0cm
Copy of linearValues to preserve values during file open, so they can be restored if connected and then disconnected. Used if the character set is referenced (see referenceMapping).
copyAngularValues (cav)	angle (double)	0.0deg
Copy of angularValues to preserve values during file open, so they can be restored if connected and then disconnected. Used if the character set is referenced (see referenceMapping).
copyTimeValues (ctv)	time	0film
Copy of timeValues to preserve values during file open, so they can be restored if connected and then disconnected. Used if the character set is referenced (see referenceMapping).
offsetObjectLocalXForm (oolx)	matrix	identity
This attribute is obsolete, it has been replaced by offsetObjectLocalXForms
translationOffsetIndices (toi)	compound	n/a
This attribute is obsolete, it has been replaced by aTranslationOffsetIndicesX, aTranslationOffsetIndicesY and aTranslationOffsetIndicesZ.
translationOffsetIndexX (tox) integer -1 This attribute is obsolete, it has been replaced by aTranslationOffsetIndicesX.
translationOffsetY (toy) integer -1 This attribute is obsolete, it has been replaced by aTranslationOffsetIndicesY.
translationOffsetZ (toz) integer -1 This attribute is obsolete, it has been replaced by aTranslationOffsetIndicesZ.