Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

shadingLightRelCtx([exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string], [offCommand=string], [onCommand=string], [shadingCentric=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

shadingLightRelCtx is undoable, queryable, and editable.

This command creates a context that can be used for associating lights to shading groups. You can put the context into shading-centric mode by using the -shadingCentric flag and specifying true. This means that the shading group is selected first then lights associated with the shading group are highlighted. Subsequent selections result in assignments.

Specifying -shadingCentric false means that the light is to be selected first. The shading groups associated with the light will then be selected and subsequent selections will result in assignments being made.

Return value

stringName of the context created.

In query mode, return type is based on queried flag.

Flags

exists, history, image1, image2, image3, name, offCommand, onCommand, shadingCentric
Long name (short name) Argument types Properties
exists(ex) boolean create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
image1(i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
image2(i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
image3(i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
name(n) string create
If this is a tool command, name the tool appropriately.
offCommand(ofc) string createqueryedit
command to be issued when context is turned on
onCommand(onc) string createqueryedit
command to be issued when context is turned on
shadingCentric(s) boolean createqueryedit
shading-centric mode.

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.

Python examples

import maya.cmds as cmds

cmds.shadingLightRelCtx()