Go to: Synopsis. Flags. Return value. Related. MEL examples.

Synopsis

directionalLight [-decayRate int] [-discRadius float] [-edit] [-intensity float] [-name string] [-query] [-rgb float float float] [-shadowColor float float float] [-shadowDither float] [-shadowSamples int] [-softShadow boolean] [-useRayTraceShadows boolean]

directionalLight is undoable, queryable, and editable.

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.

Flags

decayRate, discRadius, edit, intensity, name, query, rgb, shadowColor, shadowDither, shadowSamples, softShadow, useRayTraceShadows
Long name (short name) [argument types] Properties
-edit(-e) edit
edit the parameters of an existing light
-query(-q) query
Puts the command in query mode so that it will return the value of the specified flag.

In query mode, this flag needs a value.
-decayRate(-d) int createqueryedit
decay rate of the light (0-no decay, 1-slow, 2-realistic, 3-fast)

In query mode, this flag needs a value.
-discRadius(-drs) float createqueryedit
radius of the disc around the light

In query mode, this flag needs a value.
-rgb(-rgb) float float float createqueryedit
color of the light (0-1)

In query mode, this flag needs a value.
-intensity(-i) float createqueryedit
intensity of the light (expressed as a percentage)

In query mode, this flag needs a value.
-name(-n) string createqueryedit
specify the name of the light

In query mode, this flag needs a value.
-useRayTraceShadows(-rs) boolean createqueryedit
ray trace shadows

In query mode, this flag needs a value.
-shadowColor(-sc) float float float createqueryedit
the shadow color

In query mode, this flag needs a value.
-shadowDither(-sd) float createqueryedit
dither the shadow

In query mode, this flag needs a value.
-shadowSamples(-sh) int createqueryedit
number of shadow samples.

In query mode, this flag needs a value.
-softShadow(-ss) boolean createqueryedit
soft shadow

In query mode, this flag needs a value.
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 be used more than once in a command

Return value


[string] (light name)

Related

ambientLight, exclusiveLightCheckBox, lightList, lightListEditor, lightListPanel, lightlink, pointLight, spotLight, spotLightPreviewPort

MEL examples

// Create a directional light
string $light = `directionalLight -rotation 45 30 15`;

// Change the light intensity
directionalLight -e -intensity 0.5 $light;

// Query it
directionalLight -q -intensity $light;
// Result:0.5//