TextureScope

TextureScope#

(Scope)

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

Description#

Defines a 3D gradient with an inside region transitioning to an outside region, expressed a set of simple geometric shapes, aka scopes.

Public Attributes#

Type	Name	Visual Hint	Description
`double[3]`	`inside_color`	`VISUAL_HINT_COLOR`	Inside region color.
`double[3]`	`outside_color`	`VISUAL_HINT_COLOR`	Outside region color.
`long`	`dimensions`	`VISUAL_HINT_DEFAULT`	Dimension(s) on which the gradient is applied.
`long`	`mode`	`VISUAL_HINT_DEFAULT`	Mode used to combine the scopes in the set below.
`reference` (`Scope`)	`scopes`	`VISUAL_HINT_DEFAULT`	Set of scopes (or groups of scopes) to combine.

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 "TextureScope" "Texture" {
    #version 1
    icon "../icons/object_icons/texture_scope.iconrc"
    category "/Texture/Utility"
    doc "Defines a 3D gradient with an inside region transitioning to an outside region, expressed a set of simple geometric shapes, aka scopes."
    default_name "texture_scope"
    attribute_group "color" {
        color "inside_color" {
            doc "Inside region color."
            texturable yes
            animatable yes
            value 1 1 1
        }
        color "outside_color" {
            doc "Outside region color."
            texturable yes
            animatable yes
            value 0.0 0.0 0.0
        }
        long "dimensions" {
            doc "Dimension(s) on which the gradient is applied."
            preset "XYZ" "0"
            preset "XY" "1"
            preset "XZ" "2"
            preset "YZ" "3"
            preset "X" "4"
            preset "Y" "5"
            preset "Z" "6"
            value 0
        }
        long "mode" {
            doc "Mode used to combine the scopes in the set below."
            preset "Union" "0"
            preset "Intersection" "1"
            value 0
        }
        list<reference> "scopes" {
            doc "Set of scopes (or groups of scopes) to combine."
            filter "Scope" "Group"
            dg_cyclic yes
            value <empty>
        }
    }
}