TextureGradient

TextureGradient#

(Gradient)

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

Description#

Map a color ramp to an input parameter.

Public Attributes#

Type	Name	Visual Hint	Description
`long`	`mode`	`VISUAL_HINT_DEFAULT`	Set the input parameter mode for the gradient: Incidence uses the ray/surface angle, Slope uses the surface, Y-axis angle, Input uses a texturable color.
`double`	`input`	`VISUAL_HINT_DEFAULT`	Define a texturable input color when Mode is set to Input.
`reference` (`UvSlot`)	`uv_slot`	`VISUAL_HINT_DEFAULT`	Define which UV slot is used when Mode is set to UV.
`reference` (`SceneItem`)	`incidence_locator`	`VISUAL_HINT_DEFAULT`	Define an object to use instead of camera rays to compute the angle when Mode is set to Incidence.
`curve[4]`	`output`	`VISUAL_HINT_GRADIENT`	The Ramp that will be mapped to the input parameter.

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 "TextureGradient" "Texture" {
    #version 0.93
    icon "../icons/object_icons/texture_gradient.iconrc"
    category "/Texture/Utility"
    doc "Map a color ramp to an input parameter."
    attribute_group "input" {
        long "mode" {
            doc "Set the input parameter mode for the gradient: Incidence uses the ray/surface angle, Slope uses the surface, Y-axis angle, Input uses a texturable color."
            preset "Incidence" "0"
            preset "Slope (Object)" "1"
            preset "Slope (World)" "2"
            preset "Slope (Shading)" "3"
            preset "Input" "4"
            preset "Parametric U" "5"
            preset "Parametric V" "6"
            preset "Parametric UV" "7"
            preset "UV Map U" "8"
            preset "UV Map V" "9"
            preset "UV Map UV" "10"
            value 4
        }
        double "input" {
            doc "Define a texturable input color when Mode is set to Input."
            texturable yes
            animatable yes
            value 0.0
        }
        reference "uv_slot" {
            doc "Define which UV slot is used when Mode is set to UV."
            filter "UvSlot"
            context "default:/"
            null_label "Use First Available"
            read_only yes
            value ""
        }
        reference "incidence_locator" {
            doc "Define an object to use instead of camera rays to compute the angle when Mode is set to Incidence."
            filter "SceneItem"
            null_label "Use Renderer Camera"
            read_only yes
            value ""
        }
    }
    attribute_group "remap" {
        gradient[4] "output" {
            doc "The Ramp that will be mapped to the input parameter."
            value[] {
                key 0 0.0 1 0.0 0.0 0.0 0.0 0.0 0.0 0.0 yes yes no yes
            }
            value[1] {
                key 0 0.0 1 0.0 0.0 0.0 0.0 0.0 0.0 0.0 yes yes no yes
            }
            value[2] {
                key 0 0.0 1 0.0 0.0 0.0 0.0 0.0 0.0 0.0 yes yes no yes
            }
            value[3] {
                key 0 0.0 1 0.0 0.0 0.0 0.0 0.0 0.0 0.0 yes yes no yes
            }
        }
    }
    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 "input"
    }
}