Class: Brush

Brush(actionopt, typeopt)

Brush object used to determine how to paint voxels on the scene.

Constructor

new Brush(actionopt, typeopt)

Creates a new brush object.

Parameters:
Name Type Attributes Default Description
action string <optional>
"add"

Adding, removing, or painting voxels

type string <optional>
"single"

How to go about the actions

Source:

Methods

getCurrentAction() → {string}

Gets the current brush action.

Source:
Returns:

The current action

Type
string

getCurrentType() → {string}

Gets the current brush type.

Source:
Returns:

The current type

Type
string

setCurrentAction(brushAction)

Sets the current brush action to one of the available brush options.

Parameters:
Name Type Description
brushAction string
Source:

setCurrentType(brushType)

Sets the current brush type to one of the available brush types.

Parameters:
Name Type Description
brushType string
Source: