Skip to content

Layer3d

Layer3d#

(3d)

No corresponding User page.

Description#

The layer 3D renders a 3D scene viewed through a camera, using a renderer and a set of lights and objects.

Public Attributes#

Type Name Visual Hint Description
bool enable_deep_output VISUAL_HINT_DEFAULT If checked, the image is flagged to be rendered and saved to disk at the specified output path. Note the image supports rendering sequences. If you wish to export a still, make sure first frame and last frame have the same value.
string save_deep_data_as VISUAL_HINT_FILENAME_SAVE Set the image output filename without file extension (EXR will be used). Please note that the frame number is automatically appended to the filename.
long deep_output_channels VISUAL_HINT_DEFAULT Only the selected channels will be written out.
bool deep_output_raw_samples VISUAL_HINT_DEFAULT If checked, samples are not post-processed (merged/alpha-blended).
long deep_output_file_type VISUAL_HINT_DEFAULT Data will be stored in the specfied format.
long deep_output_data_precision VISUAL_HINT_DEFAULT Data channels will be stored using the selected data format. Depth channels are not impacted: they are always stored using 32-bit precision.
double merge_threshold VISUAL_HINT_DISTANCE If the Z distance between two samples is lower than the threshold, the samples will be merged.
long max_sample_count VISUAL_HINT_DEFAULT If set, the number of samples per pixel will be limited. Samples farthest from the camera will be ignored.
long pixel_aspect_ratio_mode VISUAL_HINT_DEFAULT Set how the pixel aspect ratio is defined.
double pixel_aspect_ratio VISUAL_HINT_DEFAULT Set the pixel aspect ratio to use during the rendering. This can affect the field of view.
reference (Group) shadows VISUAL_HINT_GROUP Select objects used to compute shadows.
reference (Group) raytracing VISUAL_HINT_GROUP Select objects used to compute reflection and refraction.
reference (Group) global_illumination VISUAL_HINT_GROUP Select objects used for global illumination.
reference (Group) matte_objects VISUAL_HINT_GROUP Select objects that will be considered matte for primary rays.
double[3] matte_color VISUAL_HINT_COLOR Defines the matte objects color.
double matte_alpha VISUAL_HINT_PERCENTAGE Defines the matte objects opacity.
double near_clip VISUAL_HINT_DISTANCE Set the distance of the near clipping plane.
long far_clip_mode VISUAL_HINT_DEFAULT Set the clipping mode for the far clipping mode. Infinite mode does not clip.
double custom_far_clip VISUAL_HINT_DISTANCE Set the distance of the far clipping plane.
bool export_shading_aovs VISUAL_HINT_DEFAULT Compute and write AOVs defined in the shading graph
reference (Group) light_path_expressions VISUAL_HINT_DEFAULT List of light path expressions to export in AOV's.
reference (Group) arbitrary_output_variables VISUAL_HINT_DEFAULT List of aov stores to export in AOV's.
object[] (SubPixelFilter) sub_pixel_filters VISUAL_HINT_DEFAULT List of sub pixel filters to apply on the layer.
bool enable_uv_bake VISUAL_HINT_DEFAULT When enabled, the render is done in the UV space of a geometry.
reference (SceneObject) uv_bake_geometry VISUAL_HINT_DEFAULT Set the geometry to use for the baking.
reference (UvSlot) uv_bake_slot VISUAL_HINT_DEFAULT Define which UV slot is used for the baking.
double[4] uv_bake_range VISUAL_HINT_DEFAULT Set the UV window to use for the baking (left, bottom, right, top).
long uv_bake_eye_direction VISUAL_HINT_DEFAULT Set the direction of the eye for the baking.
long uv_bake_projection_mode VISUAL_HINT_DEFAULT Specify the mode of the projection baking. If set to Outside the ray will be launched along the normal and bake the first hit surface. When set to Inside, the ray will be launched in the inverse direction of the normal.
long uv_bake_projection_normal VISUAL_HINT_DEFAULT Specify which normal it should use to launch the ray from.
double uv_bake_projection_offset VISUAL_HINT_DISTANCE Distance from which the ray is launched from the geometry.
double uv_bake_projection_distance VISUAL_HINT_DISTANCE Maximum distance to look for another geometry. When set to 0, the distance is infinite.

Inherited Public Attributes#

Type Name Visual Hint Description
long blending VISUAL_HINT_DEFAULT Set the blending mode of current layer. Depending on the mode the layer will blend differently over the bottom layer. Blending mode has no effect if there's only one layer in the image.
double opacity VISUAL_HINT_PERCENTAGE Set the opacity of the layer. An opacity value of 50% will make the layer 50% transparent.
long[2] pre_filter_offset VISUAL_HINT_PIXEL Pre-filtered position of the layer in the canvas. This position the one before filtering. Each time the layer is translated, filters are reapplied.
long limited_region_mode VISUAL_HINT_DEFAULT Uses the limited region set by the parent image or the region set below.
double[4] limited_region VISUAL_HINT_PERCENTAGE Region of interest to be rendered: x, y, width, height in percentages of the image visible window size.
bool use_image_margin VISUAL_HINT_DEFAULT
long margin_mode VISUAL_HINT_DEFAULT Set the mode to use to determine the size of the overscan.
long[4] margin_pixel VISUAL_HINT_PIXEL Set the overscan for the current layer: Left, Top, Right, Bottom
double[4] margin_ratio VISUAL_HINT_PERCENTAGE Set the overscan for the current layer: Left, Top, Right, Bottom
object[] (ImageFilter) filters VISUAL_HINT_DEFAULT List of image filters that are applied to the layer. This filters are applied procedurally. Each time the layer is modified, all the filters in list are reapplied to the layer.
string output_layer VISUAL_HINT_TAG Select the aov channel to use RGBA. Other channels are discarded. Selecting 'all' disable the filter.
long alpha_channel VISUAL_HINT_DEFAULT Use default: the 4th channel of the output layer is used as alpha. Use custom channel: the channel specified below is used as alpha.
string custom_channel_name VISUAL_HINT_ENUM The specified channel will be written in the alpha channel
bool render_to_disk VISUAL_HINT_DEFAULT If checked, the image is flagged to be rendered and saved to disk at the specified output path. Note the image supports rendering sequences. If you wish to export a still, make sure first frame and last frame have the same value.
string save_as VISUAL_HINT_FILENAME_SAVE Set the image output filename, without file extension. Please note that the frame number is automatically appended to the filename.
long first_frame VISUAL_HINT_FRAME Set the first output render frame range. If set to 10, the rendering of the image will start at frame 10.
long last_frame VISUAL_HINT_FRAME Set the last output render frame range. If set to 20, the rendering of the image will stop at frame 20.
long frame_step VISUAL_HINT_FRAME Set the output render frame step. The frame step is simply the frame increment between two renders in the frame range defined by first and last frame.
long format VISUAL_HINT_DEFAULT Image output fileformat.
string LUT VISUAL_HINT_ENUM Select the color correction to apply to the output image.
long open_exr_output_compression_mode VISUAL_HINT_DEFAULT Set the OpenEXR output compression mode.
string metadata VISUAL_HINT_SCRIPT Declare custom metadata to write in the EXR header.
reference (Camera) active_camera VISUAL_HINT_DEFAULT Set the camera to use to render the scene
reference (RendererRaytracer) renderer VISUAL_HINT_DEFAULT Set the renderer to use for the scene
reference (Group) lights VISUAL_HINT_GROUP Select objects used for ligthing.
reference (Group) geometries VISUAL_HINT_GROUP Select the geometries used by the layer.
reference (Material) override_material VISUAL_HINT_DEFAULT The selected material will override all materials of the scene.
reference (ShadingLayer) shading_layer VISUAL_HINT_DEFAULT The selected shading layer will override materials of the scene according to its name mapping rules.

CID#

class "Layer3d" "LayerScene" {
    #version 0.97
    icon "../icons/object_icons/layer3d.iconrc"
    doc "The layer 3D renders a 3D scene viewed through a camera, using a renderer and a set of lights and objects."
    attribute_group "output>deep" {
        collapsed yes
        bool "enable_deep_output" {
            doc "If checked, the image is flagged to be rendered and saved to disk at the specified output path. Note the image supports rendering sequences. If you wish to export a still, make sure first frame and last frame have the same value."
            value no
        }
        filename_save "save_deep_data_as" {
            doc "Set the image output filename without file extension (EXR will be used). Please note that the frame number is automatically appended to the filename."
            output "none"
            dg_active no
            read_only yes
            value ""
        }
        long "deep_output_channels" {
            doc "Only the selected channels will be written out."
            preset "RGBA" "0"
            preset "Alpha" "1"
            value 0
        }
        bool "deep_output_raw_samples" {
            doc "If checked, samples are not post-processed (merged/alpha-blended)."
            value no
        }
        long "deep_output_file_type" {
            doc "Data will be stored in the specfied format."
            preset "Scanline" "0"
            preset "Tiled" "1"
            value 0
        }
        long "deep_output_data_precision" {
            doc "Data channels will be stored using the selected data format. Depth channels are not impacted: they are always stored using 32-bit precision."
            preset "Half (16-bit)" "0"
            preset "Float (32-bit)" "1"
            value 0
        }
        distance "merge_threshold" {
            doc "If the Z distance between two samples is lower than the threshold, the samples will be merged."
            value 0.01
        }
        long "max_sample_count" {
            doc "If set, the number of samples per pixel will be limited. Samples farthest from the camera will be ignored."
            value 0
        }
    }
    attribute_group "rendering" {
        long "pixel_aspect_ratio_mode" {
            doc "Set how the pixel aspect ratio is defined."
            preset "Use Image Display Ratio" "0"
            preset "Custom Value" "1"
            value 1
        }
        double "pixel_aspect_ratio" {
            doc "Set the pixel aspect ratio to use during the rendering. This can affect the field of view."
            numeric_range yes 0.0001 1.79769313486232e+308
            ui_range yes 0.1 10
            value 1
        }
    }
    attribute_group "rendering>visibility" {
        doc "For each category, set which objects are visible (used) to render the scene."
        group "shadows" {
            doc "Select objects used to compute shadows."
            filter "SceneObject"
            null_label "Use Current Context"
            input "shading" "motion" "geometry"
            dg_active no
            value ""
        }
        reference "__shadows__" {
            filter "Group"
            input "shading" "motion" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "raytracing" {
            doc "Select objects used to compute reflection and refraction."
            filter "SceneObject"
            null_label "Use Current Context"
            input "shading" "motion" "geometry"
            dg_active no
            value ""
        }
        reference "__raytracing__" {
            filter "Group"
            input "shading" "motion" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "global_illumination" {
            doc "Select objects used for global illumination."
            filter "SceneObject"
            null_label "Use Current Context"
            input "shading" "motion" "geometry"
            dg_active no
            value ""
        }
        reference "__global_illumination__" {
            filter "Group"
            input "shading" "motion" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        group "matte_objects" {
            doc "Select objects that will be considered matte for primary rays."
            filter "SceneObject"
            input "shading" "motion" "geometry"
            dirtiness_pass_through yes
            value ""
        }
        reference "visibility" {
            doc "Internal attribute referencing the internal group of visibility objects when there is a group plugged in the matte objects."
            filter "Group"
            input "shading" "motion" "geometry"
            private yes
            hidden yes
            saveable no
            dirtiness_pass_through yes
            value ""
        }
        color "matte_color" {
            doc "Defines the matte objects color."
            animatable yes
            value 0.0 0.0 0.0
        }
        percentage "matte_alpha" {
            doc "Defines the matte objects opacity."
            animatable yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
    }
    attribute_group "rendering>clipping" {
        doc "Defines the near and far clipping planes. Objects between the camera and the near clipping plane or beyond the far clipping plane will be ignored."
        collapsed yes
        distance "near_clip" {
            doc "Set the distance of the near clipping plane."
            animatable yes
            numeric_range yes 0.0 2147483647
            ui_range yes 0.0 2147483647
            value 0.0
        }
        long "far_clip_mode" {
            doc "Set the clipping mode for the far clipping mode. Infinite mode does not clip."
            preset "Infinite" "0"
            preset "Custom" "1"
            value 0
        }
        distance "custom_far_clip" {
            doc "Set the distance of the far clipping plane."
            animatable yes
            numeric_range yes 0.0 2147483647
            ui_range yes 0.0 2147483647
            read_only yes
            value 1
        }
    }
    attribute_group "AOV" {
        collapsed yes
        bool "export_shading_aovs" {
            doc "Compute and write AOVs defined in the shading graph"
            output "image"
            value yes
        }
        list<reference> "light_path_expressions" {
            doc "List of light path expressions to export in AOV\'s."
            filter "Group" "LightPathExpression"
            value <empty>
        }
        list<reference> "arbitrary_output_variables" {
            doc "List of aov stores to export in AOV\'s."
            filter "Group" "AovStore"
            value <empty>
        }
        string[] "selected_aov_list" {
            hidden yes
            value <empty>
        }
        bool[] "enabled_aov_list" {
            hidden yes
            value <empty>
        }
        long[] "aov_blend_override_list" {
            hidden yes
            value <empty>
        }
    }
    attribute_group "subpixel_filters" {
        collapsed yes
        object[] "sub_pixel_filters" {
            doc "List of sub pixel filters to apply on the layer."
            filter "SubPixelFilter"
            value <empty>
        }
    }
    attribute_group "uv_baking" {
        collapsed yes
        bool "enable_uv_bake" {
            doc "When enabled, the render is done in the UV space of a geometry."
            value no
        }
        reference "uv_bake_geometry" {
            doc "Set the geometry to use for the baking."
            filter "SceneObject"
            input "motion" "geometry"
            read_only yes
            value ""
        }
        reference "uv_bake_slot" {
            doc "Define which UV slot is used for the baking."
            filter "UvSlot"
            context "default:/"
            null_label "Use First Available"
            read_only yes
            value ""
        }
        double[4] "uv_bake_range" {
            doc "Set the UV window to use for the baking (left, bottom, right, top)."
            ui_range yes -10 10
            read_only yes
            value 0.0 0.0 1 1
        }
        long "uv_bake_eye_direction" {
            doc "Set the direction of the eye for the baking."
            preset "Normal" "0"
            preset "Camera" "1"
            value 0
        }
        long "uv_bake_projection_mode" {
            doc "Specify the mode of the projection baking. If set to Outside the ray will be launched along the normal and bake the first hit surface. When set to Inside, the ray will be launched in the inverse direction of the normal."
            read_only yes
            preset "Disabled" "0"
            preset "Inside" "1"
            preset "Outside" "2"
            preset "Inside & Outside" "3"
            value 0
        }
        long "uv_bake_projection_normal" {
            doc "Specify which normal it should use to launch the ray from."
            read_only yes
            preset "Flat" "0"
            preset "Smooth" "1"
            value 1
        }
        distance "uv_bake_projection_offset" {
            doc "Distance from which the ray is launched from the geometry."
            texturable yes
            animatable yes
            ui_range yes -1 1
            read_only yes
            value 0.0
        }
        distance "uv_bake_projection_distance" {
            doc "Maximum distance to look for another geometry. When set to 0, the distance is infinite."
            null_label "Infinite"
            null_value "0.0"
            texturable yes
            animatable yes
            numeric_range yes 0.0 1.79769313486232e+308
            ui_range yes 0.0 100
            read_only yes
            value 0.0
        }
    }
    set "comp_mode" {
        private no
        hidden yes
        saveable yes
        texturable no
        animatable no
        slider no
        numeric_range no 0.0 1
        ui_range no 0.0 1
        dg_active yes
        dg_cyclic no
        dirtiness_pass_through no
        read_only no
        shading_variable no
        experimental no
        advanced no
        overriden no
        promote_attribute no
        allow_expression yes
        localizable yes
        preset "Resize" "0"
        preset "No Resize" "1"
        value 0
    }
}