Detailed Description

Dependency node function set.

MFnDependencyNode allows the creation and manipulation of dependency graph nodes. Traversal of the dependency graph is possible using the getConnections method.

This function set does not support creation or removal of connections. MDGModifier should be used for that purpose.

Examples:: affectsNode.cpp, animExportUtil.cpp, animInfoCmd.cpp, blindComplexDataCmd.cpp, blindDoubleDataCmd.cpp, blindShortDataCmd.cpp, cgfxAttrDef.cpp, cgfxAttrDef.h, cgfxShaderCmd.cpp, cgfxShaderCmd.h, cgfxShaderNode.cpp, closestPointCmd.cpp, closestPointOnCurveCmd.cpp, clothPaintAttrCmd.cpp, componentScaleManip.cpp, customAttrManip.cpp, cvColorNode.cpp, D3DTextureItem.cpp, D3DViewportRenderer.cpp, dagPoseInfoCmd.cpp, deletedMsgCmd.cpp, exportJointClusterDataCmd.cpp, filteredAsciiFile.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, footPrintManip.cpp, getAttrAffectsCmd.cpp, GLSLShaderNode.cpp, GLSLShaderNode.h, hairCollisionSolver.cpp, hwDecalBumpShader_NV20.cpp, hwPhongShaderBehavior.cpp, hwReflectBumpShader_NV20.cpp, hwRefractReflectShader_NV20.cpp, hwToonShader_NV20.cpp, hwUnlitShader.cpp, instancerListCmd.cpp, intersectCmd.cpp, latticeNoiseCmd.cpp, listPolyHolesCmd.cpp, lockEvent.cpp, maTranslator.cpp, meshOpCmd.cpp, motionTraceCmd.cpp, moveManip.cpp, MTextureCache.cpp, narrowPolyViewer.h, nodeCreatedCBCmd.cpp, nodeInfoCmd.cpp, NodeMonitor.cpp, offsetNode.cpp, ownerEmitter.cpp, pluginMain.cpp, pointOnMeshCmd.cpp, polyModifierCmd.cpp, polyPrimitiveCmd.cpp, polyWriter.cpp, rockingTransformCheck.cpp, rotateManip.cpp, ShadingConnection.cpp, simpleEmitter.cpp, simpleFluidEmitter.cpp, slopeShaderBehavior.cpp, splitUVCmd.cpp, squareScaleManipContext.cpp, surfaceBumpManip.cpp, sweptEmitter.cpp, swissArmyManip.cpp, torusField.cpp, and whatisCmd.cpp.

#include <MFnDependencyNode.h>

Inheritance diagram for MFnDependencyNode:

[legend]

List of all members.

Public Types
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 }
	The different timer metrics which can be queried. More...
enum	MdgTimerType { kTimerType_self, kTimerType_inclusive, kTimerType_count }
	The types of timers which can be queried. More...
Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnDependencyNode ()
	Destructor.
	MFnDependencyNode ()
	Default constructor.
	MFnDependencyNode (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
MObject	create (const MTypeId &typeId, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type tag.
MObject	create (const MTypeId &typeId, const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type tag.
MObject	create (const MString &type, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type.
MObject	create (const MString &type, const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type.
MTypeId	typeId (MStatus *ReturnStatus=NULL) const
	Returns the type id of this node.
MString	typeName (MStatus *ReturnStatus=NULL) const
	Returns the type name of this node.
MString	name (MStatus *ReturnStatus=NULL) const
	Returns the name of this node.
MString	pluginName (MStatus *ReturnStatus=NULL) const
	Returns the name of the plug-in this MFnDependendencyNode was defined in.
MString	setName (const MString &name, MStatus *ReturnStatus=NULL)
	Sets the name of this node.
MStatus	getConnections (MPlugArray &array) const
	Get all of the current connections to this node as an array of plugs.
unsigned int	attributeCount (MStatus *ReturnStatus=NULL) const
	Returns the number of attributes that this node has.
MObject	attribute (unsigned int index, MStatus *ReturnStatus=NULL) const
	Finds the attribute of this node at the given index.
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.
MObject	attribute (const MString &attrName, MStatus *ReturnStatus=NULL) const
	Finds the attribute of this node that has the given name.
MAttrClass	attributeClass (const MObject &attr, MStatus *ReturnStatus=NULL) const
	Returns the class (normal, dynamic, extension) of the specified attribute.
MStatus	getAffectedAttributes (const MObject &attr, MObjectArray &affectedAttributes) const
	Returns an array of attributes that are affected by the attribute passed in.
MStatus	getAffectedByAttributes (const MObject &attr, MObjectArray &affectedByAttributes) const
	Returns an array of attributes that affect the attribute passed in, attr.
MPlug	findPlug (const MObject &attr, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
	Attempt to find a plug for the given attribute.
MPlug	findPlug (const MString &attrName, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
	Attempt to find a plug for the given attribute.
MPlug	findPlug (const MObject &attr, MStatus *ReturnStatus=NULL) const
	This method is obsolete.
MPlug	findPlug (const MString &attrName, MStatus *ReturnStatus=NULL) const
	This method is obsolete.
MStatus	addAttribute (const MObject &attr)
	Add a new dynamic attibute to this node.
MStatus	removeAttribute (const MObject &attr)
	Remove a dynamic attribute from a node.
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.
bool	isFromReferencedFile (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node came from a referenced file.
bool	isShared (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is shared.
bool	hasUniqueName (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node's name is unique within the scene.
MString	parentNamespace (MStatus *ReturnStatus=NULL) const
	Returns the name of the namespace in which this node resides.
bool	isLocked (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is locked.
MStatus	setLocked (bool locked)
	Locks or unlocks this node.
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.
MStatus	setFlag (unsigned int flag, bool state)
	Sets the state of the specified flag for the node.
bool	isFlagSet (unsigned int flag, MStatus *ReturnStatus=NULL) const
	Retrieves the current state of the specified flag for a node.
bool	isDefaultNode (MStatus *ReturnStatus=NULL) const
	Returns true if the node is a default node.
MStatus	setDoNotWrite (bool flag)
	Use this method to mark the "do not write" state of this node.
bool	canBeWritten (MStatus *ReturnStatus=NULL) const
	Returns true if the node can be written/exported to scene files.
bool	hasAttribute (const MString &name, MStatus *ReturnStatus=NULL) const
	Returns true if the node already has an attribute with the given name.
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.
bool	setAlias (const MString &alias, const MString &name, const MPlug &plug, bool add=true, MStatus *ReturnStatus=NULL)
	Sets or removes an alias (i.e.
bool	findAlias (const MString &alias, MObject &attrObj, MStatus *ReturnStatus=NULL) const
	Retrieves the attribute with the given alias.
bool	getAliasList (MStringArray &strArray, MStatus *ReturnStatus=NULL)
	Returns a list of all attribute aliases for this node.
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.
MStatus	setIcon (const MString &filename)
	Associates a custom icon with the node for display in the Maya UI.
MString	icon (MStatus *ReturnStatus=NULL) const
	Returns the custom icon filename associated with the node.
	MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL)
	NO SCRIPT SUPPORT.
bool	getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL)
	NO SCRIPT SUPPORT.
MStatus	dgTimerOn ()
	The function starts the timing for this node.
MStatus	dgTimerOff ()
	The function stops the timing of dependency graph evaluation for this node.
MdgTimerState	dgTimerQueryState (MStatus *ReturnStatus=NULL)
	The function returns the current on/off state of the node's timer.
MStatus	dgTimerReset ()
	The function resets the dependency graph timers and counters for this node to zero.
double	dgTimer (const MdgTimerMetric timerMetric, const MdgTimerType timerType, MStatus *ReturnStatus=NULL) const
	The function returns the specified timer value for the current node.
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.
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.
MStatus	addAttribute (const MObject &attr, MAttrClass type)
	This method is obsolete.
MStatus	removeAttribute (const MObject &attr, MAttrClass type)
	This method is obsolete.
Static Public Member Functions
static MString	classification (const MString &nodeTypeName)
	Retrieves the classification string for a node type.
static unsigned int	allocateFlag (const MString pluginName, MStatus *ReturnStatus=NULL)
	Allocates a node flag for sole use by the caller.
static MStatus	deallocateFlag (const MString pluginName, unsigned int flag)
	Deallocates a node flag which was previously allocated by a call to allocateFlag.
static MStatus	deallocateAllFlags (const MString pluginName)
	Deallocates all of the node flags which are currently allocated to the specified plugin.
Protected Member Functions
virtual const char *	className () const
	Class name.

Member Enumeration Documentation

enum MAttrClass

Search for all occurrences

Specifies the scope of the attribute.

Enumerator:

kLocalDynamicAttr	Dynamically added, applies to this specific node. Search for all occurrences
kNormalAttr	Static attribute which is part of the original definition for this node type. Search for all occurrences
kExtensionAttr	Extension attribute which is part of all nodes of this or derived node types. Search for all occurrences
kInvalidAttr	None of the above. Search for all occurrences

enum MdgTimerState

Search for all occurrences

Possible states for the node's timer.

Enumerator:

kTimerOff	Search for all occurrences
kTimerOn	Search for all occurrences
kTimerUninitialized	Search for all occurrences
kTimerInvalidState	Search for all occurrences

enum MdgTimerMetric

Search for all occurrences

The different timer metrics which can be queried.

Enumerator:

kTimerMetric_callback	Time spent within node callbacks for this node. Search for all occurrences
kTimerMetric_compute	Time spent within the compute method for this node. Search for all occurrences
kTimerMetric_dirty	Time spent propogating dirty messages from this node. Search for all occurrences
kTimerMetric_draw	Time spent drawing this node. Search for all occurrences
kTimerMetric_fetch	Time spent fetching data from plugs. Search for all occurrences
kTimerMetric_callbackViaAPI	Time spent in callbacks which were registered through the API. Search for all occurrences
kTimerMetric_callbackNotViaAPI	Time spent in callbacks not registered through the API (i.e internal Maya callbacks). Search for all occurrences
kTimerMetric_computeDuringCallback	Time spent in this node's compute while executing node callbacks on any node. Search for all occurrences
kTimerMetric_computeNotDuringCallback	Time spent in this nodes compute when not executing any node callbacks on any nodes. Search for all occurrences

enum MdgTimerType

Search for all occurrences

The types of timers which can be queried.

Enumerator:

kTimerType_self

Time spent performing an operation, not including any time spent by child operations.

For example, if we are drawing a node and that requires a compute, self time will only include the time spent drawing and not the compute time. Self time measures wall-clock time as opposed to CPU time and the values are in seconds.

Search for all occurrences

kTimerType_inclusive

Time spent performing an operation including all time spent by child operations.

For example, if we are drawing a node and that requires a compute, inclusive time is the time for the draw plus compute. Inclusive time measure wall-clock time as opposed to CPU time and the values are in seconds.

Search for all occurrences

kTimerType_count

The number of operations that occurred.

Ideally we should return an integer when this timer type is queried, but there are two advantages to using a double. 1) it keeps the interface consistent and 2) integer has a fixed upper bound of roughly four billion so using a double allows us to exceed this.

Search for all occurrences

Constructor & Destructor Documentation

MFnDependencyNode	(	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

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

NO SCRIPT SUPPORT.

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

Constructor

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]

Search for all occurrences

Function set type.

Return the class type : MFn::kDependencyNode.

Reimplemented from MFnBase.

Reimplemented in MFnAirField, MFnAmbientLight, MFnAnimCurve, MFnAnisotropyShader, MFnAreaLight, MFnBlendShapeDeformer, MFnBlinnShader, MFnCamera, MFnCameraSet, MFnCharacter, MFnCircleSweepManip, MFnClip, MFnContainerNode, MFnCurveSegmentManip, MFnDagNode, MFnDirectionalLight, MFnDirectionManip, MFnDiscManip, MFnDistanceManip, MFnDragField, MFnExpression, MFnField, MFnFluid, MFnFreePointTriadManip, MFnGeometryFilter, MFnGravityField, MFnHikEffector, MFnIkEffector, MFnIkHandle, MFnIkJoint, MFnIkSolver, MFnImageSource, MFnInstancer, MFnLambertShader, MFnLattice, MFnLatticeDeformer, MFnLayeredShader, MFnLight, MFnManip3D, MFnMesh, MFnMotionPath, MFnNewtonField, MFnNonAmbientLight, MFnNonExtendedLight, MFnNurbsCurve, MFnNurbsSurface, MFnParticleSystem, MFnPartition, MFnPfxGeometry, MFnPhongEShader, MFnPhongShader, MFnPointLight, MFnPointOnCurveManip, MFnPointOnSurfaceManip, MFnRadialField, MFnReflectShader, MFnRenderLayer, MFnRenderPass, MFnRotateManip, MFnScaleManip, MFnSet, MFnSkinCluster, MFnSpotLight, MFnStateManip, MFnSubd, MFnToggleManip, MFnTransform, MFnTurbulenceField, MFnUniformField, MFnVolumeAxisField, MFnVolumeLight, MFnVortexField, MFnWeightGeometryFilter, and MFnWireDeformer.

const char * className ( ) const [protected, virtual]

Search for all occurrences

Class name.

Return the class name : "MFnDependencyNode".

Reimplemented in MFnAirField, MFnAmbientLight, MFnAnimCurve, MFnAnisotropyShader, MFnAreaLight, MFnBlendShapeDeformer, MFnBlinnShader, MFnCamera, MFnCameraSet, MFnCharacter, MFnCircleSweepManip, MFnClip, MFnContainerNode, MFnCurveSegmentManip, MFnDagNode, MFnDirectionalLight, MFnDirectionManip, MFnDiscManip, MFnDistanceManip, MFnDragField, MFnExpression, MFnField, MFnFluid, MFnFreePointTriadManip, MFnGeometryFilter, MFnGravityField, MFnHikEffector, MFnIkEffector, MFnIkHandle, MFnIkJoint, MFnIkSolver, MFnImageSource, MFnInstancer, MFnLambertShader, MFnLattice, MFnLatticeDeformer, MFnLayeredShader, MFnLight, MFnManip3D, MFnMesh, MFnMotionPath, MFnNewtonField, MFnNonAmbientLight, MFnNonExtendedLight, MFnNurbsCurve, MFnNurbsSurface, MFnParticleSystem, MFnPartition, MFnPfxGeometry, MFnPhongEShader, MFnPhongShader, MFnPointLight, MFnPointOnCurveManip, MFnPointOnSurfaceManip, MFnRadialField, MFnReflectShader, MFnRenderLayer, MFnRenderPass, MFnRotateManip, MFnScaleManip, MFnSet, MFnSkinCluster, MFnSpotLight, MFnStateManip, MFnSubd, MFnToggleManip, MFnTransform, MFnTurbulenceField, MFnUniformField, MFnVolumeAxisField, MFnVolumeLight, MFnVortexField, MFnWeightGeometryFilter, and MFnWireDeformer.

MObject create	(	const MTypeId &	typeId,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Creates a new dependency node with the given type tag.

The new node is placed into the dependency graph.

If the node is a DAG node, it will be parented to a transform.

The initial name for the node will be the node's "typeName" followed by a number to make the instance unique. For example, the first transform node created will be named "transform1".

Parameters:

[in]	typeId	type id of node to be created
[out]	ReturnStatus	return status

Returns:: A pointer to the new dependency node object

Status Codes:

MS::kSuccess operation successful
MS::kFailure node type is not recognised
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

Examples:: closestPointOnCurveCmd.cpp, latticeNoiseCmd.cpp, and pointOnMeshCmd.cpp.

MObject create	(	const MTypeId &	typeId,
		const MString &	name,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Creates a new dependency node with the given type tag.

The new node is placed into the dependency graph.

If the node is a DAG node, it will be parented to a transform.

Parameters:

[in]	typeId	type id of node to be created
[in]	name	the name to be assigned to the new node If the node's name is not unique, it will be given a unique name by changing its numerical suffix. For example, if this node is called "myNode" and a node by the same name exists, this node will be renamed to "myNode1".
[out]	ReturnStatus	return status

Returns:: A pointer to the new dependency node object

Status Codes:

MS::kSuccess operation successful
MS::kFailure node type is not recognised
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

MObject create	(	const MString &	type,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Creates a new dependency node with the given type.

The new node is placed into the dependency graph.

If the node is a DAG node, it will be parented to a transform.

The initial name for the node will be the node's "typeName" followed by a number to make the instance unique. For example, the first transform node created will be named "transform1".

Parameters:

[in]	type	int name for the type of dependency node
[out]	ReturnStatus	return status

Returns:: A pointer to the new dependency node object

Status Codes:

MS::kSuccess operation successful
MS::kFailure node type is not recognised
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

Reimplemented in MFnCameraSet.

MObject create	(	const MString &	type,
		const MString &	name,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Creates a new dependency node with the given type.

The new node is placed into the dependency graph.

If the node is a DAG node, it will be parented to a transform.

Parameters:

[in]	type	int name for the type of dependency node
[in]	name	the name to be assigned to the new node If the node's name is not unique, it will be given a unique name by changing its numerical suffix. For example, if this node is called "myNode" and a node by the same name exists, this node will be renamed to "myNode1".
[out]	ReturnStatus	return status

Returns:: A pointer to the new dependency node object

Status Codes:

MS::kSuccess operation successful
MS::kFailure node type is not recognised
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

Reimplemented in MFnCircleSweepManip, MFnDirectionManip, MFnDiscManip, MFnDistanceManip, MFnFreePointTriadManip, MFnPointOnCurveManip, MFnPointOnSurfaceManip, MFnRotateManip, MFnScaleManip, MFnStateManip, and MFnToggleManip.

MTypeId typeId ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the type id of this node.

The type is is the 4 byte code that is used in the binary file format to identify the type of this node.

Parameters:

[out] ReturnStatus return status

Returns:: The type id of this node

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

Examples:: cgfxShaderCmd.cpp.

MString typeName ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the type name of this node.

The string returned is the name of the node type as it is used in the ascii file format.

Parameters:

[out] ReturnStatus return status

Returns:: The type name of this node

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

Examples:: findFileTexturesCmd.cpp, and slopeShaderBehavior.cpp.

MString name ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the name of this node.

Note that if the object the instance of this class is attached to is data instead of being in the graph (ie. the object was created by one of the MFn*Data function sets, or was passed to an MPxNode::compute function in a data block) then the name method will not work.

Parameters:

[out] ReturnStatus return status

Returns:: The name of this node

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

Examples:: animInfoCmd.cpp, cgfxAttrDef.cpp, cgfxShaderCmd.cpp, cleanPerFaceAssignmentCmd.cpp, closestPointOnCurveCmd.cpp, dagMessageCmd.cpp, findFileTexturesCmd.cpp, findTexturesPerPolygonCmd.cpp, hwPhongShaderBehavior.cpp, instancerListCmd.cpp, pointOnMeshCmd.cpp, polyModifierCmd.cpp, polyPrimitiveCmd.cpp, slopeShaderBehavior.cpp, and whatisCmd.cpp.

MString pluginName ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the name of the plug-in this MFnDependendencyNode was defined in.

The name returned is the name of the plug-in on disk, and may contain pathname separators (such as `/') and drive letters (e.g. C:). If this object is not an MFnDependency node, then MS::kFailure is returned instead.

Parameters:

[out] ReturnStatus return status

Returns:: The name of the plug-in

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

MString setName	(	const MString &	name,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Sets the name of this node.

If the new name conflicts with the name of an existing node then the object will be given a unique name based on the supplied name. If the new name ends in a single '#' it will be replaced with a number that ensures the new name is unique.

When a transform is renamed, any shape nodes beneath the transform that have the same prefix as the old transform name are also renamed. For example, "rename nurbsSphere1 ball" would rename "nurbsSphere1|nurbsSphereShape1" to "ball|ballShape".

The unique name set for the node is returned.

Note that if the object the instance of this class is attached to is data instead of being in the graph (ie. the object was created by one of the MFn*Data function sets, or was passed to an MPxNode::compute function in a data block) then the setName method will not work.

Parameters:

[in]	name	the new name for the node
[out]	ReturnStatus	return status

Returns:: The new name of the node.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node
MS::kInvalidParameter name is the empty string

MStatus getConnections ( MPlugArray & array ) const

Search for all occurrences

Get all of the current connections to this node as an array of plugs.

Parameters:

[out] array storage for the array of plugs

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kFailure node has no connections

unsigned int attributeCount ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the number of attributes that this node has.

Parameters:

[out] ReturnStatus return status

Returns:: The attribute count

Status Codes:

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

MObject attribute	(	unsigned int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Finds the attribute of this node at the given index.

Index order is based on the order in which the attributes were added to the node.

Parameters:

[in]	index	the index of the attribute
[out]	ReturnStatus	return status

Returns:: A pointer to the attribute

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid object, or the index is out of range

Examples:: cgfxAttrDef.cpp, findFileTexturesCmd.cpp, GLSLShaderNode.cpp, latticeNoiseCmd.cpp, and polyModifierCmd.cpp.

MObject reorderedAttribute	(	unsigned int	index,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation.

Usually this ordering is only important when the node is being created during file I/O.

The attribute(index) method above returns the attributes according to the order in which they were originally added to the node.

This method returns the attributes according to the reordering, if any, which is required by the node.

Parameters:

[in]	index	the reordered index of the attribute
[out]	ReturnStatus	return status

Returns:: A pointer to the attribute

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid object, or the index is out of range

MObject attribute	(	const MString &	attrName,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Finds the attribute of this node that has the given name.

Parameters:

[in]	attrName	name of the attribute to find
[out]	ReturnStatus	return status

Returns:: A pointer to the attribute

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid object, or the given attribute was not found

MFnDependencyNode::MAttrClass attributeClass	(	const MObject &	attribute,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Returns the class (normal, dynamic, extension) of the specified attribute.

Parameters:

[in]	attribute	the attribute to check
[out]	ReturnStatus	return status

Returns:: The class of the attribute. If the node does not have the specified attribute, then kInvalidAttr is returned as the class.

Status Codes:

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

MStatus getAffectedAttributes	(	const MObject &	attr,
		MObjectArray &	affectedAttributes
	)		const

Search for all occurrences

Returns an array of attributes that are affected by the attribute passed in.

That is, when the given attribute, attr is marked dirty (changed) all the affectedAttributes attributes will also be marked dirty. For nodes defined in plug-ins this call returns all those attributes that were marked as being affected by the given one via the MPxNode::attributeAffects call.

It should be noted that dynamic attributes cannot be handled by this method. This is because the attribute affects dependencies are statically defined when the node is created. An alternate approach which works for dynamic as well as non-dynamic attributes is available through MPxNode::setDependentsDirty override.

Parameters:

[in]	attr	the attribute to check
[out]	affectedAttributes	an array of attributes affected by attr

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kFailure operation failed
MS::kInvalidParameter function set is not bound to a dependency node or the first parameter is not an attribute

MStatus getAffectedByAttributes	(	const MObject &	attr,
		MObjectArray &	affectedByAttributes
	)		const

Search for all occurrences

Returns an array of attributes that affect the attribute passed in, attr.

That is, when one of the attributes in affectedByAttributes is marked dirty (changed) then attr will also be marked dirty. For nodes defined in plug-ins this call returns all those attributes that were marked as affecting the given one via the MPxNode::attributeAffects call.

It should be noted that dynamic attributes cannot be handled by this method. This is because the attribute affects dependencies are statically defined when the node is created. An alternate approach which works for dynamic as well as non-dynamic attributes is available through MPxNode::setDependentsDirty override.

Parameters:

[in]	attr	the attribute to check
[out]	affectedByAttributes	an array of attributes affected by attr

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kFailure operation failed
MS::kInvalidParameter function set is not bound to a dependency node or the first parameter is not an attribute

MPlug findPlug	(	const MObject &	attr,
		bool	wantNetworkedPlug,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Attempt to find a plug for the given attribute.

This method will first try to find the networked version of the plug if requested. The networked version of a plug is one that currently exists in the dependency graph at a particular connection point. If a networked version is not found, then a standard non-networked plug is returned.

A non-networked plug is not actually used by the dependency graph, but is used to represent the same connections. Every time an operation is performed on a non-networked plug, a search is made for the networked version of the plug.

Networked and non-networked plugs behave the same, but networked plugs are much more efficient if used for multiple operations.

Networked plugs should be avoided if you will be deleting connections to the plug.

Parameters:

[in]	attr	attribute whose plug we wish to find
[in]	wantNetworkedPlug	if true, request a networked plug if it is available
[out]	ReturnStatus	return status

Returns:: The plug

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid object, or the plug could not be found

Examples:: cgfxShaderCmd.cpp, closestPointCmd.cpp, closestPointOnCurveCmd.cpp, D3DTextureItem.cpp, D3DViewportRenderer.cpp, findTexturesPerPolygonCmd.cpp, intersectCmd.cpp, pointOnMeshCmd.cpp, polyExporter.cpp, polyModifierCmd.cpp, polyWriter.cpp, slopeShaderBehavior.cpp, surfaceBumpManip.cpp, and swissArmyManip.cpp.

MPlug findPlug	(	const MString &	attrName,
		bool	wantNetworkedPlug,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Attempt to find a plug for the given attribute.

This method will first try to find the networked version of the plug if requested. The networked version of a plug is one that currently exists in the dependency graph at a particular connection point. If a networked version is not found, then a standard non-networked plug is returned.

A non-networked plug is not actually used by the dependency graph, but is used to represent the same connections. Every time an operation is performed on a non-networked plug, a search is made for the networked version of the plug.

Networked and non-networked plugs behave the same, but networked plugs are much more efficient if used for multiple operations.

Networked plugs should be avoided if you will be deleting connections to the plug.

Parameters:

[in]	attrName	name of attribute whose plug we wish to find
[in]	wantNetworkedPlug	if true, request a networked plug if it is available
[out]	ReturnStatus	return status

Returns:: The plug

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid object, or the plug could not be found

MPlug findPlug	(	const MObject &	attr,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

This method is obsolete.

Deprecated:: Use the MFnDependencyNode::findPlug( MObject&, bool, MStatus* ) method instead.

Parameters:

[in]	attr	Attribute to return a plug for.
[out]	ReturnStatus	Status code.

MPlug findPlug	(	const MString &	attrName,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

This method is obsolete.

Deprecated:: Use the MFnDependencyNode::findPlug( MString&, bool, MStatus* ) method instead.

Parameters:

[in]	attrName	Name of attribute to return a plug for.
[out]	ReturnStatus	Status code.

MStatus addAttribute ( const MObject & attr )

Search for all occurrences

Add a new dynamic attibute to this node.

Parameters:

[in] attr new attribute

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter attr is not a valid attribute object
MS::kFailure function set does not have a valid object, or the addition of the new attribute failed

MStatus removeAttribute ( const MObject & attribute )

Search for all occurrences

Remove a dynamic attribute from a node.

Note: After a successful call to this method, the MObject passed to it will have been reset to MObject::kNullObj because the attribute it referenced no longer exists. Thus no function sets, such as MFnAttribute, should be attached to the MObject at the time this call is made.

Parameters:

[in] attribute attribute to remove

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter attr is not a valid attribute object
MS::kFailure function set does not have a valid object, or the removal of the attribute failed

MPxNode * userNode ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

If the function set's node is a plug-in node, then this method will extract the MPxNode pointer from it.

This method should only be used on node types that are provided by the plug-in calling this method.

Parameters:

[out] ReturnStatus return status

Returns:: A pointer to the user data (NULL if not a plug-in node)

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid object, or the removal of the attribute failed

Examples:: cgfxShaderCmd.cpp.

bool isFromReferencedFile ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Indicates whether or not this node came from a referenced file.

If it did, the node will be marked as read-only in the scene and changes to the node's attributes will be saved in the main scene file, not the referenced from from which the node came.

Parameters:

[out] ReturnStatus return status

Returns:: true if the node came from a referenced file, false otherwise.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

bool isShared ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Indicates whether or not this node is shared.

This comes into play when you attempt to create a new node with the same name as an existing node. If the existing node is shared, then no new node will be created. If the existing node is not shared, then the new node will be created and given a different name.

For example, if you import several scene files into a single scene, they may all attempt to create their own 'defaultResolution' node. However, since this node is shared, only one such node will be created and the other requests will be ignored.

The concept of "sharing" can also be found in the "createNode -shared" flag found in MEL which, if specified causes an implicit node to be created (or not created, if it is already present).

Parameters:

[out] ReturnStatus return status

Returns:: true if the node is shared, false otherwise.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

bool hasUniqueName ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Indicates whether or not this node's name is unique within the scene.

Parameters:

[out] ReturnStatus return status

Returns:: true if the node's name is unique within scene, false otherwise.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

MString parentNamespace ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the name of the namespace in which this node resides.

Namespaces are often used when importing files to prevent name collisions.

Parameters:

[out] ReturnStatus return status

Returns:: The name of the namespace in which this node exists. This will be a colon separated path. If the object is in the root namespace, then an empty string will be returned.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

bool isLocked ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Indicates whether or not this node is locked.

See the setLocked method for more information on what it means for a node to be locked.

Parameters:

[out] ReturnStatus return status

Returns:: true if the node is locked, false otherwise.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

MStatus setLocked ( bool lock )

Search for all occurrences

Locks or unlocks this node.

If a node is locked, it may not be deleted, renamed, or reparented; it may not have attributes added or removed; attributes which are unlocked may not be locked and those which are already locked may not be unlocked.

Parameters:

[in] lock If true then node will be locked.

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

MString classification ( const MString & nodeTypeName ) [static]

Search for all occurrences

Retrieves the classification string for a node type.

This is a string that is used in dependency nodes that are also shaders to provide more detailed type information to the rendering system. See the documentation for the MEL commands getClassification and listNodeTypes for information on the strings that can be provided.

User-defined nodes set this value through a parameter to MFnPlugin::registerNode.

Parameters:

[in] nodeTypeName The name of the node for which a classification should be retrieved. Since this is a static method, the typeName method of this class can be used for this parameter if it is desired to get the classification for the attached node.

Returns:: The classification string. If the node does not have an associated classification, an empty string will be returned.

bool isNewAttribute	(	const MObject &	attr,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Indicates whether or not the specified attribute was added to this node within the current scene.

For nodes from referenced files, this method will only return true if the attribute was added to the node after the reference file was loaded into the scene.

For all other nodes, this method will return true if the attribute is dynamic (i.e. not one of the node's original, permanent attributes).

Parameters:

[in]	attr	Attribute to check.
[out]	ReturnStatus	return status

Returns:: true if the attribute was added within the current scene, false if the attribute is permanent or was added within a referenced file.

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter no such attribute on this node
MS::kFailure function set does not have a valid node

unsigned int allocateFlag	(	const MString	pluginName,
		MStatus *	ReturnStatus = `NULL`
	)		`[static]`

Search for all occurrences

Allocates a node flag for sole use by the caller.

Note that the flag is not specific to any one node but is made available to the caller on all nodes. Furthermore, node flags only persist for the duration of the current Maya session: they are not saved with the scene.

deallocateFlag must be called when a flag is no longer needed.

There are a total of just 8 flags available, so plugins should strive not to hold onto flags for extended periods of time as that might interfere with the needs of other plugins.

When a plugin is unloaded, deallocateAllFlags is automatically invoked to free up any node flags still held by the plugin.

Parameters:

[in]	pluginName	The name of the plugin which is allocating the flag. A plugin's name can be retrieved by calling MFnPlugin::name() within its initializePlugin() or uninitializePlugin() functions.
[out]	ReturnStatus	Return status.

Returns:: The newly-allocated flag.

Status Codes:

MS::kSuccess Operation successful.
MS::kNotFound No unallocated flags are available.
MS::kInvalidParameter The specified plugin is not loaded.

Examples:: maTranslator.cpp.

MStatus deallocateFlag	(	const MString	pluginName,
		unsigned int	flag
	)		`[static]`

Search for all occurrences

Deallocates a node flag which was previously allocated by a call to allocateFlag.

The flag subsequently becomes available for reallocation and use by someone else.

Parameters:

[in]	pluginName	The name of the plugin which allocated the flag. A plugin's name can be retrieved by calling MFnPlugin::name() within its initializePlugin() or uninitializePlugin() functions.
[in]	flag	Flag to deallocate.

Returns:: Status code.

Status Codes:

MS::kSuccess Operation successful.
MS::kInvalidParameter Flag number is out of range.
MS::kNotFound Flag was not allocated by the plugin.

Examples:: maTranslator.cpp.

MStatus deallocateAllFlags ( const MString pluginName ) [static]

Search for all occurrences

Deallocates all of the node flags which are currently allocated to the specified plugin.

The deallocated flags immediately become available for use by any plugin.

Parameters:

[in] pluginName The name of the plugin whose flags are to be deallocated. A plugin's name can be retrieved by calling MFnPlugin::name() within its initializePlugin() or uninitializePlugin() functions.

Returns:: Status code.

Status Codes:

MS::kSuccess Operation successful.
MS::kInvalidParemeter The pluginName was invalid.

MStatus setFlag	(	unsigned int	flag,
		bool	state
	)

Search for all occurrences

Sets the state of the specified flag for the node.

The flag number must have been previously obtained through a call to allocateFlag.

Parameters:

[in]	flag	flag to set
[in]	state	new state to which the flag will be set

Returns:: Status code.

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter flag number is out of range
MS::kNotFound flag has not been properly allocated
MS::kFailure function set does not have a valid node

Examples:: maTranslator.cpp.

bool isFlagSet	(	unsigned int	flag,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Retrieves the current state of the specified flag for a node.

The flag must have been previously obtained through a call to allocateFlag.

Parameters:

[in]	flag	number of the flag to retrieve.
[out]	ReturnStatus	return status

Returns:: Current state of the flag

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter flag number is out of range
MS::kNotFound flag has not been properly allocated
MS::kFailure function set does not have a valid node

bool isDefaultNode ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns true if the node is a default node.

A default node is one that Maya creates automatically and does not get saved out with the scene, although some of its attribute values may.

Parameters:

[out] ReturnStatus return status

Returns:: true if the node is default, false otherwise.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

MStatus setDoNotWrite ( bool flag )

Search for all occurrences

Use this method to mark the "do not write" state of this node.

If set, this node will not be saved when the Maya model is written out.

NOTES: 1. If this node is a DAG and has a parent or children, the "do not write" flag of the parent or children will not be set. It is the developer's responsibility to ensure that the resulting scene file is capable of being read in without errors due to unwritten nodes.

Parameters:

[in] flag True if the node should not be saved.

bool canBeWritten ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns true if the node can be written/exported to scene files.

Note that if a node is marked as being shared (see MFnDependencyNode::isShared) that overrides being marked as not writable. So shared nodes can be written, even if not marked as writable.

Parameters:

[out] ReturnStatus return status

Returns:: true if the node can be written, false otherwise.

Status Codes:

MS::kSuccess operation successful
MS::kFailure function set does not have a valid node

bool hasAttribute	(	const MString &	attrName,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Returns true if the node already has an attribute with the given name.

Parameters:

[in]	attrName	Name of attribute to be checked.
[out]	ReturnStatus	return status

Returns:: true if the node has attribute, false otherwise.

Status Codes:

MS::kSuccess if method is successful.
MS::kFailure if an object error occurs.

Examples:: GLSLShaderNode.cpp.

MObject getAliasAttr	(	bool	force,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Returns the node's alias attribute, which is a special attribute used to store information about the node's attribute aliases.

If the node doesn't have an alias attribute and the 'force' parameter is true, then an alias attribute will be created and returned, otherwise MObject::kNullObj will be returned.

Parameters:

[in]	force	To indicate whether the alias attr should be created.
[out]	ReturnStatus	return status

Returns:: The MObject corresponding to the alias attribute.

Status Codes:

MS::kSuccess if method is successful.
MS::kFailure if an object error occurs.

bool setAlias	(	const MString &	alias,
		const MString &	name,
		const MPlug &	plug,
		bool	add = `true`,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Sets or removes an alias (i.e.

an alternative name) for an attribute.

A node can have at most one alias per attribute, so if there is already an alias on the specified attribute it will be replaced by the new one.

Parameters:

[in]	alias	alternative name for the attribute
[in]	name	real name of the attribute
[in]	plug	plug to the attribute
[in]	add	true to add the alias, false to remove it
[out]	ReturnStatus	return status

Returns:: True on success, false on failure. If the ReturnStatus indicates success then false means either that the alias to be added already exists, or the alias to be removed does not exist.

Status Codes:

MS::kSuccess if method is successful.
MS::kFailure if an object error occurs.

bool findAlias	(	const MString &	alias,
		MObject &	attrObj,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

Retrieves the attribute with the given alias.

If there is no attribute with the given alias, the method will return false and the value of 'attrObj' will be undefined.

Parameters:

[in]	alias	alternative name of the attribute
[out]	attrObj	the attribute having the specified alias
[out]	ReturnStatus	return status

Returns:: True if the alias was found.

Status Codes:

MS::kSuccess if method is successful.
MS::kFailure if an object error occurs.

bool getAliasList	(	MStringArray &	strArray,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Returns a list of all attribute aliases for this node.

The aliases are pairs of strings with the first being the alias and the second being the attribute's real name.

Parameters:

[out]	strArray	list of aliases
[out]	ReturnStatus	return status

Returns:: true if any alias was found, false otherwise.

Status Codes:

MS::kSuccess if method is successful.
MS::kFailure if an object error occurs.

MString plugsAlias	(	const MPlug &	plug,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

Returns the alias for the plug's attribute or the empty string if that attribute has no alias.

Parameters:

[in]	plug	plug for whose attribute we want the alias
[out]	ReturnStatus	return status. See below.

Returns:: Alternative name for the attribute, if any.

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.

MStatus setIcon ( const MString & filename )

Search for all occurrences

Associates a custom icon with the node for display in the Maya UI.

Currently the icon only shows up in Outliner panels (the DAG Outliner, Graph Editor and Dope Sheet).

Parameters:

[in] filename specifies the name of the image file defining the icon, or the empty string (i.e. "") to revert to using Maya's default. The filename must be a PNG file (.png) and may either be an absolute pathname or be relative to the XBMLANGPATH environment variable.

Returns:: Status code

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.
MS::kInvalidParameter the filename did not exist, or was not readable, or did not have a .png or .PNG extension.

MString icon ( MStatus * ReturnStatus = NULL ) const

Search for all occurrences

Returns the custom icon filename associated with the node.

The icon can be assigned using setIcon().

Parameters:

[out] ReturnStatus return status

Returns:: The custom icon filename, or the empty string (i.e. "") if the node is using Maya's default.

Status Codes:

MS::kSuccess if the method is successful
MS::kFailure function set does not have a valid node

bool getPlugsAlias	(	const MPlug &	plug,
		MString &	aliasName,
		MStatus *	ReturnStatus = `NULL`
	)

Search for all occurrences

NO SCRIPT SUPPORT.

Returns the alias for the plug's attribute or the empty string if that attribute has no alias.

Python Notes

This method is not supported in Python. Please see plugsAlias()

Parameters:

[in]	plug	plug for whose attribute we want the alias
[out]	aliasName	alternative name for the attribute
[out]	ReturnStatus	return status

Returns:: true if the alias was found, false otherwise.

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.

MStatus dgTimerOn ( )

Search for all occurrences

The function starts the timing for this node.

Note that this does not reset the timers and counters on the node, it merely activates the timing mechanism within Maya and subsequent timing values are added to the current timer and counter values. If you also want the counters to be reset, use the method dgTimerReset().

For the inquisitive: yes, it is OK to turn on timing when its already on, and turn it off when its already off, so you don't have to call dgTimerQueryState() on each node in order to change its state.

Returns:: Status code

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.

MStatus dgTimerOff ( )

Search for all occurrences

The function stops the timing of dependency graph evaluation for this node.

Returns:: Status code

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.

MFnDependencyNode::MdgTimerState dgTimerQueryState ( MStatus * ReturnStatus = NULL )

Search for all occurrences

The function returns the current on/off state of the node's timer.

Parameters:

[out] ReturnStatus return status.

Returns:: The node's timer's current on/off state.

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.

MStatus dgTimerReset ( )

Search for all occurrences

The function resets the dependency graph timers and counters for this node to zero.

Note that this method does not start or stop timing, it only resets the values to zero. If you want to turn on timing, use the method dgTimerOn(). If you want to turn off timing, use dgTimerOff().

Returns:: Status code

Status Codes:

MS::kSuccess if the method is successful.
MS::kFailure if an object error occurs.

double dgTimer	(	const MdgTimerMetric	timerMetric,
		const MdgTimerType	timerType,
		MStatus *	ReturnStatus = `NULL`
	)		const

Search for all occurrences

The function returns the specified timer value for the current node.

This is the total amount of time spent performing the requested operation since the timer was last reset (see dgTimerReset() for details). There are numerous timers per node and these are referenced by the metric and the timer type.

Parameters:

[in]	timerMetric	The timing metric we wish to query.
[in]	timerType	The timer type we wish to query.
[out]	ReturnStatus	return status

Returns:: Value of the timer in seconds for types of kTimerType_self and kTimerType_inclusive, and as a simple count for kTimerType_count.

Status Codes:

MS::kSuccess if the method is successful.
MS::kInvalidParameter if `timerMetric' or `timerType' is invalid.

MStatus dgCallbacks	(	const MdgTimerType	timerType,
		MStringArray &	callbackName,
		MDoubleArray &	value
	)

Search for all occurrences

Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method.

See the dgCallbackIds method for getting a further breakdown of the time for an individual callback on this node.

There are several important items of note:

1 Due to the large number of node types which exist within Maya, the "internal name" is used instead of the API name. For example, a message the user declares to be of type MDagMessage::kParentRemoved will report as "parentRemovedMsg". In general it should be obvious as to the meaning of the callback name.
2 Timing is reported by callback type and is not further broken down by the individual callback methods that are registered against that callback type. Therefore if you note a high-cost callback type, the majority of cost may not be expended in your callback method but rather in other registered callbacks on that type.
3 Not all callback types inside Maya that deal with nodes are currently tracked using the node callback timing mechanism. Only the most frequently encountered message types are currently recorded.

The result of calling this method is an array of names and an array of values. There is a one-to-one correspondence between the two arrays.

Parameters:

[in]	timerType	The timer we want to query, e.g. kTimerType_self for self time.
[in]	callbackName	Returns an array of callback names that were invoked for this node since the last timer reset.
[in]	value	Returns an array of timing values. There is a one-to-one correspondence with the `callbackName' array.

Returns:: Status code

Status Codes:

MS::kSuccess if the method is successful.
MS::kInvalidParameter if `timerType' is invalid.

MStatus dgCallbackIds	(	const MdgTimerType	timerType,
		const MString &	callbackName,
		MCallbackIdArray &	callbackId,
		MDoubleArray &	value
	)

Search for all occurrences

This method provides a further breakdown of the per-callback time returned via dgCallbacks() by returning the data on a per-callbackId basis.

We define a "callback" to be an event withing Maya that "callback methods" can be registered with to be invoked when the given event occurs. The registered client information is called a "callbackId". There can be multiple callbackIds registered with a given callback, and a callbackId can be shared amongst multiple nodes or multiple callbacks.

An example of a callback is "attributeChangedMsg", which the user can register callback methods against via MNodeMessage::addAttributeChangedCallback(). The process of registering a callback method returns a callbackId, thus there can be multiple callbacksIds per callback.

The general approach when querying callbackIds is as follows:

1 Query the callbacks associated with a given node using MFnDependencyNode::dgCallbacks(). This returns the list of callbacks by name.
2 Use this method to query the callbackIds for a given callback on the given node.

The result of calling this method is an array of names and an array of values. There is a one-to-one correspondence between the two arrays.

Parameters:

[in]	timerType	The timer we want to query, e.g. kTimerType_self for self time.
[in]	callbackName	Name of the callback to query the callbackIds for. This should be one of the callback names that was returned from MFnDependencyNode::dgCallbacks().
[in]	callbackId	Returns an array of callbackIds which were invoked for this node and `callbackName' since the last timer reset. There is a one-to-one correspondence with the `value' array. The entries in the list can include callbackIds that are no longer active (e.g. if you unregistered the callbackId), so be careful not to treat these as active callbackIds -- they are for informational purposes only.
[in]	value	Returns an array of timing values. There is a one-to-one correspondence with the `name' array.

Returns:: Status code

Status Codes:

MS::kSuccess if the method is successful.
MS::kInvalidParameter if `timerType' is invalid.
MS::kNotFound if `callbackName' was not one of the callbacks that was invoked for this node since the last timer reset.

MStatus addAttribute	(	const MObject &	attr,
		MFnDependencyNode::MAttrClass	type
	)

Search for all occurrences

This method is obsolete.

Deprecated:: Use the MFnDependencyNode::addAttribute( const MObject& ) method instead.

Add a new attibute to this node. Note that this operation will fail if the given type parameter is not MFnDependencyNode::kLocalDynamicAttr. See MNodeClass for adding or removing extension attributes.

Parameters:

[in]	attr	new attribute
[in]	type	class of attribute to add

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter attr is not a valid attribute object, or type did not specify a local dynamic attribute type.
MS::kFailure function set does not have a valid object, or the addition of the new attribute failed

MStatus removeAttribute	(	const MObject &	attribute,
		MFnDependencyNode::MAttrClass	type
	)

Search for all occurrences

This method is obsolete.

Deprecated:: Use the MFnDependencyNode::removeAttribute( const MObject& ) method instead.

Remove an attribute from a node.

Note: After a successful call to this method, the MObject passed to it will have been reset to MObject::kNullObj because the attribute it referenced no longer exists. Thus no function sets, such as MFnAttribute, should be attached to the MObject at the time this call is made.

Parameters:

[in]	attribute	attribute to remove
[in]	type	class of attribute to remove (must be MFnDependencyNode::kLocalDynamicAttr) See MNodeClass for adding or removing extension attributes.

Returns:: Status code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter attr is not a valid attribute object, or type did not specify a dynamic attribute type.
MS::kFailure function set does not have a valid object, or the removal of the attribute failed

MFnDependencyNode Class Reference

OpenMaya - API module for common classes | FunctionSet classes

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation