Contact Support

AttributeFile_In

This node reads in an attribute file from a specified location and applies the attribute changes to the scene graph locations specified by the CEL statement.

Connection Type

Connection Name

Function

Input

input

The place in the node graph where you want to read in an attribute file.

 

Control (UI)

Default Value

Function

CEL

N/A

The scene graph locations are specified using the Collection Expression Language (CEL). The CEL 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.

File Path

N/A

Describes the filepath to an Attributes File.

For more information, refer to the Asset and File Path Widget Types in the Common Parameter Widgets.

Custom File Parser

N/A

Specifies the .so file with the Attributes File parser. Leave it empty to use the default one.

For more information, refer to the Asset and File Path Widget Types in the Common Parameter Widgets.

Attribute Group Name

attributeFile

Specifies the name of the group attribute where the attributes from the file are stored. When empty, the attributes are stored directly under the location (without a group attribute).

Apply When

immediate

Determines when the script runs:

immediate - the filter runs at the locations specified by the CEL statement as they are evaluated at this node's point in the graph.

deferred or during katana standard resolve - the script and its arguments are added as attributes under the scenegraphLocationModifers group attribute. When deferred, they are run later by the implicit ScenegraphLocationModifierResolve filter added at render time. When during katana standard resolve, they are evaluated by a LookFileResolve node or by the first implicit resolver if no LookFileResolve node is present. (They may be tested either by enabling implicit scene graph resolvers in the Scene Graph tab or with a ScenegraphLocationModifierResolve node.)

during material resolve - the script and its arguments are added as attributes under the material. Scene GraphLocationModifers group attribute. This is primarily intended for material scene graph locations. The material resolve process evaluates the script at the locations at which the material is assign or applied. This can be useful for building randomization or procedural control over shader parameters at the material level without having to apply materialOverride attributes at the geometry level.

Recursive Enable

No

When applying in a non-immediate state, enabling this results in the script running at every location beneath the assigned locations. In general this is more efficient than using an equivalent recursive CEL statement.

timing

mode

Current Frame

Sets the timing mode to apply to the asset:

Current Frame - uses the current frame to access the attribute file.

Hold Frame - uses the frame specified by holdTime to access the attribute file.

Clamp Range - forces Katana to only apply the attributes stored in the attributes file between the inTime and outTime frames. For before and after the clamp range, the frames specified by inTime and outTime respectively are used.

timing > mode: Hold Frame

holdTime

globals.inTime
(an expression)

Specifies which frame to use.

timing > mode: Clamp Range

inTime

globals.inTime
(an expression)

Specifies the start frame for the clamp range. It is also used for all frames before the inTime.

outTime

globals.outTime
(an expression)

Specifies the end frame for the clamp range. It is also used for all frames after the outTime.