Skip to content

ShadingLayer

ShadingLayer#

(Shading Layer)

  • Default object name: shading_layer
  • Inherits from: ProjectItem

Go to User page.

Description#

Object containing rules to override object materials

Public Attributes#

Type Name Visual Hint Description
reference (SearchPath) search_paths VISUAL_HINT_DEFAULT Use the input search path to resolve rules starting with ./. If none is specified then ./ corresponds to the current context of the shading layer.
long data_source_priority VISUAL_HINT_DEFAULT Change data source priority. Defines which data source will be chosen if both objects and Shading Layer have one. (ex: object has a material, and has also a rule which applies to it in Shading Layer)
reference (ShadingLayer) children_shading_layers VISUAL_HINT_DEFAULT Children shading layers, to be evaluated after their parent.

CID#

class "ShadingLayer" "ProjectItem" {
    #version 0.94
    icon "../icons/object_icons/shadinglayer.iconrc"
    doc "Object containing rules to override object materials"
    string[] "selected_columns" {
        doc "Specifies which attributes are used"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "shading_layer_is_active" {
        doc "Specify whether the shading layers are active or not"
        hidden yes
        dg_active no
        value <empty>
    }
    string[] "shading_layer_filters" {
        doc "Name filters to match rule with objects names"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "is_visible" {
        doc "if we want the matching objects to be visible or not"
        hidden yes
        dg_active no
        value <empty>
    }
    reference[] "material" {
        doc "Materials assigned to the filters"
        filter "Material"
        hidden yes
        dg_active no
        value <empty>
    }
    reference[] "displacement" {
        doc "Displacements assigned to the filters"
        filter "Displacement"
        hidden yes
        dg_active no
        value <empty>
    }
    string[] "shading_variables" {
        doc "Shading variable assigned to the filters"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "enable_motion_blur" {
        doc "enable motion blur or not"
        hidden yes
        dg_active no
        value <empty>
    }
    double[] "raytrace_offset" {
        doc "raytrace offset"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "unseen_by_camera" {
        doc "unseen by camera"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "unseen_by_rays" {
        doc "unseen by rays"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "cast_shadows" {
        doc "cast shadows"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "receive_shadows" {
        doc "receive shadows"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "is_emitter" {
        doc "is_emitter"
        hidden yes
        dg_active no
        value <empty>
    }
    bool "internal_dirtiness" {
        doc "Propagate dirtiness when shading layer module is modified."
        private yes
        saveable no
        value no
    }
    reference[] "lights" {
        doc "lights groups"
        hidden yes
        dg_active no
        value <empty>
    }
    bool[] "matte_object" {
        doc "matte object flag"
        hidden yes
        dg_active no
        value <empty>
    }
    double[] "matte_color" {
        doc "matte color"
        hidden yes
        dg_active no
        value <empty>
    }
    double[] "matte_alpha" {
        doc "matte color"
        hidden yes
        dg_active no
        value <empty>
    }
    reference[] "clip_map" {
        doc "clip map"
        filter "Texture"
        hidden yes
        dg_active no
        value <empty>
    }
    reference[] "runtime_materials" {
        doc "Runtime material objects, to be notified when they change."
        private yes
        saveable no
        value <empty>
    }
    bool[] "values_states" {
        doc "Rules values states. Specifies if values are used or not. (flat array: rules count * columns count)"
        hidden yes
        dg_active no
        value <empty>
    }
    string[] "override_info" {
        doc "Attributes override information to be applied in-order. [ActionType|Location|Data] ex (schematic): [AddRule|Position|AttributesValues]. See ShadingLayerOverrideInfo for more information."
        hidden yes
        value <empty>
    }
    attribute_group "settings" {
        reference "search_paths" {
            doc "Use the input search path to resolve rules starting with ./. If none is specified then ./ corresponds to the current context of the shading layer."
            filter "SearchPath"
            value ""
        }
        long "data_source_priority" {
            doc "Change data source priority. Defines which data source will be chosen if both objects and Shading Layer have one. (ex: object has a material, and has also a rule which applies to it in Shading Layer)"
            preset "Rules data has priority" "0"
            preset "Objects data has priority" "1"
            value 0
        }
        list<reference> "children_shading_layers" {
            doc "Children shading layers, to be evaluated after their parent."
            filter "ShadingLayer" "Group"
            dirtiness_pass_through yes
            value <empty>
        }
    }
}