class MFnCharacter

Jump to documentation

: public MFnSet Function Set for Characters (OpenMayaAnim) (OpenMayaAnim.py)

Inheritance:

MFnCharacter < MFnSet < MFnDependencyNode < MFnBase

public members:

MFnCharacter ()
MFnCharacter ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnCharacter ()
virtual MFn::Type type () const
MStatus attachSourceToCharacter ( MObject & sourceClip, MDGModifier & dgMod)
MStatus attachInstanceToCharacter ( MObject & instanceClip, MDGModifier & dgMod)
MStatus addCurveToClip ( MObject & curve, MObject & sourceClip, MPlug & characterPlug, MDGModifier & dgMod)
MObject createBlend ( MObject & instancedClip1, MObject & instancedClip2, MObject & blendAnimCurve, MDGModifier & dgMod, MStatus *ReturnStatus = NULL)
bool blendExists ( MObject & instancedClip1, MObject & instancedClip2, MObject & blendResult)
bool removeBlend ( MObject & instancedClip1, MObject & instancedClip2, MDGModifier & dgMod, MStatus * ReturnStatus = NULL)
bool getCharacterThatOwnsPlug ( MPlug & plug, MObject & result) const
MStatus getMemberPlugs ( MPlugArray & result) const
MStatus getSubCharacters ( MSelectionList & result) const
MObject getClipScheduler ( MStatus * ReturnStatus = NULL)
int getScheduledClipCount ( MStatus * ReturnStatus = NULL)
MObject getScheduledClip (int index, MStatus * ReturnStatus = NULL)
int getSourceClipCount ( MStatus * ReturnStatus = NULL)
MObject getSourceClip (int index, MStatus * ReturnStatus = NULL)
int getBlendCount ( MStatus * ReturnStatus = NULL)
MObject getBlend (int index, MStatus * ReturnStatus = NULL)
MStatus getBlendClips (int index, MObject & clip1, MObject & clip2)
MFnCharacter ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnSet:

public members:

virtual MFn::Type type () const
enum Restriction
kNone
kVerticesOnly
kEdgesOnly
kFacetsOnly
kEditPointsOnly
kRenderableOnly
MObject create ( const MSelectionList & members, Restriction restriction = kNone , MStatus * ReturnStatus = NULL )
MStatus getUnion ( const MObject & withSet, MSelectionList & result )
MStatus getUnion ( const MObjectArray & setList, MSelectionList & result )
MStatus getIntersection ( const MObject & withSet, MSelectionList & result )
MStatus getIntersection ( const MObjectArray & setList, MSelectionList & result )
MStatus clear ()
MStatus getMembers ( MSelectionList &members, bool flatten ) const
MStatus addMember ( const MObject &obj )
MStatus addMember ( const MDagPath &obj, const MObject &component = MObject::kNullObj )
MStatus addMember ( const MPlug &plug )
MStatus addMembers ( const MSelectionList &list )
MStatus removeMember ( const MObject &obj )
MStatus removeMember ( const MDagPath &obj, const MObject &component )
MStatus removeMember ( const MPlug &plug )
MStatus removeMembers ( const MSelectionList &list )
bool isMember ( const MObject &object, MStatus * ReturnStatus = NULL ) const
bool isMember ( const MDagPath &object, const MObject &component = MObject::kNullObj , MStatus * ReturnStatus = NULL ) const
bool isMember ( const MPlug &plug, MStatus * ReturnStatus = NULL ) const
bool intersectsWith ( const MObject & otherSet, MStatus * ReturnStatus = NULL ) const
bool hasRestrictions ( MStatus * ReturnStatus = NULL ) const
Restriction restriction ( MStatus * ReturnStatus = NULL ) const
MString annotation ( MStatus * ReturnStatus = NULL ) const
MStatus setAnnotation ( const MString & annotation )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type type () const
enum MAttrClass
kGlobalDynamicAttr
kLocalDynamicAttr
MObject create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId typeId ( MStatus * ReturnStatus = NULL ) const
MString typeName ( MStatus * ReturnStatus = NULL ) const
MString name ( MStatus * ReturnStatus = NULL ) const
MString setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus getConnections ( MPlugArray & array ) const
unsigned int attributeCount ( MStatus * ReturnStatus=NULL) const
MObject attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode * userNode ( MStatus * ReturnStatus=NULL ) const
bool isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool isShared ( MStatus * ReturnStatus=NULL) const
bool hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString parentNamespace ( MStatus * ReturnStatus=NULL) const
bool isLocked ( MStatus * ReturnStatus=NULL) const
MStatus setLocked ( bool locked )
static MString classification ( const MString & nodeTypeName )
bool isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus deallocateAllFlags (const MString pluginName)
MStatus setFlag (unsigned int flag, bool state)
bool isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus setDoNotWrite ( bool flag )
bool canBeWritten ( MStatus * ReturnStatus=NULL) const
bool hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
public
bool getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

Function set for characters
Description

Maya offers "character" nodes to simplify the setting of keyframes on collections of attributes. The implementation of the "character" is a sub-class of MFnSet taking advantage of the fact that attributes can be represented as MObjects and can be made members of a set. The fact that sets also derive from MObject means that characters may have other character sets as members thus establishing a hierarchy. Only attributes and characters can be members of a character set. The character node will disallow the addition of other objects to its set.

Character sets are also part of a partition, meaning that membership of character sets cannot overlap with other character sets. Thus, when an attribute already in a character is added to another character it must be removed from the original character.

Characters are integral to Maya's nonlinear animation system, "Trax". Trax allows the user to create "animation clips", which bundle a set of animation curves so that they can be reused multiple times, with different timing then the original clip. When a clip is created, Maya finds the the animation curves that are attached to the attributes in the character set and moves those animation curves into the newly created clip. The MFnClip function set is the Maya function set for clips.

Clips in maya can be of two types: source clips and scheduled clips. In the Maya UI, source clips are visible in the Visor while scheduled clips are visible in Trax. A source clip contains the animation curves for the clip. An scheduled clip contains data about the placement of an instance of a source clip in the Maya timeline. In this context, an "instance" means that the animation curves from the source clip are shared by the scheduled clip. Scheduled clips never contain their own animation curves, they always refer to a source clip's curves.

For example, if you create a clip called "run" in maya that lasts from frames 1-20, a source clip node will be created with a start of 1, a duration of 19, and dependency graph connections to all of the animation curves that make up the "run". If you then place an instance of the run clip at frame 5 and another instance of the run clip at frame 20, you have 2 scheduled clips: one with a start frame of 5 and one with a start frame of 20. As mentioned in the previous paragraph, only a single set of animation curves exist for the run regardless of the number of times the run is scheduled.

Trax also allows you to create "blends" between clips, which enable you to control the transition between the clips. A blend is represented in the dependency graph by an "animBlendInOut" node, which uses an animation curve to determine the transition type.

In the dependency graph, when a character has animation clips, the character node will always be connected to a "clipLibrary" node and a "clipScheduler" node. The clipLibrary node is connected to all of the source clips and their animation curves. The clipScheduler node is connected to the scheduled clips and blends. It is the clipScheduler that computes the final animation by looking at the placement and overlap of the clips and feeding the attribute data back into the character set.

Functions

MFnCharacter:: MFnCharacter ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnCharacter:: MFnCharacter ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnCharacter:: MFnCharacter ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnCharacter:: ~MFnCharacter ()

Description

The class destructor.

MFn::Type MFnCharacter:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kCharacter

MStatus MFnCharacter:: getMemberPlugs ( MPlugArray & result) const

Description

Get the members of the character set that are attributes. Return them as a plug array. A character set can contain only attributes and subcharacters. To get all of the members of the character, use MFnSet::getMembers. To get the subcharacters, use MFnCharacter::getSubcharacters.

Arguments

  • result storage for the returned list of members

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object
  • MS::kInsufficientMemory out of memory

MStatus MFnCharacter:: getSubCharacters ( MSelectionList & result) const

Description

Get a list of the subcharacters that are members of the character set.

Arguments

  • result storage for the returned list of members

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object
  • MS::kInsufficientMemory out of memory

MStatus MFnCharacter:: attachSourceToCharacter ( MObject & sourceClip, MDGModifier & dgMod)

Description

Attaches a given source clip node (created using MFnClip::createSourceClip) to the character's clipLibrary. Attaches a clipLibrary and clipScheduler to the character if they are not attached already.

Arguments

  • sourceClip source clip to be attached
  • dgMod command modifier used for undo and redo

Return Value

  • the return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed
  • MS::kInsufficientMemory out of memory

MStatus MFnCharacter:: attachInstanceToCharacter ( MObject & instanceClip, MDGModifier & dgMod)

Description

Attaches an instance of a clip to the character. If the source clip related to the clip instance is not already attached to the character, it will be attached as well.

This command will fail if the instanced clip passed in is not associated with a source clip. The best way to associate an instanced clip with a source clip is to create the instanced clip using MFnClip::createInstancedClip.

Arguments

  • instanceClip the animClip node representing the clipInstance
  • dgMod command modifier used for undo and redo

Return Value

  • the return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed
  • MS::kInsufficientMemory out of memory

MStatus MFnCharacter:: addCurveToClip ( MObject & curve, MObject & sourceClip, MPlug & plug, MDGModifier & dgMod)

Description

Adds an animation curve to a clip. The user must provide the animation curve, and the related source clip node (typically created using MFnCharacter::createSourceClip). The user must also specify the plug that the clip will drive. The plug must be a member of the character managed by this MFnCharacter.

Arguments

  • curve the animation curve to be added to the clip
  • sourceClip a source clip specifying the start and duratiohn of the clip
  • plug plug that this animCurve will drive
  • dgMod command modifier used for undo and redo

Return Value

  • the return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed
  • MS::kInsufficientMemory out of memory

MObject MFnCharacter:: createBlend ( MObject & instancedClip1, MObject & instancedClip2, MObject & blendAnimCurve, MDGModifier & dgMod, MStatus * ReturnStatus )

Description

Creates a blend between two instanced clips on the character. The blend is defined by a specified paramCurve, which should be keyed between times of 0 and 1. Time 0 corresponds to the start time of the blend. Time 1 corresponds to the end time of the blend. The blend will be performed on the clips according to the keyed value of the blend curve, using the equation: (value)*clip1 + (1-value)*clip2. For example, let's say the blend curve goes from a value of (0,0) to (1,1). At the start of the blend you will have 100% of clip1, and 0% of clip2. At the end of the blend you will have 0% of clip1, and 100% of clip2.

Arguments

  • instancedClip1 clip to be blended
  • instancedClip2 another clip to be blended
  • blendAnimCurve animCurve defining the type of the blend
  • dgMod command modifier used for undo and redo
  • ReturnStatus return status

Return Value

  • the resulting animBlend node

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed
  • MS::kInsufficientMemory out of memory

bool MFnCharacter:: blendExists ( MObject & instancedClip1, MObject & instancedClip2, MObject & blendResult)

Description

Return true if a blend exists between the two instanced clips on the character. If a blend exists, the animBlend node related to the blend is also returned.

Arguments

  • instancedClip1 clip
  • instancedClip2 another clip
  • blendResult the blend, if a blend is found

Return Value

  • true, if a blend was found between the two clips

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure operation failed
  • MS::kInsufficientMemory out of memory

bool MFnCharacter:: removeBlend ( MObject & instancedClip1, MObject & instancedClip2, MDGModifier & dgMod, MStatus * ReturnStatus )

Description

Remove the blend between the two instanced clips on the character. If a blend exists and was deleted, returns true. If a blend did not exist, returns false.

Arguments

  • instancedClip1 clip
  • instancedClip2 another clip
  • dgMod command modifier used for undo and redo
  • ReturnStatus the return status

Return Value

  • true, if a blend was found and deleted

MObject MFnCharacter:: getClipScheduler ( MStatus * ReturnStatus )

Description

Get the clipScheduler node that manages the playback of clips on this character. If no clips have been created for this character, this method will return an empty MObject.

Arguments

  • ReturnStatus return status

Return Value

  • MObject containing a clipScheduler node

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object

bool MFnCharacter:: getCharacterThatOwnsPlug ( MPlug & plug, MObject & result) const

Description

Given a plug, test the plug to see if it is owned by a character. If a character controls this plug, the character will be returned

Arguments

  • plug MPlug containing a plug for which you want to find the related character
  • result Mobject containing a character if the plug is in a character, else an empty MObject

Return Value

  • true, if the plug is in a character

int MFnCharacter:: getScheduledClipCount ( MStatus * ReturnStatus )

Description

Return the number of clips that have been scheduled on this character.

Arguments

  • ReturnStatus return status

Return Value

  • number of clips scheduled on this character

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object

MObject MFnCharacter:: getScheduledClip (int index, MStatus * ReturnStatus )

Description

Return the scheduled animClip node corresponding to the specified index. The specified index should range from 0 to clipCount-1 where clipCount is the value returned by MFnCharacter::getScheduledClipCount.

Arguments

  • ReturnStatus return status

Return Value

  • MObject containing an animClip node

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object
  • MS::kIndexOutOfRange this index given exceeded the total clip count
  • MS::kObjectDoesNotExist the clip node for this index does not exist, indicates a missing connection in the dependency graph

int MFnCharacter:: getSourceClipCount ( MStatus * ReturnStatus )

Description

Return the number of source clips managed by the clipLibrary node of this character. For more information on source clips, refer to the description of the MFnCharacter node.

Arguments

  • ReturnStatus return status

Return Value

  • number of source clips owned by the library on this character

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object

MObject MFnCharacter:: getSourceClip (int index, MStatus * ReturnStatus )

Description

Return the animClip node corresponding to the specified index. The animClip node will be a source clip node. The specified index should range from 0 to clipCount-1 where clipCount is the value returned by MFnCharacter::getSourceClipCount.

Arguments

  • ReturnStatus return status

Return Value

  • MObject containing an animClip node

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object
  • MS::kIndexOutOfRange this index given exceeded the total clip count
  • MS::kObjectDoesNotExist the clip node for this index does not exist, indicates a missing connection in the dependency graph

int MFnCharacter:: getBlendCount ( MStatus * ReturnStatus )

Description

Return the number of blends that have been added to clips on this character.

Arguments

  • ReturnStatus return status

Return Value

  • number of blends on clips in this character

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object

MObject MFnCharacter:: getBlend (int index, MStatus * ReturnStatus )

Description

Return the animBlendInOut node corresponding to the specified index.

Arguments

  • ReturnStatus return status

Return Value

  • MObject containing an animBlendInOut node

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object
  • MS::kIndexOutOfRange this index given exceeded the total blend count
  • MS::kObjectDoesNotExist the blend node for this index does not exist, indicates a missing connection in the dependency graph or that no blend exists

MStatus MFnCharacter:: getBlendClips (int index, MObject & clip1, MObject & clip2)

Description

Returns the clip nodes that are blended by the blend node corresponding to the specified index.

Arguments

  • index the index of the blend
  • clip1 the first of the clips being blended
  • clip2 the second of the clips being blended

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure this function set does not have a valid character object
  • MS::kIndexOutOfRange this index given exceeded the total blend count
  • MS::kObjectDoesNotExist the clip nodes for this index do not exist, indicates a missing connection in the dependency graph or an invalid blend

This class has no child classes.

Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright