pymel.core.rendering.directionalLight

directionalLight(*args, **kwargs)

The directionalLight command is used to edit the parameters of existing directionalLights, or to create new ones. The default behaviour is to create a new directionallight.

Maya Bug Fix:
  • name flag was ignored
Flags:
Long name (short name) Argument Types Properties
decayRate (d) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
decay rate of the light (0-no decay, 1-slow, 2-realistic, 3-fast)
discRadius (drs) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
radius of the disc around the light
exclusive (exc) bool ../../../_images/query.gif ../../../_images/edit.gif
   
intensity (i) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
intensity of the light (expressed as a percentage)
name (n) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
specify the name of the light
position (pos) float, float, float ../../../_images/query.gif ../../../_images/edit.gif
   
rgb (rgb) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
color of the light (0-1)
rotation (rot) float, float, float ../../../_images/query.gif ../../../_images/edit.gif
   
shadowColor (sc) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
the shadow color
shadowDither (sd) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
dither the shadow
shadowSamples (sh) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
number of shadow samples.
softShadow (ss) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
soft shadowFlag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
useRayTraceShadows (rs) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
ray trace shadows

Derived from mel command maya.cmds.directionalLight

Example:

import pymel.core as pm

# Create a directional light
light = pm.directionalLight(rotation=(45, 30, 15))

# Change the light intensity
pm.directionalLight( light, e=True, intensity=0.5 )

# Query it
pm.directionalLight( light, q=True, intensity=True )
# Result: 0.5 #
# Result:0.5#