Go to: Synopsis. Return value. Flags. Python examples.
listRelatives(
[objects]
, [allDescendents=boolean], [allParents=boolean], [children=boolean], [fullPath=boolean], [noIntermediate=boolean], [parent=boolean], [path=boolean], [shapes=boolean], [type=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
listRelatives is undoable, NOT queryable, and NOT editable.
This command lists parents and children of DAG objects. The flags
-c/children, -ad/allDescendents, -s/shapes, -p/parent and -ap/allParents
are mutually exclusive. Only one can be used in a command.
Unlike ls, this command does not return a unique path but simply returns
the object's name by default. To get a unique path the -path flag must
be used.
When listing parents of objects directly under the world, the command
will return an empty parent list. Listing parents of objects directly
under a shape (underworld objects) will return their containing shape
node in the list of parents. Listing parents of components of objects
will return the object.
When listing children, shape nodes will return their underworld
objects in the list of children. Listing children of components of
objects returns nothing.
The -ni/noIntermediate flag works with the -s/shapes flag.
It causes any intermediate shapes among the descendents to be ignored.
allDescendents, allParents, children, fullPath, noIntermediate, parent, path, shapes, type
| Long name (short name) |
Argument types |
Properties |
|
allDescendents(ad)
|
boolean
|
|
|
Returns all the children, grand-children etc. of
this dag node. If a descendent is instanced,
it will appear only once on the list returned.
Note that it lists grand-children before children.
|
|
allParents(ap)
|
boolean
|
|
|
Returns all the parents of this dag node. Normally, this
command only returns the parent corresponding to the first
instance of the object
|
|
children(c)
|
boolean
|
|
|
List all the children of this dag node (default).
|
|
fullPath(f)
|
boolean
|
|
|
Return full pathnames instead of object names.
|
|
noIntermediate(ni)
|
boolean
|
|
|
|
parent(p)
|
boolean
|
|
|
Returns the parent of this dag node
|
|
path(pa)
|
boolean
|
|
|
Return a proper object name that can be passed to other commands.
|
|
shapes(s)
|
boolean
|
|
|
List all the children of this dag node that are
shapes (ie, not transforms)
|
|
type(typ)
|
string
|
|
|
List all relatives of the specified type.
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
# create an object and an instance for queries
cmds.sphere( n='nexus' )
cmds.instance( n='ball' )
# List the name of the shape below the transform node.
shapes = cmds.listRelatives('nexus')
# list all parents of shape
# (The result of the command is shown)
cmds.listRelatives( shapes[0], allParents=True )
# Result:[u'nexus', u'ball'] #