pymel.core.general.listRelatives

listRelatives(*args, **kwargs)

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

Maya Bug Fix:
  • allDescendents and shapes flags did not work in combination
  • noIntermediate doesn’t appear to work
Modifications:
  • returns an empty list when the result is None

  • returns wrapped classes

  • fullPath is forced on to ensure that all returned node paths are unique

    rtype:DependNode list
Flags:
Long name (short name) Argument Types Properties
allDescendents (ad) bool ../../../_images/create.gif
 

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) bool ../../../_images/create.gif
 
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) bool ../../../_images/create.gif
 
List all the children of this dag node (default).
fullPath (f) bool ../../../_images/create.gif
 
Return full pathnames instead of object names.
noIntermediate (ni) bool ../../../_images/create.gif
 
No intermediate objects
parent (p) bool ../../../_images/create.gif
 
Returns the parent of this dag node
path (pa) bool ../../../_images/create.gif
 
Return a proper object name that can be passed to other commands.
shapes (s) bool ../../../_images/create.gif
 
List all the children of this dag node that are shapes (ie, not transforms)
type (typ) unicode ../../../_images/create.gif
 
List all relatives of the specified type.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.listRelatives

Example:

import pymel.core as pm

import maya.cmds as cmds

# create an object and an instance for queries
pm.sphere( n='nexus' )
# Result: [nt.Transform(u'nexus'), nt.MakeNurbSphere(u'makeNurbSphere1')] #
pm.instance( n='ball' )
# Result: [nt.Transform(u'ball')] #

# List the name of the shape below the transform node.
shapes = pm.listRelatives('nexus')

# list all parents of shape
# (The result of the command is shown)
pm.listRelatives( shapes[0], allParents=True )
# Result: [nt.Transform(u'nexus'), nt.Transform(u'ball')] #

Previous topic

pymel.core.general.listNodeTypes

Next topic

pymel.core.general.listSets

Core

Core Modules

Other Modules

This Page