Search Tips

Search is based on keyword.

`Ex: "Procedures"`

Do not search with natural language

`Ex: "How do I write a new procedure?"`

Give Feedback Support Portal

# LightLinkSetup

The LightLinkSetup node is an alternative to the LightLink node and sets the attributes on the lightList at the /root/world location instead of the object's scene graph location. It allows the node to set light linking options for locations that don't exist at that point in the node graph. These options are resolved by implicit resolvers or can be resolved manually by a LightLinkResolve node.

Connection Type | Connection Name | Function
Input | in | The light whose attributes you want to set on the lightList.

Control (UI) | Default Value | Function
clearUnmatched | disabled | When linking is resolved, the clearUnmatched parameter determines whether or not existing light linking attributes for this light are removed from locations that do not match the on or off expressions. The effect of this parameter is only visible in the Attributes tab when linking has been resolved, which means after a LightLinkResolve node or when Implicit Resolvers are active. Examines the lightList attribute on your linked objects to ensure that the attributes have been set correctly. If the attribute has been disabled, the value of the enable child attribute in the lightList attribute for your light is 0; otherwise, the default enabled setting is 1.
action | append linking information | Determines how light linking settings from this node are merged with settings in the incoming scene. If this light doesn't exist in the incoming scene, this option has no effect. • append linking information - the new attributes are appended to the incoming options. Where conflicts occur, the attributes that are set from this node are used. • override linking information - the linking options set in this node override information from the incoming scene options.
effect | illumination | Determines whether the link is acting upon the light's illumination or shadow visibility of the specified objects: • illumination • shadow visibility • custom Note: Shadow visibility is only currently respected by Arnold renders.
effect: custom
customAttrName | custom | Specifies a custom attribute name to set on the lightList for your object scene graph locations. The value of the custom parameter becomes the attribute name that is set on the object scene graph location for each light. When a LightLinkSetup node is used with a LightLinkResolve node, for instance, if the: • light parameter is set to /root/world/lgt/spotlight, • custom parameter is set to myAttr, • off CEL parameter is set to /root/world/geo/pony, Then • /root/world/geo/pony has an attribute named lightList.root_world_lgt_spotlight.myAttr, whose value is set to 0. Note: If you've added a LightLinkSetup node only and have not linked it to a LightLinkResolve node, the attribute on /root/world/geo/pony is not set.
light | N/A | Specifies the scene graph location of the light you want to apply the lighting quality of the effect parameter from. For more information, refer to the Scene Graph Location Widget Type in the Common Parameter Widgets.
initialState | use existing value | Determines the initial value for the specified effect in the light list entry for this light: • use existing value - the attribute uses the value of the attribute in the incoming scene if applicable. • on - sets the initial value to 1. • off - sets the initial value to 0.
LightLinkSetup parameters continued
on | N/A | Links matching locations to the effect specified in the effect parameter. The scene graph locations are specified using the Collection Expression Language (CEL). The on parameter options are available by clicking Add Statements. For more information, refer to the CEL Reference document found on the documentation HTML page (accessed through Help > Documentation) or the CEL Statement Widget Type in Common Parameter Widgets.
off | N/A | Disables the effect specified in the effect parameter for the matching locations. The scene graph locations are specified using the Collection Expression Language (CEL). The off parameter options are available by clicking Add Statements. For more information, refer to the CEL Reference document found on the documentation HTML page (accessed through Help > Documentation) or the CEL Statement Widget Type in Common Parameter Widgets.