Function Set for Characters. More...

#include <MFnCharacter.h>

Inheritance diagram for MFnCharacter:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnCharacter ()
	Destructor.

	MFnCharacter ()
	Default constructor.

	MFnCharacter (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MStatus	attachSourceToCharacter (MObject &sourceClip, MDGModifier &dgMod)
	Attaches a given source clip node (created using MFnClip::createSourceClip) to the character's clipLibrary. More...

MStatus	attachInstanceToCharacter (MObject &instanceClip, MDGModifier &dgMod)
	Attaches an instance of a clip to the character. More...

MStatus	addCurveToClip (MObject &curve, MObject &sourceClip, MPlug &characterPlug, MDGModifier &dgMod)
	Adds an animation curve to a clip. More...

MObject	createBlend (MObject &instancedClip1, MObject &instancedClip2, MObject &blendAnimCurve, MDGModifier &dgMod, MStatus *ReturnStatus=NULL)
	Creates a blend between two instanced clips on the character. More...

bool	blendExists (MObject &instancedClip1, MObject &instancedClip2, MObject &blendResult)
	Return true if a blend exists between the two instanced clips on the character. More...

bool	removeBlend (MObject &instancedClip1, MObject &instancedClip2, MDGModifier &dgMod, MStatus *ReturnStatus=NULL)
	Remove the blend between the two instanced clips on the character. More...

bool	getCharacterThatOwnsPlug (MPlug &plug, MObject &result) const
	Given a plug, test the plug to see if it is owned by a character. More...

MStatus	getMemberPlugs (MPlugArray &result) const
	Get the members of the character set that are attributes. More...

MStatus	getSubCharacters (MSelectionList &result) const
	Get a list of the subcharacters that are members of the character set. More...

MObject	getClipScheduler (MStatus *ReturnStatus=NULL)
	Get the clipScheduler node that manages the playback of clips on this character. More...

int	getScheduledClipCount (MStatus *ReturnStatus=NULL)
	Return the number of clips that have been scheduled on this character. More...

MObject	getScheduledClip (int index, MStatus *ReturnStatus=NULL)
	Return the scheduled animClip node corresponding to the specified index. More...

int	getSourceClipCount (MStatus *ReturnStatus=NULL)
	Return the number of source clips managed by the clipLibrary node of this character. More...

MObject	getSourceClip (int index, MStatus *ReturnStatus=NULL)
	Return the animClip node corresponding to the specified index. More...

int	getBlendCount (MStatus *ReturnStatus=NULL)
	Return the number of blends that have been added to clips on this character. More...

MObject	getBlend (int index, MStatus *ReturnStatus=NULL)
	Return the animBlendInOut node corresponding to the specified index. More...

MStatus	getBlendClips (int index, MObject &clip1, MObject &clip2)
	Returns the clip nodes that are blended by the blend node corresponding to the specified index. More...

	MFnCharacter (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnSet
virtual	~MFnSet ()
	Destructor.

	MFnSet ()
	Default constructor.

	MFnSet (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (const MSelectionList &members, Restriction restriction=kNone, MStatus *ReturnStatus=NULL)
	Creates a new set dependency node and puts it in the dependency graph. More...

MStatus	getUnion (const MObject &withSet, MSelectionList &result)
	This method calculates the union of two sets. More...

MStatus	getUnion (const MObjectArray &setList, MSelectionList &result)
	This method calculates the union of a list of sets. More...

MStatus	getIntersection (const MObject &withSet, MSelectionList &result)
	This method calculates the intersection of two sets. More...

MStatus	getIntersection (const MObjectArray &setList, MSelectionList &result)
	This method calculates the intersection of a list of sets. More...

MStatus	clear ()
	Removes all elements from this set. More...

MStatus	getMembers (MSelectionList &members, bool flatten) const
	Get the members of this set as a selection list. More...

MStatus	addMember (const MObject &obj)
	Add a new object (dependency node) to the set. More...

MStatus	addMember (const MDagPath &obj, const MObject &component=MObject::kNullObj)
	Add a new object (DAG node) to the set. More...

MStatus	addMember (const MPlug &plug)
	Add a new plug to the set. More...

MStatus	addMembers (const MSelectionList &list)
	Add a list of new objects to the set. More...

MStatus	removeMember (const MObject &obj)
	Remove an object (dependency node) from the set. More...

MStatus	removeMember (const MDagPath &obj, const MObject &component)
	Remove an object (DAG node) from the set. More...

MStatus	removeMember (const MPlug &plug)
	Remove an plug from the set. More...

MStatus	removeMembers (const MSelectionList &list)
	Remove items of the selection list from the set. More...

bool	isMember (const MObject &object, MStatus *ReturnStatus=NULL) const
	Returns true if the given object (dependency node) is a member of this set. More...

bool	isMember (const MDagPath &object, const MObject &component=MObject::kNullObj, MStatus *ReturnStatus=NULL) const
	Returns true if the given object (DAG node) is a member of this set. More...

bool	isMember (const MPlug &plug, MStatus *ReturnStatus=NULL) const
	Returns true if the given plug is a member of this set. More...

bool	intersectsWith (const MObject &otherSet, MStatus *ReturnStatus=NULL) const
	Returns true if this set intersects with the given set. More...

bool	hasRestrictions (MStatus *ReturnStatus=NULL) const
	Returns true if this function set has restrictions on the type of objects that it may contain. More...

Restriction	restriction (MStatus *ReturnStatus=NULL) const
	Returns the type of membership restriction that this set has. More...

MString	annotation (MStatus *ReturnStatus=NULL) const
	Returns the annotation string for this set. More...

MStatus	setAnnotation (const MString &annotation)
	Sets the annotation string for this set. More...

MStatus	getMemberPaths (MDagPathArray &members, bool shading=false) const
	Introduced in 2023.0 More...

	MFnSet (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnDependencyNode
virtual	~MFnDependencyNode ()
	Destructor.

	MFnDependencyNode ()
	Default constructor.

	MFnDependencyNode (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (const MTypeId &typeId, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type tag. More...

MObject	create (const MTypeId &typeId, const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type tag. More...

MObject	create (const MString &type, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type. More...

MObject	create (const MString &type, const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type. More...

MTypeId	typeId (MStatus *ReturnStatus=NULL) const
	Returns the type id of this node. More...

MString	typeName (MStatus *ReturnStatus=NULL) const
	Returns the type name of this node. More...

MString	name (MStatus *ReturnStatus=NULL) const
	Returns the name of this node. More...

MString	absoluteName (MStatus *ReturnStatus=NULL) const
	Returns the absolute name of this node. More...

MString	uniqueName (MStatus *ReturnStatus=NULL) const
	Introduced in 2023.0 More...

MString	pluginName (MStatus *ReturnStatus=NULL) const
	Returns the name of the plug-in this MFnDependendencyNode was defined in. More...

MString	setName (const MString &name, bool createNamespace=false, MStatus *ReturnStatus=NULL)
	Sets the name of this node. More...

MUuid	uuid (MStatus *ReturnStatus=NULL) const
	Returns the node's UUID. More...

void	setUuid (const MUuid &uuid, MStatus *ReturnStatus=NULL)
	Sets the node's UUID. More...

MStatus	getConnections (MPlugArray &array) const
	Get all of the current connections to this node as an array of plugs. More...

unsigned int	attributeCount (MStatus *ReturnStatus=NULL) const
	Returns the number of attributes that this node has. More...

MObject	attribute (unsigned int index, MStatus *ReturnStatus=NULL) const
	Finds the attribute of this node at the given index. More...

MObject	reorderedAttribute (unsigned int index, MStatus *ReturnStatus=NULL) const
	Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation. More...

MObject	attribute (const MString &attrName, MStatus *ReturnStatus=NULL) const
	Finds the attribute of this node that has the given name. More...

MAttrClass	attributeClass (const MObject &attr, MStatus *ReturnStatus=NULL) const
	Returns the class (normal, dynamic, extension) of the specified attribute. More...

MStatus	getAffectedAttributes (const MObject &attr, MObjectArray &affectedAttributes) const
	Returns an array of attributes that are affected by the attribute passed in. More...

MStatus	getAffectedByAttributes (const MObject &attr, MObjectArray &affectedByAttributes) const
	Returns an array of attributes that affect the attribute passed in, attr. More...

MPlug	findPlug (const MObject &attr, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
	Attempt to find a plug for the given attribute. More...

MPlug	findPlug (const MString &attrName, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
	Attempt to find a plug for the given attribute. More...

MPlug	findPlug (const MObject &attr, MStatus *ReturnStatus=NULL) const
	Deprecated in 2019.0 More...

MPlug	findPlug (const MString &attrName, MStatus *ReturnStatus=NULL) const
	Deprecated in 2019.0 More...

MStatus	addAttribute (const MObject &attr)
	Add a new dynamic attibute to this node. More...

MStatus	removeAttribute (const MObject &attr)
	Remove a dynamic attribute from a node. More...

MPxNode *	userNode (MStatus *ReturnStatus=NULL) const
	If the function set's node is a plug-in node, then this method will extract the MPxNode pointer from it. More...

bool	isFromReferencedFile (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node came from a referenced file. More...

bool	isShared (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is shared. More...

bool	isTrackingEdits (MStatus *ReturnStatus=NULL) const
	Returns whether or not edits on the given node are being tracked by the generalized edit system. More...

bool	hasUniqueName (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node's name is unique within the scene. More...

MString	parentNamespace (MStatus *ReturnStatus=NULL) const
	Returns the name of the namespace in which this node resides. More...

bool	isLocked (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is locked. More...

MStatus	setLocked (bool locked)
	Locks or unlocks this node. More...

bool	isNewAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const
	Indicates whether or not the specified attribute was added to this node within the current scene. More...

MStatus	setFlag (unsigned int flag, bool state)
	Sets the state of the specified flag for the node. More...

bool	isFlagSet (unsigned int flag, MStatus *ReturnStatus=NULL) const
	Retrieves the current state of the specified flag for a node. More...

bool	isDefaultNode (MStatus *ReturnStatus=NULL) const
	Returns true if the node is a default node. More...

MStatus	setDoNotWrite (bool flag)
	Use this method to mark the "do not write" state of this node. More...

bool	canBeWritten (MStatus *ReturnStatus=NULL) const
	Returns the do not write state of the node. More...

bool	hasAttribute (const MString &name, MStatus *ReturnStatus=NULL) const
	Returns true if the node already has an attribute with the given name. More...

MObject	getAliasAttr (bool force, MStatus *ReturnStatus=NULL)
	Returns the node's alias attribute, which is a special attribute used to store information about the node's attribute aliases. More...

bool	setAlias (const MString &alias, const MString &name, const MPlug &plug, bool add=true, MStatus *ReturnStatus=NULL)
	Sets or removes an alias (i.e. More...

bool	findAlias (const MString &alias, MObject &attrObj, MStatus *ReturnStatus=NULL) const
	Retrieves the attribute with the given alias. More...

bool	getAliasList (MStringArray &strArray, MStatus *ReturnStatus=NULL)
	Returns a list of all attribute aliases for this node. More...

MString	plugsAlias (const MPlug &plug, MStatus *ReturnStatus=NULL)
	Returns the alias for the plug's attribute or the empty string if that attribute has no alias. More...

MStatus	setIcon (const MString &filename)
	Associates a custom icon with the node for display in the Maya UI. More...

MString	icon (MStatus *ReturnStatus=NULL) const
	Returns the custom icon filename associated with the node. More...

MStatus	getExternalContent (MExternalContentInfoTable &table) const
	Returns the external content (files) that this node depends on. More...

MStatus	addExternalContentForFileAttr (MExternalContentInfoTable &table, const MObject &attr) const
	Adds content info to the specified table from a file path attribute. More...

MStatus	setExternalContentForFileAttr (const MObject &attr, const MExternalContentLocationTable &table)
	Sets content info in the specified attribute from the table. More...

MStatus	setExternalContent (const MExternalContentLocationTable &table)
	Changes the location of external content. More...

bool	affectsAnimation (MStatus *ReturnStatus=NULL) const
	Introduced in 2019.0 More...

MStatus	setAffectsAnimation ()
	Introduced in 2019.0 More...

MString	setName (const MString &name, MStatus *ReturnStatus)
	Deprecated in 2019.0 More...

	MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL)
	Not available in Python. More...

bool	getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL)
	Not available in Python. More...

virtual const adsk::Data::Associations *	metadata (MStatus *ReturnStatus=NULL) const
	Not available in Python. More...

virtual MStatus	setMetadata (const adsk::Data::Associations &)
	Not available in Python. More...

virtual MStatus	deleteMetadata ()
	Not available in Python. More...

virtual MStatus	validateMetadata (MString &errors) const
	Not available in Python. More...

MStatus	dgTimerOn ()
	Indicates that this node should collect DG timing data whenever DG timing is enabled. More...

MStatus	dgTimerOff ()
	Indicates that this node should no longer collect DG timing data when DG timing is enabled. More...

MdgTimerState	dgTimerQueryState (MStatus *ReturnStatus=NULL)
	The function returns the current on/off state of the node's timer. More...

MStatus	dgTimerReset ()
	The function resets the dependency graph timers and counters for this node to zero. More...

double	dgTimer (const MdgTimerMetric timerMetric, const MdgTimerType timerType, MStatus *ReturnStatus=NULL) const
	The function returns the specified timer value for the current node. More...

MStatus	dgCallbacks (const MdgTimerType type, MStringArray &callbackName, MDoubleArray &value)
	Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method. More...

MStatus	dgCallbackIds (const MdgTimerType type, const MString &callbackName, MCallbackIdArray &callbackId, MDoubleArray &value)
	This method provides a further breakdown of the per-callback time returned via dgCallbacks() by returning the data on a per-callbackId basis. More...

MStatus	addAttribute (const MObject &attr, MAttrClass type)
	Deprecated in 2019.0 More...

MStatus	removeAttribute (const MObject &attr, MAttrClass type)
	Deprecated in 2019.0 More...

Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...

bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

MObject	object (MStatus *ReturnStatus=nullptr) const
	Returns the MObject that is attached to the Function Set. More...

virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...

virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Static Public Member Functions inherited from MFnSet
static const char *	className ()
	Returns the name of this class. More...

Static Public Member Functions inherited from MFnDependencyNode
static const char *	className ()
	Returns the name of this class. More...

static MString	classification (const MString &nodeTypeName)
	Retrieves the classification string for a node type. More...

static unsigned int	allocateFlag (const MString pluginName, MStatus *ReturnStatus=NULL)
	Allocates a node flag for sole use by the caller. More...

static MStatus	deallocateFlag (const MString pluginName, unsigned int flag)
	Deallocates a node flag which was previously allocated by a call to allocateFlag. More...

static MStatus	deallocateAllFlags (const MString pluginName)
	Deallocates all of the node flags which are currently allocated to the specified plugin. More...

static void	enableDGTiming (bool enable)
	Globally enables or disables the DG node timing mechanism. More...

Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

static const char *	typeString (MFn::Type)
	Introduced in 2020.0 More...

static bool	isValid (MFn::Type)
	Introduced in 2020.0 More...

Additional Inherited Members
Public Types inherited from MFnSet
enum	Restriction { kNone, kVerticesOnly, kEdgesOnly, kFacetsOnly, kEditPointsOnly, kRenderableOnly }
	Set membership restrictions. More...

Public Types inherited from MFnDependencyNode
enum	MAttrClass { kLocalDynamicAttr = 1, kNormalAttr, kExtensionAttr, kInvalidAttr }
	Specifies the scope of the attribute. More...

enum	MdgTimerState { kTimerOff, kTimerOn, kTimerUninitialized, kTimerInvalidState }
	Possible states for the node's timer. More...

enum	MdgTimerMetric { kTimerMetric_callback, kTimerMetric_compute, kTimerMetric_dirty, kTimerMetric_draw, kTimerMetric_fetch, kTimerMetric_callbackViaAPI, kTimerMetric_callbackNotViaAPI, kTimerMetric_computeDuringCallback, kTimerMetric_computeNotDuringCallback, kTimerMetrics }
	The different timer metrics which can be queried. More...

enum	MdgTimerType { kTimerType_self, kTimerType_inclusive, kTimerType_count, kTimerTypes }
	The types of timers which can be queried. More...

Detailed Description

Function Set for Characters.

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.

Examples:: createClipCmd/createClipCmd.cpp.

Constructor & Destructor Documentation

MFnCharacter	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

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	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

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

Member Function Documentation

MFn::Type type ( ) const

virtual

Function set type.

Return the class type : MFn::kCharacter.

Returns: the class type.

Reimplemented from MFnSet.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )

static

Returns the name of this class.

Return the class name : "MFnCharacter".

Returns: Name of this class.

MStatus attachSourceToCharacter	(	MObject &	sourceClip,
		MDGModifier &	dgMod
	)

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.

Parameters

[in]	sourceClip	source clip to be attached
[in]	dgMod	command modifier used for undo and redo

Returns: The return status

Status Codes:

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

Examples:: createClipCmd/createClipCmd.cpp.

MStatus attachInstanceToCharacter	(	MObject &	instanceClip,
		MDGModifier &	dgMod
	)

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.

Parameters

[in]	instanceClip	the animClip node representing the clipInstance
[in]	dgMod	command modifier used for undo and redo

Returns: The return status

Status Codes:

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

Examples:: createClipCmd/createClipCmd.cpp.

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

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.

Parameters

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

Returns: The return status

Status Codes:

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

Examples:: createClipCmd/createClipCmd.cpp.

MObject createBlend	(	MObject &	instancedClip1,
		MObject &	instancedClip2,
		MObject &	blendAnimCurve,
		MDGModifier &	dgMod,
		MStatus *	ReturnStatus = `NULL`
	)

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.

Parameters

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

Returns: The resulting animBlend node

Status Codes:

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

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

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.

Parameters

[in]	instancedClip1	clip
[in]	instancedClip2	another clip
[in]	blendResult	the blend, if a blend is found

Returns: 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 removeBlend	(	MObject &	instancedClip1,
		MObject &	instancedClip2,
		MDGModifier &	dgMod,
		MStatus *	ReturnStatus = `NULL`
	)

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.

Parameters

[in]	instancedClip1	clip
[in]	instancedClip2	another clip
[in]	dgMod	command modifier used for undo and redo
[out]	ReturnStatus	the return status

Returns: true, if a blend was found and deleted

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

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

Parameters

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

Returns: true, if the plug is in a character

MStatus getMemberPlugs ( MPlugArray & result ) const

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.

Parameters

[out] result storage for the returned list of members

Returns: 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

Examples:: createClipCmd/createClipCmd.cpp.

MStatus getSubCharacters ( MSelectionList & result ) const

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

Parameters

[out] result storage for the returned list of members

Returns: 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

MObject getClipScheduler ( MStatus * ReturnStatus = NULL )

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.

Parameters

[out] ReturnStatus return status

Returns: MObject containing a clipScheduler node

Status Codes:

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

int getScheduledClipCount ( MStatus * ReturnStatus = NULL )

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

Parameters

[out] ReturnStatus return status

Returns: 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 getScheduledClip	(	int	index,
		MStatus *	ReturnStatus = `NULL`
	)

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.

Parameters

[in]	index	Clip index.
[out]	ReturnStatus	return status

Returns: 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 getSourceClipCount ( MStatus * ReturnStatus = NULL )

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.

Parameters

[out] ReturnStatus return status

Returns: 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 getSourceClip	(	int	index,
		MStatus *	ReturnStatus = `NULL`
	)

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.

Parameters

[in]	index	Clip index.
[out]	ReturnStatus	Return status.

Returns: 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 getBlendCount ( MStatus * ReturnStatus = NULL )

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

Parameters

[out] ReturnStatus return status

Returns: 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 getBlend	(	int	index,
		MStatus *	ReturnStatus = `NULL`
	)

Return the animBlendInOut node corresponding to the specified index.

Parameters

[in]	index	Index of the desired node.
[out]	ReturnStatus	return status

Returns: 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 getBlendClips	(	int	index,
		MObject &	clip1,
		MObject &	clip2
	)

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

Parameters

[in]	index	the index of the blend
[out]	clip1	the first of the clips being blended
[out]	clip2	the second of the clips being blended

Returns: 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

The documentation for this class was generated from the following files:

MFnCharacter.h
MFnCharacter.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation