ToolBrush

ToolBrush#

(Tool Brush)

Category: Brush
Default object name: tool_brush
Inherits from: ProjectItem

No corresponding User page.

Description#

Brush base definition to edit particles and properties in Point Cloud objects.

Public Attributes#

Type	Name	Visual Hint	Description
`long`	`brush_type`	`VISUAL_HINT_DEFAULT`	Shape of the Brush.
`double`	`brush_size`	`VISUAL_HINT_DEFAULT`	Distance between 2 consecutive occurences (diameter).
`double`	`brush_thickness`	`VISUAL_HINT_DEFAULT`	Height of the Brush (applies only for Cylinder shape).
`long`	`brush_unit`	`VISUAL_HINT_DEFAULT`	Brush Size considered in screen or world space.
`long`	`brush_density`	`VISUAL_HINT_DEFAULT`	Number of particles in Brush.
`double`	`brush_strength`	`VISUAL_HINT_PERCENTAGE`	Modulates the number of modified values.
`double`	`brush_falloff`	`VISUAL_HINT_PERCENTAGE`	Points distribution factor. Higher value creates more points near the center of the Brush.
`curve`	`brush_curve`	`VISUAL_HINT_DEFAULT`	Points distribution factor. Higher value creates more points.
`long`	`brush_pressure_mapping`	`VISUAL_HINT_DEFAULT`	Defines how pressure is taken into account.

CID#

class "ToolBrush" "ProjectItem" {
    #version 0.9
    icon "../icons/object_icons/tool_paintbrush.iconrc"
    category "Brush"
    doc "Brush base definition to edit particles and properties in Point Cloud objects."
    attribute_group "brush" {
        long "brush_type" {
            doc "Shape of the Brush."
            preset "View" "7"
            preset "Sphere" "0"
            preset "Flat Disk" "1"
            preset "Hemisphere" "2"
            preset "Projected Disk" "3"
            value 7
        }
        double "brush_size" {
            doc "Distance between 2 consecutive occurences (diameter)."
            slider yes
            numeric_range yes 0.0 1.79769313486232e+308
            ui_range yes 0.0 250
            value 1
        }
        double "brush_thickness" {
            doc "Height of the Brush (applies only for Cylinder shape)."
            numeric_range yes 0.0 1.79769313486232e+308
            read_only yes
            value 1
        }
        long "brush_unit" {
            doc "Brush Size considered in screen or world space."
            preset "Screen" "0"
            preset "World" "1"
            value 0
        }
        long "brush_density" {
            doc "Number of particles in Brush."
            slider yes
            numeric_range yes 1 2147483647
            ui_range yes 1 500
            value 16
        }
        percentage "brush_strength" {
            doc "Modulates the number of modified values."
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 1
        }
        percentage "brush_falloff" {
            doc "Points distribution factor. Higher value creates more points near the center of the Brush."
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
        curve "brush_curve" {
            doc "Points distribution factor. Higher value creates more points."
            value[] {
                key 0 0.0 0.0 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
                key 0 1 1 0.0 0.0 0.0 -0.3333 0.0 0.3333 0.0 yes yes no yes
            }
        }
        long "brush_pressure_mapping" {
            doc "Defines how pressure is taken into account."
            preset "Density" "2"
            preset "Size" "1"
            preset "Density+Size" "3"
            preset "None" "0"
            value 2
        }
        string "ui_name" {
            private yes
            saveable no
            value "brush"
        }
    }
}