MFnDependencyNode Class Reference
 
 
 

#include <MFnDependencyNode.h>


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

AbcExport/AbcExport.cpp, AbcExport/AbcWriteJob.cpp, AbcExport/AttributesWriter.cpp, AbcExport/AttributesWriter.h, AbcExport/MayaCameraWriter.cpp, AbcExport/MayaMeshWriter.cpp, AbcExport/MayaMeshWriter.h, AbcExport/MayaNurbsCurveWriter.cpp, AbcExport/MayaTransformWriter.cpp, AbcExport/MayaUtility.cpp, AbcImport/AlembicNode.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, AbcImport/NurbsCurveHelper.cpp, AbcImport/util.cpp, AbcImport/util.h, affectsNode/affectsNode.cpp, animExportUtil/animExportUtil.cpp, animInfoCmd/animInfoCmd.cpp, apiMeshShape/apiMeshGeometryOverride.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, AshliShader/GLSLShaderNode.cpp, atomImportExport/atomAnimLayers.cpp, atomImportExport/atomAnimLayers.h, atomImportExport/atomFileUtils.cpp, atomImportExport/atomImportExport.cpp, blindComplexDataCmd/blindComplexDataCmd.cpp, blindDoubleDataCmd/blindDoubleDataCmd.cpp, blindShortDataCmd/blindShortDataCmd.cpp, cameraSetSubclass/testExCameraSetCmd.cpp, cgfxAttrDef.cpp, cgfxAttrDef.h, cgfxShaderCmd.cpp, cgfxShaderCmd.h, cgfxShaderNode.cpp, closestPointCmd/closestPointCmd.cpp, closestPointOnCurve/closestPointOnCurveCmd.cpp, clothPaintAttrCmd/clothPaintAttrCmd.cpp, componentScaleManip/componentScaleManip.cpp, customAttrManip/customAttrManip.cpp, cvColorNode/cvColorNode.cpp, D3DViewportRenderer/D3DTextureItem.cpp, D3DViewportRenderer/D3DViewportRenderer.cpp, dagPoseInfoCmd/dagPoseInfoCmd.cpp, deletedMsgCmd/deletedMsgCmd.cpp, dx11Shader/dx11Shader.cpp, dx11Shader/dx11ShaderCmd.cpp, DX11ViewportRenderer/DX11TextureItem.cpp, DX11ViewportRenderer/DX11ViewportRenderer.cpp, exportJointClusterDataCmd/exportJointClusterDataCmd.cpp, fileTexture/fileTexture.cpp, filteredAsciiFile/filteredAsciiFile.cpp, findFileTexturesCmd/findFileTexturesCmd.cpp, findTexturesPerPolygonCmd/findTexturesPerPolygonCmd.cpp, footPrintManip/footPrintManip.cpp, geometryReplicator/geometryReplicator.cpp, getAttrAffectsCmd/getAttrAffectsCmd.cpp, GLSLShaderNode.h, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheDrawOverride.cpp, gpuCache/gpuCacheGeometryOverride.cpp, gpuCache/gpuCacheMaterialBakers.cpp, gpuCache/gpuCacheUtil.cpp, gpuCache/gpuCacheUtil.h, hairCollisionSolver/hairCollisionSolver.cpp, hlslShader/hlslShader.cpp, hwAnisotropicShader_NV20/MTextureCache.cpp, hwAnisotropicShader_NV20/NodeMonitor.cpp, hwAnisotropicShader_NV20/ShadingConnection.cpp, hwDecalBumpShader_NV20/hwDecalBumpShader_NV20.cpp, hwDecalBumpShader_NV20/MTextureCache.cpp, hwDecalBumpShader_NV20/NodeMonitor.cpp, hwDecalBumpShader_NV20/ShadingConnection.cpp, hwPhongShader/hwPhongShaderBehavior.cpp, hwReflectBumpShader_NV20/hwReflectBumpShader_NV20.cpp, hwReflectBumpShader_NV20/MTextureCache.cpp, hwReflectBumpShader_NV20/NodeMonitor.cpp, hwReflectBumpShader_NV20/ShadingConnection.cpp, hwRefractReflectShader_NV20/hwRefractReflectShader_NV20.cpp, hwRefractReflectShader_NV20/MTextureCache.cpp, hwRefractReflectShader_NV20/NodeMonitor.cpp, hwRefractReflectShader_NV20/ShadingConnection.cpp, hwToonShader_NV20/hwToonShader_NV20.cpp, hwToonShader_NV20/MTextureCache.cpp, hwToonShader_NV20/NodeMonitor.cpp, hwToonShader_NV20/ShadingConnection.cpp, hwUnlitShader/hwUnlitShader.cpp, hwUnlitShader/MTextureCache.cpp, hwUnlitShader/NodeMonitor.cpp, hwUnlitShader/ShadingConnection.cpp, instancerListCmd/instancerListCmd.cpp, intersectCmd/intersectCmd.cpp, latticeNoise/latticeNoiseCmd.cpp, lensDistortionCallback/lensDistortionCallback.cpp, listPolyHolesCmd/listPolyHolesCmd.cpp, lockEvent/lockEvent.cpp, manipOverride/customTriadManip.cpp, manipOverride/manipOverride.cpp, maTranslator/maTranslator.cpp, meshOpCmd/meshOpCmd.cpp, meshOpCmd/polyModifierCmd.cpp, MetadataSample/createMetadataCmd.cpp, motionTraceCmd/motionTraceCmd.cpp, moveManip/moveManip.cpp, narrowPolyViewer/narrowPolyViewer.h, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, nodeIconCmd/nodeIconCmd.cpp, nodeInfoCmd/nodeInfoCmd.cpp, offsetNode/offsetNode.cpp, ownerEmitter/ownerEmitter.cpp, phongShader/phongShaderOverride.cpp, pluginMain.cpp, pointOnMeshInfo/pointOnMeshCmd.cpp, polyRawExporter/polyWriter.cpp, polyX3DExporter/polyWriter.cpp, rockingTransformCheck/rockingTransformCheck.cpp, rotateManip/rotateManip.cpp, sceneAssembly/adskRepresentations.cpp, sceneAssembly/assemblyDefinition.cpp, sceneAssembly/assemblyReference.cpp, simpleEmitter/simpleEmitter.cpp, simpleFluidEmitter/simpleFluidEmitter.cpp, slopeShader/slopeShaderBehavior.cpp, splitUVCmd/polyModifierCmd.cpp, splitUVCmd/splitUVCmd.cpp, squareScaleManip/squareScaleManip.cpp, squareScaleManipContext/squareScaleManipContext.cpp, surfaceBumpManip/surfaceBumpManip.cpp, sweptEmitter/sweptEmitter.cpp, swissArmyManip/swissArmyManip.cpp, testCameraSetCmd/testCameraSetCmd.cpp, threadedBoundingBox/threadedBoundingBox.cpp, torusField/torusField.cpp, whatisCmd/whatisCmd.cpp, xmlAssembly/AssemblyCommand.cpp, xmlAssembly/BBoxesRep.cpp, xmlAssembly/CacheRep.cpp, xmlAssembly/FileRep.cpp, xmlAssembly/FnAssetInstanceUtil.cpp, and xmlAssembly/LocatorRep.cpp.

Inheritance diagram for MFnDependencyNode:
MFnBase MFnAnimCurve MFnAnisotropyShader MFnBlendShapeDeformer MFnCameraSet MFnClip MFnContainerNode MFnDagNode MFnExpression MFnGeometryFilter MFnIkSolver MFnImageSource MFnLambertShader MFnLatticeDeformer MFnLayeredShader MFnMotionPath MFnPartition MFnPhongEShader MFnReference MFnRenderLayer MFnRenderPass MFnSet MFnWireDeformer

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, bool createNamespace=false, 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  isTrackingEdits (MStatus *ReturnStatus=NULL) const
  Returns whether or not edits on the given node are being tracked by the generalized edit system.
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 the do not write state of the node.
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.
MString  setName (const MString &name, MStatus *ReturnStatus)
  OBSOLETE FUNCTION, NO SCRIPT SUPPORT.
  MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL)
  NO SCRIPT SUPPORT.
bool  getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL)
  NO SCRIPT SUPPORT.
virtual const
adsk::Data::Associations
metadata (MStatus *ReturnStatus=NULL) const
  This method is not available in Python.
virtual MStatus  setMetadata (const adsk::Data::Associations &)
  This method is not available in Python.
virtual MStatus  deleteMetadata ()
  This method is not available in Python.
virtual MStatus  validateMetadata (MString &errors) const
  This method is not available in Python.
MStatus  dgTimerOn ()
  Indicates that this node should collect DG timing data whenever DG timing is enabled.
MStatus  dgTimerOff ()
  Indicates that this node should no longer collect DG timing data when DG timing is enabled.
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.
static void  enableDGTiming (bool enable)
  Globally enables or disables the DG node timing mechanism.

Protected Member Functions

virtual const char *  className () const
  Class name.

Member Enumeration Documentation

Specifies the scope of the attribute.

Enumerator:
kLocalDynamicAttr 

Dynamically added, applies to this specific node.

kNormalAttr 

Static attribute which is part of the original definition for this node type.

kExtensionAttr 

Extension attribute which is part of all nodes of this or derived node types.

kInvalidAttr 

None of the above.

Possible states for the node's timer.

Enumerator:
kTimerOff 

 

kTimerOn 

 

kTimerUninitialized 

 

kTimerInvalidState 

 

The different timer metrics which can be queried.

Enumerator:
kTimerMetric_callback 

Time spent within node callbacks for this node.

kTimerMetric_compute 

Time spent within the compute method for this node.

kTimerMetric_dirty 

Time spent propogating dirty messages from this node.

kTimerMetric_draw 

Time spent drawing this node.

kTimerMetric_fetch 

Time spent fetching data from plugs.

kTimerMetric_callbackViaAPI 

Time spent in callbacks which were registered through the API.

kTimerMetric_callbackNotViaAPI 

Time spent in callbacks not registered through the API (i.e internal Maya callbacks).

kTimerMetric_computeDuringCallback 

Time spent in this node's compute while executing node callbacks on any node.

kTimerMetric_computeNotDuringCallback 

Time spent in this nodes compute when not executing any node callbacks on any nodes.

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.

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.

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.


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

Member Function Documentation

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

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:
Examples:
cameraSetSubclass/testExCameraSetCmd.cpp, closestPointOnCurve/closestPointOnCurveCmd.cpp, latticeNoise/latticeNoiseCmd.cpp, and pointOnMeshInfo/pointOnMeshCmd.cpp.
MObject create ( const MTypeId typeId,
const MString name,
MStatus ReturnStatus = NULL 
)

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:
MObject create ( const MString type,
MStatus ReturnStatus = NULL 
)

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:

Reimplemented in MFnCameraSet.

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

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:

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

MTypeId typeId ( MStatus ReturnStatus = NULL ) const

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:
Examples:
cgfxShaderCmd.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheMaterialBakers.cpp, gpuCache/gpuCacheSubSceneOverride.cpp, manipOverride/manipOverride.cpp, and sceneAssembly/assemblyReference.cpp.
MString typeName ( MStatus ReturnStatus = NULL ) const

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:
Examples:
findFileTexturesCmd/findFileTexturesCmd.cpp, slopeShader/slopeShaderBehavior.cpp, and xmlAssembly/FnAssetInstanceUtil.cpp.
MString pluginName ( MStatus ReturnStatus = NULL ) const

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:
MString setName ( const MString name,
bool  createNamespace = false,
MStatus ReturnStatus = NULL 
)

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.

The name can also have a namespace path, for example "ns:ball". If the namespace already exists, the object will be be moved into that namespace (in addition to being renamed). If the namespace does not exist then the 'createNamespace' parameter will determine how to handle it. If the parameter is true then the namespace will be created (under the root if the namespace name is absolute, or under the current namespace if not) and the object will be moved into the new namespace. If the parameter is false then the object will be moved into the current namespace.

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 to which the functionset is attached is data rather than a node (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
[in] createNamespace determine whether or not to create a new namespace when the given name includes a namespace which does not exist.
[out] ReturnStatus return status
Returns:
The new name of the node.
Status Codes:
Examples:
AbcImport/CreateSceneHelper.cpp, AbcImport/LocatorHelper.cpp, AbcImport/MeshHelper.cpp, AbcImport/NurbsCurveHelper.cpp, AbcImport/NurbsSurfaceHelper.cpp, AbcImport/PointHelper.cpp, and AbcImport/util.cpp.
MStatus getConnections ( MPlugArray array ) const

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:
unsigned int attributeCount ( MStatus ReturnStatus = NULL ) const

Returns the number of attributes that this node has.

Parameters:
[out] ReturnStatus return status
Returns:
The attribute count
Status Codes:
Examples:
AbcExport/AttributesWriter.cpp.
MObject attribute ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const

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:
AbcExport/AttributesWriter.cpp, AshliShader/GLSLShaderNode.cpp, cgfxAttrDef.cpp, findFileTexturesCmd/findFileTexturesCmd.cpp, latticeNoise/latticeNoiseCmd.cpp, meshOpCmd/polyModifierCmd.cpp, splitUVCmd/polyModifierCmd.cpp, and xmlAssembly/FnAssetInstanceUtil.cpp.
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.

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

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:
MFnDependencyNode::MAttrClass attributeClass ( const MObject attribute,
MStatus ReturnStatus = NULL 
) const

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:
MStatus getAffectedAttributes ( const MObject attr,
MObjectArray affectedAttributes 
) const

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:
MStatus getAffectedByAttributes ( const MObject attr,
MObjectArray affectedByAttributes 
) const

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:
MPlug findPlug ( const MObject attr,
bool  wantNetworkedPlug,
MStatus ReturnStatus = NULL 
) const

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:
AbcExport/AttributesWriter.cpp, AbcExport/MayaCameraWriter.cpp, AbcExport/MayaLocatorWriter.cpp, AbcExport/MayaNurbsCurveWriter.cpp, AbcExport/MayaTransformWriter.cpp, AbcExport/MayaUtility.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/LocatorHelper.cpp, AbcImport/MeshHelper.cpp, AbcImport/NurbsCurveHelper.cpp, AbcImport/util.cpp, AbcImport/XformHelper.cpp, atomImportExport/atomAnimLayers.cpp, cgfxShaderCmd.cpp, closestPointCmd/closestPointCmd.cpp, closestPointOnCurve/closestPointOnCurveCmd.cpp, D3DViewportRenderer/D3DTextureItem.cpp, D3DViewportRenderer/D3DViewportRenderer.cpp, dx11Shader/dx11Shader.cpp, DX11ViewportRenderer/DX11TextureItem.cpp, findTexturesPerPolygonCmd/findTexturesPerPolygonCmd.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheSubSceneOverride.cpp, gpuCache/gpuCacheUtil.cpp, gpuCache/gpuCacheUtil.h, intersectCmd/intersectCmd.cpp, meshOpCmd/polyModifierCmd.cpp, pointOnMeshInfo/pointOnMeshCmd.cpp, polyRawExporter/polyExporter.cpp, polyRawExporter/polyWriter.cpp, polyX3DExporter/polyExporter.cpp, polyX3DExporter/polyWriter.cpp, slopeShader/slopeShaderBehavior.cpp, splitUVCmd/polyModifierCmd.cpp, surfaceBumpManip/surfaceBumpManip.cpp, and swissArmyManip/swissArmyManip.cpp.
MPlug findPlug ( const MString attrName,
bool  wantNetworkedPlug,
MStatus ReturnStatus = NULL 
) const

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:
MPlug findPlug ( const MObject attr,
MStatus ReturnStatus = NULL 
) const

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

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 )

Add a new dynamic attibute to this node.

Parameters:
[in] attr new attribute
Returns:
Status code
Status Codes:
Examples:
AbcImport/NurbsCurveHelper.cpp.
MStatus removeAttribute ( const MObject attribute )

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

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:
apiMeshShape/apiMeshSubSceneOverride.cpp, cgfxShaderCmd.cpp, gpuCache/gpuCacheMaterialBakers.cpp, and gpuCache/gpuCacheSubSceneOverride.cpp.
bool isFromReferencedFile ( MStatus ReturnStatus = NULL ) const

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 file from which the node came.

Parameters:
[out] ReturnStatus return status
Returns:
true if the node came from a referenced file, false otherwise.
Status Codes:
bool isShared ( MStatus ReturnStatus = NULL ) const

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:
bool isTrackingEdits ( MStatus ReturnStatus = NULL ) const

Returns whether or not edits on the given node are being tracked by the generalized edit system.

Referenced nodes and nodes in assemblies that are tracking edits will return true.

Parameters:
[out] ReturnStatus Status code
Returns:
true if edits on the given node are being tracked, false otherwise.
Status Codes:
bool hasUniqueName ( MStatus ReturnStatus = NULL ) const

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:
MString parentNamespace ( MStatus ReturnStatus = NULL ) const

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:
bool isLocked ( MStatus ReturnStatus = NULL ) const

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:

Reimplemented in MFnReference.

MStatus setLocked ( bool  lock )

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:
MString classification ( const MString nodeTypeName ) [static]

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

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:
unsigned int allocateFlag ( const MString  pluginName,
MStatus ReturnStatus = NULL 
) [static]

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:
Examples:
maTranslator/maTranslator.cpp.
MStatus deallocateFlag ( const MString  pluginName,
unsigned int  flag 
) [static]

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:
Examples:
maTranslator/maTranslator.cpp.
MStatus deallocateAllFlags ( const MString  pluginName ) [static]

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 
)

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:
Examples:
maTranslator/maTranslator.cpp.
bool isFlagSet ( unsigned int  flag,
MStatus ReturnStatus = NULL 
) const

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:
bool isDefaultNode ( MStatus ReturnStatus = NULL ) const

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:
MStatus setDoNotWrite ( bool  flag )

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

Returns the do not write state of the node.

Will be 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:
bool hasAttribute ( const MString attrName,
MStatus ReturnStatus = NULL 
) const

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:
Examples:
AshliShader/GLSLShaderNode.cpp.
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.

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:
bool setAlias ( const MString alias,
const MString name,
const MPlug plug,
bool  add = true,
MStatus ReturnStatus = NULL 
)

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:
bool findAlias ( const MString alias,
MObject attrObj,
MStatus ReturnStatus = NULL 
) const

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:
bool getAliasList ( MStringArray strArray,
MStatus ReturnStatus = NULL 
)

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

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:
MStatus setIcon ( const MString filename )

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:
MString icon ( MStatus ReturnStatus = NULL ) const

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:
MString setName ( const MString name,
MStatus ReturnStatus 
)

OBSOLETE FUNCTION, NO SCRIPT SUPPORT.

This method is obsolete. This method is not available in Python.

Deprecated:
This function is obsolete, please use the other 'setName' instead
Parameters:
[in] name
[out] ReturnStatus
bool getPlugsAlias ( const MPlug plug,
MString aliasName,
MStatus ReturnStatus = NULL 
)

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:
const adsk::Data::Associations * metadata ( MStatus ReturnStatus = NULL ) const [virtual]

This method is not available in Python.

Get the current metadata associated with this node.

Parameters:
[out] ReturnStatus Status code. See below.
Returns:
Metadata associated with the node, NULL if there isn't any
Status Codes:

Reimplemented in MFnMesh.

MStatus setMetadata ( const adsk::Data::Associations newMetadata ) [virtual]

This method is not available in Python.

Replace the existing metadata with the given values.

Parameters:
[in] newMetadata The new associated metadata for this node
Returns:
Status code
Status Codes:

Reimplemented in MFnMesh.

MStatus deleteMetadata ( ) [virtual]

This method is not available in Python.

Remove all metadata from this node.

Returns:
Status code
Status Codes:
MStatus validateMetadata ( MString errors ) const [virtual]

This method is not available in Python.

Verify consistency in all of the existing metadata channels The intended use of this method is to check that the metadata channels are still internally consistent after operations have been performed on any underlying associated data.

It's not meant to provide data validation (e.g. make sure a certain data in a channel is within it's legal range).

Parameters:
[out] errors String containing information about what went wrong
Returns:
Status code
Status Codes:

Reimplemented in MFnMesh.

void enableDGTiming ( bool  enable ) [static]

Globally enables or disables the DG node timing mechanism.

There are two levels of control for DG node timing. dgTimerOn() and dgTimerOff() are used to determine which nodes are eligible for timer data collection and this method is used to globally enable or disable the DG node timing mechanism.

For example, if you want to collect timing information for nodes X and Y you would call their dgTimerOn() methods and then call this method to enable timing. Those two nodes would then begin collecting timing data.

If you subsequently call this method to disable timing then X and Y will cease collecting timing data but the data already collected would still be available (e.g. using dgTimer()).

If you later use this method to re-enable timing then X and Y would resume collecting data. Note that this method does not clear the nodes' timing data. If you want a clean start you would have to call dgTimerReset() individually on X and Y.

Parameters:
[in] enable flag to turn timing on or off.
MStatus dgTimerOn ( )

Indicates that this node should collect DG timing data whenever DG timing is enabled.

See enableDGTiming() for more details.

Note that this method does not reset the timers and counters on the node, it merely enables (or re-enables) timer data collection for the node and subsequent timing values are added to the current timer and counter values. If you want the counters to be reset, use the method dgTimerReset().

To stop the node from collecting further timing data, use dgTimerOff().

Calls to dgTimerOn() and dgTimerOff() are not cumulative. Even if you call dgTimerOn() three times for a node it still only takes a single call to dgTimerOff() to disable its data collection.

Returns:
Status code
Status Codes:
MStatus dgTimerOff ( )

Indicates that this node should no longer collect DG timing data when DG timing is enabled.

See dgTimerOn() and enableDGTiming() for more details.

Any timing data which has already been collected remains available, for example, using the dgTimer() method.

Returns:
Status code
Status Codes:
MFnDependencyNode::MdgTimerState dgTimerQueryState ( MStatus ReturnStatus = NULL )

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:
MStatus dgTimerReset ( )

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:
double dgTimer ( const MdgTimerMetric  timerMetric,
const MdgTimerType  timerType,
MStatus ReturnStatus = NULL 
) const

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:
MStatus dgCallbacks ( const MdgTimerType  timerType,
MStringArray callbackName,
MDoubleArray value 
)

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:
MStatus dgCallbackIds ( const MdgTimerType  timerType,
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.

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:
MStatus addAttribute ( const MObject attr,
MFnDependencyNode::MAttrClass  type 
)

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 
)

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

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