Key Locations ============= .. contents:: Table of Contents :depth: 2 :local: ``/root`` ~~~~~~~~~ The ``/root`` group is located at the top of the hierarchy and contains collections, output settings, and global render settings. Most of these attributes are not inherited. .. list-table:: :header-rows: 1 :widths: 5 20 75 - * Type * Attribute * Description - * :kat:type:`group` * :kat:attr:`GlobalStatements` * This defines global renderer-specific settings and has a different name depending on which renderer is used, for instance :kat:attr:`prmanGlobalStatements`, :kat:attr:`arnoldGlobalStatements`, and similar. - * :kat:type:`string` * :kat:attr:`collections..cel` * The CEL statement for a named collection. - * :kat:type:`string[]` * :kat:attr:`collections..baked` * A list of scene graph location paths baked from the CEL statement of a named collection. Render Settings ''''''''''''''' .. list-table:: :header-rows: 1 :widths: 5 20 75 - * Type * Attribute * Description - * :kat:type:`string` * :kat:attr:`renderSettings.cameraName` * The scene graph location of the camera; for example, :kat:loc:`/root/world/cam/camera`. - * :kat:type:`string` * :kat:attr:`renderSettings.renderer` * The name of the renderer plug-in to use when starting a render; for example, ``prman`` - * :kat:type:`string` * :kat:attr:`renderSettings.resolution` * The render resolution preset, for example, ``512sq``. - * :kat:type:`float[4]` * :kat:attr:`renderSettings.overscan` * Overscan value in pixels, in the order: left, bottom, right, top. - * :kat:type:`string` * :kat:attr:`renderSettings.adjustScreenWindow` * The method for auto-adjusting the pixel ratio. - * :kat:type:`int` * :kat:attr:`renderSettings.maxTimeSamples` * Defines how many times a point is sampled when the shutter is open. - * :kat:type:`float` * :kat:attr:`renderSettings.shutterOpen` :kat:attr:`renderSettings.shutterClose` * The timing of the opening and closing of the camera shutter. The shutter begins opening at t=0, and finishes opening at ``shutterOpen``. The shutter begins closing at ``shutterClose``, and finishes closing at t=1. - * :kat:type:`float` * :kat:attr:`renderSettings.currentTime` * The time of the frame for which the scene has been cooked, as set in the timeline of the Katana main window. - * :kat:type:`float[4]` * :kat:attr:`renderSettings.cropWindow` * The render crop window in normalized co-ordinates, in the order: xmin xmax ymin ymax. - * :kat:type:`string[]` * :kat:attr:`renderSettings.interactiveOutputs` * Indicates which outputs (as defined in :kat:attr:`renderSettings.outputs`) to use for interactive renders (Preview and Live Renders). - * :kat:type:`int` * :kat:attr:`renderSettings.producerCaching.limitProducerCaching` * Controls how the Katana procedural caches potentially terminal scene graph locations. Pass Settings ''''''''''''' .. list-table:: :header-rows: 1 :widths: 5 20 75 - * Type * Attribute * Description - * :kat:type:`group` * :kat:attr:`renderSettings.outputs.` * Contains a sub group for every render pass. The default pass is named ``primary``. The :kat:attr:`rendererSettings`/:kat:attr:`locationSettings` are configurable per output. Output types are customizable by plug-ins. For instance, a color output has different :kat:attr:`rendererSettings` than a shadow output. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..type` * The type of output. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..includedByDefault` * When enabled, this render definition is sent to the Render node. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..rendererSettings.colorspace` * The color space. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..rendererSettings.fileExtension` * The file extension of the output file. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..rendererSettings.channel` * The channel of the output file. - * :kat:type:`group` * :kat:attr:`renderSettings.outputs..rendererSettings.convertSettings` * Attribute group with file format-dependent conversion settings. - * :kat:type:`int` * :kat:attr:`renderSettings.outputs..rendererSettings.clampOutput` * Post-render, clamps negative RGB values to 0 and alpha values to 0-1. - * :kat:type:`int` * :kat:attr:`renderSettings.outputs..rendererSettings.colorConvert` * If ``1``, converts the rendered image data from linear to the output colorspace specified in the filename post-render. The colorspace is determined by OCIO's ``parseColorSpaceFromString()`` function, which locates the longest, right-most colorspace substring. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..rendererSettings.cameraName` * Scene graph location to render from. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..rendererSettings.locationType` * The type of location. - * :kat:type:`group` * :kat:attr:`renderSettings.outputs..rendererSettings.exrheaders` * List of EXR headers to inject. - * :kat:type:`string` * :kat:attr:`renderSettings.outputs..locationSettings.renderLocation` * The file path and name of the output. ``/root/world`` ~~~~~~~~~~~~~~~ This group defines attributes that are inherited by the whole world, for instance, geometry, cameras, or lights. Some attributes like the :kat:attr:`lightList` are inherited further down the hierarchy; others like :kat:attr:`globals`, however, define universal settings and are not inherited. Camera and Light Lists '''''''''''''''''''''' .. list-table:: :header-rows: 1 :widths: 5 20 75 - * Type * Attribute * Description - * :kat:type:`string[]` * :kat:attr:`globals.cameraList` * The list of scene graph locations of cameras; for example, :kat:loc:`/root/world/cam/camera` and :kat:loc:`/root/world/cam/camera2`. - * :kat:type:`group` * :kat:attr:`lightList.` * A sub-group for every light and light filter; for example, ``lightList.root_world_lgt_gaffer_light1``. - * :kat:type:`string` * :kat:attr:`lightList..path` * Scene graph location of the light or light filter, for example, :kat:loc:`/root/world/lgt/gaffer/light1`. - * :kat:type:`int` * :kat:attr:`lightList..enable` * Defines whether the light or light filter is enabled. - * :kat:type:`string` * :kat:attr:`lightList..type` * Type of light list entry, either ``light filter`` or ``light filter reference``. If this attribute is not set, the entry is assumed to be for a light. - * :kat:type:`string` * :kat:attr:`lightList..inherits` * For light filters only - the scene graph location this light filter should inherit its attributes from. - * :kat:type:`string` * :kat:attr:`lightList..referencePath` * For light filter references only - the scene graph location this light filter reference should inherit its attributes from. - * :kat:type:`string` * :kat:attr:`globals.coordinateSystems.` * Defines a new co-ordinate system at the specified scene graph location. - * :kat:type:`string[]` * :kat:attr:`globals.itemLists.` * Defines a custom item list. When node graph subtrees are merged via a :kat:node:`Merge` node, the contents of item lists are unioned rather than the left-most input being used. ``/root/world/geo`` ~~~~~~~~~~~~~~~~~~~ Top-level group for :doc:`geometry `. ``/root/world/cam`` ~~~~~~~~~~~~~~~~~~~ Top-level group for :ref:`cameras `. ``/root/world/lgt`` ~~~~~~~~~~~~~~~~~~~ Top-level group for :ref:`lights `. ``/root/materials`` ~~~~~~~~~~~~~~~~~~~ Top-level group for :doc:`materials ` ``/root/materials/proc`` ~~~~~~~~~~~~~~~~~~~~~~~~ Top-level group for :ref:`renderer procedurals `.