ToolEraser

ToolEraser#

(Tool Eraser)

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

No corresponding User page.

Description#

Eraser base definition to decimate particles and properties in Point Cloud objects.

Public Attributes#

Type	Name	Visual Hint	Description
`long`	`eraser_type`	`VISUAL_HINT_DEFAULT`	Shape of the Eraser.
`double`	`eraser_size`	`VISUAL_HINT_DEFAULT`	Distance between 2 consecutive occurrences (diameter).
`double`	`eraser_thickness`	`VISUAL_HINT_DEFAULT`	Height of the Eraser (applies only for Cylinder shape).
`long`	`eraser_unit`	`VISUAL_HINT_DEFAULT`	Eraser Size considered in screen or world space.
`double`	`eraser_strength`	`VISUAL_HINT_PERCENTAGE`	Modulates the number of modified values.
`double`	`eraser_falloff`	`VISUAL_HINT_PERCENTAGE`	Distribution factor. Higher value decimates more points near the center of the Eraser.
`long`	`eraser_pressure_mapping`	`VISUAL_HINT_DEFAULT`	Defines how pressure is taken into account.

CID#

class "ToolEraser" "ProjectItem" {
    #version 0.9
    icon "../icons/object_icons/tool_paintbrush.iconrc"
    category "Brush"
    doc "Eraser base definition to decimate particles and properties in Point Cloud objects."
    attribute_group "eraser" {
        long "eraser_type" {
            doc "Shape of the Eraser."
            preset "Sphere" "0"
            preset "Cylinder" "1"
            preset "Hemisphere" "2"
            preset "Punch" "3"
            value 3
        }
        double "eraser_size" {
            doc "Distance between 2 consecutive occurrences (diameter)."
            slider yes
            numeric_range yes 0.0 1.79769313486232e+308
            ui_range yes 0.0 250
            value 1
        }
        double "eraser_thickness" {
            doc "Height of the Eraser (applies only for Cylinder shape)."
            numeric_range yes 0.0 1.79769313486232e+308
            read_only yes
            value 1
        }
        long "eraser_unit" {
            doc "Eraser Size considered in screen or world space."
            preset "Screen" "0"
            preset "World" "1"
            value 0
        }
        percentage "eraser_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 "eraser_falloff" {
            doc "Distribution factor. Higher value decimates more points near the center of the Eraser."
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.0
        }
        long "eraser_pressure_mapping" {
            doc "Defines how pressure is taken into account."
            preset "Strength" "2"
            preset "Size" "1"
            preset "Strength+Size" "3"
            preset "None" "0"
            value 2
        }
        string "ui_name" {
            private yes
            saveable no
            value "eraser"
        }
    }
}