StandardAttributes

Modifies the standard attributes on objects - these should be respected by all renderers.

user

Container for user-defined plugs. Nodes should never make their own plugs here, so users are free to do as they wish.

out

The processed output scene.

enabled

The on/off state of the node. When it is off, the node outputs the input scene unchanged.

in

The input scene

filter

The filter used to control which parts of the scene are processed. A Filter node should be connected here.

global

Causes the node to be applied to the scene globals instead of the individual locations defined by the filter.

attributes

The attributes to be applied - arbitrary numbers of user defined attributes may be added as children of this plug via the user interface, or using the CompoundDataPlug API via python.

attributes.scene:visible

Whether or not the object can be seen - invisible objects are not sent to the renderer at all. Typically more fine grained (camera, reflection etc) visibility can be specified using a renderer specific attributes node. Note that making a parent location invisible will always make all the children invisible too, regardless of their visibility settings.

attributes.doubleSided

Whether or not the object can be seen from both sides. Single sided objects appear invisible when seen from the back.

attributes.render:displayColor

The default colour used to display the object in the absence of a specific shader assignment. Commonly used to control basic object appearance in the Viewer.

Tip

For more detailed control of object appearance in the Viewer, use OpenGL attributes.

attributes.gaffer:transformBlur

Whether or not transformation animation on the object is taken into account in the rendered image. Use the gaffer:transformBlurSegments attribute to specify the number of segments used to represent the motion.

attributes.gaffer:transformBlurSegments

The number of segments of transform animation to pass to the renderer when Transform Blur is on.

attributes.gaffer:deformationBlur

Whether or not deformation animation on the object is taken into account in the rendered image. Use the gaffer:deformationBlurSegments attribute to specify the number of segments used to represent the motion.

attributes.gaffer:deformationBlurSegments

The number of segments of deformation animation to pass to the renderer when Deformation Blur is on.

attributes.linkedLights

The lights to be linked to this object. Accepts a set expression or a space separated list of lights. Use “defaultLights” to refer to all lights that contribute to illumination by default.

Examples

All the default lights plus the lights in the characterLights set :

defaultLights | characterLights

All the default lights, but without the lights in the interiorLights set :

defaultLights - interiorLights

Info : Lights can be added to sets either by using the sets plug on the light node itself, or by using a separate Set node.

attributes.linkedLights:exclusions

The lights never to be linked to this object, even when they are included by the linkedLights attribute. Accepts a set expression or a space separated list of lights.

Tip

Since linkedLights defaults to “defaultLights”, exclusions take effect even when no linkedLights attribute has been created.

attributes.shadowedLights

The lights that cast shadows from this object. Accepts a set expression or a space separated list of lights.

attributes.shadowedLights:exclusions

The lights that never cast shadows from this object, even when they are included by the shadowedLights attribute. Accepts a set expression or a space separated list of lights.

Tip

Since shadowedLights defaults to “__lights”, exclusions take effect even when no shadowedLights attribute has been created.

attributes.filteredLights

The lights to be filtered by this light filter. Accepts a set expression or a space separated list of lights. Use “defaultLights” to refer to all lights that contribute to illumination by default.

attributes.filteredLights:exclusions

The lights that are never filtered by this light filter, even when they are included by the filteredLights attribute. Accepts a set expression or a space separated list of lights. Has no effect unless filteredLights specifies lights to be filtered.

attributes.gaffer:automaticInstancing

By default, if Gaffer sees two objects are identical, it will pass them to the renderer only once, saving a lot of memory. You can set this to false to disable that, losing the memory savings. This can be useful in certain cases like using world space displacement and wanting multiple copies to displace differently. Disabling is currently only supported by the Arnold and RenderMan renderer backends.

extraAttributes

An additional set of attributes to be added. Arbitrary numbers of attributes may be specified within a single IECore.CompoundObject, where each key/value pair in the object defines an attribute. This is convenient when using an expression to define the attributes and the attribute count might be dynamic. It can also be used to create attributes whose type cannot be handled by the attributes CompoundDataPlug, with IECoreScene.ShaderNetwork being one example.

If the same attribute is defined by both the attributes and the extraAttributes plugs, then the value from the extraAttributes is taken.