TextureCellularNoise

TextureCellularNoise#

(Cellular Noise)

Category: /Texture/Procedural
Default object name: cellular_noise
Inherits from: ProjectItem > TextureOperator > Texture > TextureSpatial

Description#

Cell-like noise pattern based on Worley noise.

Public Attributes#

Type	Name	Visual Hint	Description
`double[3]`	`cell_color`	`VISUAL_HINT_COLOR`	Define the color of the cell.
`double[3]`	`border_color`	`VISUAL_HINT_COLOR`	Define the color of the border.
`long`	`pattern`	`VISUAL_HINT_DEFAULT`	Define the pattern to be used.
`double[3]`	`jitter`	`VISUAL_HINT_PERCENTAGE`	Define the jitterness of the pattern. If no jitter is set, all cells are aligned to a grid.
`double[3]`	`frequency`	`VISUAL_HINT_DEFAULT`	Define the scale of the pattern indenpendently from texture projection.
`long`	`border_mode`	`VISUAL_HINT_DEFAULT`	Define how the cell borders are computed.
`double`	`border_amount`	`VISUAL_HINT_PERCENTAGE`	Define how the borders are bleeding into the cell.
`double`	`border_size`	`VISUAL_HINT_PERCENTAGE`	Define how much border is getting inside the cell.

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.
`long`	`projection`	`VISUAL_HINT_DEFAULT`	Define the projection used to evaluate the texture.
`long`	`space`	`VISUAL_HINT_DEFAULT`	Define whether the texture is evaluated in 2D or 3D. In 2D space, the texture is stretched along the projection axis whereas in 3D space all components are used.
`long`	`axis`	`VISUAL_HINT_DEFAULT`	Define the projection axis.
`reference` (`UvSlot`)	`uv_slot`	`VISUAL_HINT_DEFAULT`	Define which UV slot is used when the project mode is set to UV.
`long`	`object_space`	`VISUAL_HINT_DEFAULT`	Set the space in which the object must be considered when computing the projection.
`string`	`reference_positions`	`VISUAL_HINT_TAG`	Set the name of the property that contains reference positions of the geometry that have to be used when computing projections.
`string`	`uv_property`	`VISUAL_HINT_TAG`	Set the name of the property that contains uv's of the geometry that have to be used when computing projections.
`reference` (`Camera`)	`camera`	`VISUAL_HINT_DEFAULT`	Define which camera is used when the texture is in Camera projection mode.
`bool`	`camera_occlusion`	`VISUAL_HINT_DEFAULT`	When on the texture looks for potential occluder between the sample position and the camera. If no occluder is found the sample gets mapped.
`reference` (`Group`)	`camera_occluders`	`VISUAL_HINT_GROUP`	Define which geometries are occluders when camera occlusion is enabled. By default it uses the 3D layer geometries.
`reference` (`SceneItem`)	`reference_object`	`VISUAL_HINT_DEFAULT`	If an object is selected, the texture will use the object's transformation matrix to compute the texture coordinates.
`double[3]`	`projection_translate`	`VISUAL_HINT_DISTANCE`	Offset the position of the projection. Enable with Planar, Cylindrical, Spherical, Cubic.
`double[3]`	`projection_rotate`	`VISUAL_HINT_ANGLE`	Offset the rotation of the projection. Enable with Planar, Cylindrical, Spherical, Cubic.
`double[3]`	`projection_scale`	`VISUAL_HINT_SCALE`	Offset the scaling of the projection. Enable with Planar, Cylindrical, Spherical, Cubic.
`action`	`fit_to_bounding_box`	`VISUAL_HINT_DEFAULT`
`double[3]`	`uv_translate`	`VISUAL_HINT_DISTANCE`	Offset the UV by the specified values in UVW space.
`double[3]`	`uv_rotate`	`VISUAL_HINT_ANGLE`	Rotate the UV by the specified values in UVW space.
`double[3]`	`uv_scale`	`VISUAL_HINT_SCALE`	Scale the UV by the specified values in UVW space.

CID#

class "TextureCellularNoise" "TextureSpatial" {
    #version 0.91
    icon "../icons/object_icons/texture_cellular_noise.iconrc"
    category "/Texture/Procedural"
    doc "Cell-like noise pattern based on Worley noise."
    attribute_group "pattern" {
        color "cell_color" {
            doc "Define the color of the cell."
            texturable yes
            animatable yes
            value 0.0 0.0 0.0
        }
        color "border_color" {
            doc "Define the color of the border."
            texturable yes
            animatable yes
            value 1 1 1
        }
        long "pattern" {
            doc "Define the pattern to be used."
            preset "Dot" "1"
            preset "Scale" "2"
            value 1
        }
        percentage[3] "jitter" {
            doc "Define the jitterness of the pattern. If no jitter is set, all cells are aligned to a grid."
            texturable yes
            animatable yes
            slider yes
            ui_range yes 0.0 1
            value 1 1 1
        }
        double[3] "frequency" {
            doc "Define the scale of the pattern indenpendently from texture projection."
            texturable yes
            animatable yes
            ui_range yes 0.01 20
            value 5 5 5
        }
        long "border_mode" {
            doc "Define how the cell borders are computed."
            preset "No Border" "0"
            preset "Step" "1"
            preset "Linear" "2"
            preset "Smooth" "3"
            value 0
        }
        percentage "border_amount" {
            doc "Define how the borders are bleeding into the cell."
            texturable yes
            animatable yes
            slider yes
            ui_range yes 0.0 1
            read_only yes
            value 0.5
        }
        percentage "border_size" {
            doc "Define how much border is getting inside the cell."
            texturable yes
            animatable yes
            slider yes
            ui_range yes 0.0 1
            read_only yes
            value 0.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 "cell_color"
    }
}