TextureZDepth

TextureZDepth#

(Z Depth)

Category: /Texture/Utility
Default object name: z_depth
Inherits from: ProjectItem > TextureOperator > Texture

Description#

Map two colors using the Z depth as blending parameter.

Public Attributes#

Type	Name	Visual Hint	Description
`double[3]`	`near_color`	`VISUAL_HINT_COLOR`	Color mapped to the near plane.
`double[3]`	`far_color`	`VISUAL_HINT_COLOR`	Color mapped to the far plane.
`bool`	`clamp`	`VISUAL_HINT_DEFAULT`	If checked, clamp the input colors mapped to the near and far planes.
`long`	`near_mode`	`VISUAL_HINT_DEFAULT`	Defines whether to use the 3D layer for the near clipping plane or to use a custom value.
`double`	`near_distance`	`VISUAL_HINT_DISTANCE`	Set the near clipping plane value when Near Mode is set to Custom.
`long`	`far_mode`	`VISUAL_HINT_DEFAULT`	Defines whether to use the 3D layer for the far clipping plane or to use a custom value.
`double`	`far_distance`	`VISUAL_HINT_DISTANCE`	Set the far clipping plane value when Far Mode is set to Custom.

Inherited Public Attributes#

Type	Name	Visual Hint	Description
`bool`	`pass_through`	`VISUAL_HINT_DEFAULT`	If checked, the current texture is not evaluated and the value of the attribute selected in Pass Through Attribute is directly forwarded.
`string`	`master_input`	`VISUAL_HINT_TAG`	Name of the attribute that will be used as output if Pass Through is enabled.
`bool`	`invert`	`VISUAL_HINT_DEFAULT`	If checked, the texture is inverted.
`double`	`opacity`	`VISUAL_HINT_PERCENTAGE`	Set the opacity of the texture.

CID#

class "TextureZDepth" "Texture" {
    #version 0.9
    icon "../icons/object_icons/texture_z_depth.iconrc"
    category "/Texture/Utility"
    doc "Map two colors using the Z depth as blending parameter."
    attribute_group "input" {
        color "near_color" {
            doc "Color mapped to the near plane."
            texturable yes
            animatable yes
            value 1 1 1
        }
        color "far_color" {
            doc "Color mapped to the far plane."
            texturable yes
            animatable yes
            value 0.0 0.0 0.0
        }
    }
    attribute_group "range" {
        bool "clamp" {
            doc "If checked, clamp the input colors mapped to the near and far planes."
            animatable yes
            value yes
        }
        long "near_mode" {
            doc "Defines whether to use the 3D layer for the near clipping plane or to use a custom value."
            preset "Use Layer 3D" "0"
            preset "Custom" "1"
            value 0
        }
        distance "near_distance" {
            doc "Set the near clipping plane value when Near Mode is set to Custom."
            texturable yes
            animatable yes
            numeric_range yes 0.0 2147483647
            ui_range yes 0.0 2147483647
            read_only yes
            value 0.0
        }
        long "far_mode" {
            doc "Defines whether to use the 3D layer for the far clipping plane or to use a custom value."
            preset "Use Layer 3D" "0"
            preset "Custom" "1"
            value 0
        }
        distance "far_distance" {
            doc "Set the far clipping plane value when Far Mode is set to Custom."
            texturable yes
            animatable yes
            numeric_range yes 0.0 2147483647
            ui_range yes 0.0 2147483647
            read_only yes
            value 1
        }
    }
    set "master_input" {
        private no
        hidden no
        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
        value "near_color"
    }
}