pymel.core.general.createDisplayLayer

createDisplayLayer(*args, **kwargs)

Create a new display layer. The display layer number will be assigned based on the first unassigned number not less than the base index number found in the display layer global parameters. Normally all objects and their descendants will be added to the new display layer but if the ‘-nr’ flag is specified then only the objects themselves will be added.

Modifications:
  • returns a PyNode object

Flags:

Long Name / Short Name Argument Types Properties
empty / e bool ../../../_images/create.gif
  If set then create an empty display layer. ie. Do not add the selected items to the new display layer.
makeCurrent / mc bool ../../../_images/create.gif
  If set then make the new display layer the current one.
name / n unicode ../../../_images/create.gif
  Name of the new display layer being created.
noRecurse / nr bool ../../../_images/create.gif
  If set then only add selected objects to the display layer. Otherwise all descendants of the selected objects will also be added.
number / num int ../../../_images/create.gif
  Number for the new display layer being created. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.createDisplayLayer

Example:

import pymel.core as pm

#    Create a sphere.
#
objectArray = pm.sphere()
#    Select the sphere.
#
pm.select( objectArray[0] )
#    Create a layer. The selected object will be placed
#    in this layer. Note in this case both the nurbsSphere
#    and nurbsSphere shape are placed in the layer.
#
pm.createDisplayLayer()
# Result: nt.DisplayLayer(u'displayLayer') #
#    Create a cone.
#
objectArray = pm.cone()
#    Select the cone.
#
pm.select( objectArray[0] )
#    Create a layer but only put the nurbsCone in the layer.
#    The nurbsConeShape will remain in the default layer
#    as a result of specifying the -nr/noRecurse flag.
#
#    Note also that you can specify the name of the layer
#    with the -n/name flag.
#
pm.createDisplayLayer( noRecurse=True, name='ExampleLayer' )
# Result: nt.DisplayLayer(u'ExampleLayer') #