MDagPath

Base Class

None.

Constants

None.

Static Methods

NameParametersReturnsDescription
getAllPathsTo(node) node - MObject MDagPathArray Returns all paths to the given node.
getAPathTo(node) node - MObject MDagPath Returns the first path found to the given node.

Static Attributes

None.

Constructors

SignatureParametersDescription
MDagPath()   Default constructor. Returns a new, empty MDagPath object.
MDagPath(src) src - MDagPath Copy constructor. Returns a new MDagPath object with the same value as src.

Object Methods

SignatureParametersReturnsDescription
apiType()   MFn constant Returns the type of the object at the end of the path.
child(childNum) childNum - int MObject The childNum'th object parented directly beneath the object at the end of the path.
childCount()   int Returns the number of objects parented directly beneath the object at the end of the path.
exclusiveMatrix()   MMatrix Returns the matrix for all transforms in the path, excluding the end object.
exclusiveMatrixInverse()   MMatrix Returns the inverse of exclusiveMatrix().
extendToShape(shapeNum=0) shapeNum - int New reference to self. Extends the path to the shapeNum'th shape node parented directly beneath the transform at the current end of the path.
fullPathName()   string Returns a string representation of the path from the DAG root to the path's last node.
getPath(pathNum=0) pathNum - int MDagPath The pathNum'th sub-path of this path.
hasFn(type) type - MFn constant bool Returns True if the object at the end of the path supports the function set represented by type.
inclusiveMatrix()   MMatrix Returns the matrix for all transforms in the path, including the end object, if it is a transform.
inclusiveMatrixInverse()   MMatrix Returns the inverse of inclusiveMatrix().
instanceNumber()   int Returns the instance number of this path to the object at the end.
isInstanced()   bool Returns True if the object at the end of the path can be reached by more than one path.
isValid()   bool True if this is a valid path.
length()   int Returns the number of nodes on the path, not including the DAG's root node.
node()   MObject Returns the DAG node at the end of the path.
numberOfShapesDirectlyBelow()   int Returns the number of shape nodes parented directly beneath the transform at the end of the path. If the path does not end at a transform, or if the transform has no shape nodes directly beneath it, 0 will be returned.
partialPathName()   string Returns the minimum string representation which will uniquely identify the path.
pathCount()   int Returns the number of sub-paths which make up this path.
pop(num=1) num - int New reference to self. Removes num objects from the end of the path.
push(child) child - MObject New reference to self. Extends the path to the specified child object, which must be parented directly beneath the object currently at the end of the path.
set(path) path - MDagPath New reference to self. Replaces the current path held by this object with that of path.
transform()   MObject Returns the last transform node on the path.

Object Attributes

None.

Sequence Support

None.

Number Support

None.

Comparison Support

== True if both paths refer to the same instance of the same node.
!= True if the paths refer to different nodes or different instances of the same node.

All other comparison operators will raise a TypeError exception.

© 2011 Autodesk, Inc. All rights reserved.