Class: AdvancedBrush

Default/Tools/Brush/AdvancedBrushTool.AdvancedBrush

Hierarchy

• BrushTool

  ↳ AdvancedBrush

Constructors

constructor

• new AdvancedBrush(): AdvancedBrush

Returns

AdvancedBrush

Inherited from

BrushTool.constructor

Properties

_dt

• _dt: DataTool

Inherited from

BrushTool._dt

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:22

---

_update

• _update: boolean = true

Inherited from

BrushTool._update

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:19

---

_worldPainter

• _worldPainter: WorldPainter

Inherited from

BrushTool._worldPainter

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:20

---

data

• data: AddVoxelData

Inherited from

BrushTool.data

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:9

---

location

• location: LocationData

Inherited from

BrushTool.location

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:4

---

mode

• mode: TaskRunModes = "async"

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:10

Accessors

dimension

• get dimension(): string

Returns

string

Inherited from

BrushTool.dimension

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:6

• set dimension(dimension): void

Parameters

Name	Type
dimension	string

Returns

void

Inherited from

BrushTool.dimension

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:9

---

x

• get x(): number

Returns

number

Inherited from

BrushTool.x

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:13

• set x(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

BrushTool.x

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:16

---

y

• get y(): number

Returns

number

Inherited from

BrushTool.y

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:20

• set y(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

BrushTool.y

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:23

---

z

• get z(): number

Returns

number

Inherited from

BrushTool.z

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:27

• set z(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

BrushTool.z

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:30

Methods

clear

▸ clear(): void

Returns

void

Inherited from

BrushTool.clear

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:71

---

erase

▸ erase(): AdvancedBrush

Returns

AdvancedBrush

Inherited from

BrushTool.erase

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:128

---

eraseAndAwaitUpdate

▸ eraseAndAwaitUpdate(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:22

---

eraseAndUpdate

▸ eraseAndUpdate(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:43

---

explode

▸ explode(radius?, onDone?): void

Parameters

Name	Type	Default value
radius	number	6
onDone?	Function	undefined

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:71

---

explodeAwaitUpdate

▸ explodeAwaitUpdate(radius?): Promise<unknown>

Parameters

Name	Type	Default value
radius	number	6

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:77

---

getData

▸ getData(): AddVoxelData

Returns

AddVoxelData

Inherited from

BrushTool.getData

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:119

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

BrushTool.getLocation

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:39

---

getRaw

▸ getRaw(): RawVoxelData

Returns

RawVoxelData

Inherited from

BrushTool.getRaw

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:98

---

getXYZ

▸ getXYZ(): Object

Returns

Object

Name	Type
x	number
y	number
z	number

Inherited from

BrushTool.getXYZ

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:46

---

getXYZAsArray

▸ getXYZAsArray(): Vec3Array

Returns

Vec3Array

Inherited from

BrushTool.getXYZAsArray

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:43

---

paint

▸ paint(): AdvancedBrush

Returns

AdvancedBrush

Inherited from

BrushTool.paint

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:123

---

paintAndAwaitUpdate

▸ paintAndAwaitUpdate(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:15

---

paintAndUpdate

▸ paintAndUpdate(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:30

---

setData

▸ setData(data): AdvancedBrush

Parameters

Name	Type
data	Partial<AddVoxelData>

Returns

AdvancedBrush

Inherited from

BrushTool.setData

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:24

---

setDimension

▸ setDimension(dimensionId): AdvancedBrush

Parameters

Name	Type
dimensionId	string

Returns

AdvancedBrush

Inherited from

BrushTool.setDimension

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:40

---

setId

▸ setId(id, state?, shapeState?): AdvancedBrush

Parameters

Name	Type	Default value
id	string	undefined
state	number	0
shapeState	number	0

Returns

AdvancedBrush

Inherited from

BrushTool.setId

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:33

---

setLevel

▸ setLevel(level): AdvancedBrush

Parameters

Name	Type
level	number

Returns

AdvancedBrush

Inherited from

BrushTool.setLevel

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:62

---

setLevelState

▸ setLevelState(levelState): AdvancedBrush

Parameters

Name	Type
levelState	number

Returns

AdvancedBrush

Inherited from

BrushTool.setLevelState

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:67

---

setLocation

▸ setLocation(location): AdvancedBrush

Parameters

Name	Type
location	LocationData

Returns

AdvancedBrush

Inherited from

BrushTool.setLocation

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:65

---

setMode

▸ setMode(mode): AdvancedBrush

Parameters

Name	Type
mode	TaskRunModes

Returns

AdvancedBrush

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:11

---

setRaw

▸ setRaw(data): AdvancedBrush

Parameters

Name	Type
data	RawVoxelData

Returns

AdvancedBrush

Inherited from

BrushTool.setRaw

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:84

---

setSecondaryId

▸ setSecondaryId(id, state?): AdvancedBrush

Parameters

Name	Type	Default value
id	string	undefined
state	number	0

Returns

AdvancedBrush

Inherited from

BrushTool.setSecondaryId

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:46

---

setShapeState

▸ setShapeState(state): AdvancedBrush

Parameters

Name	Type
state	number

Returns

AdvancedBrush

Inherited from

BrushTool.setShapeState

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:57

---

setState

▸ setState(state): AdvancedBrush

Parameters

Name	Type
state	number

Returns

AdvancedBrush

Inherited from

BrushTool.setState

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:52

---

setXYZ

▸ setXYZ(x, y, z): AdvancedBrush

Parameters

Name	Type
x	number
y	number
z	number

Returns

AdvancedBrush

Inherited from

BrushTool.setXYZ

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:53

---

setXZ

▸ setXZ(x, z): AdvancedBrush

Parameters

Name	Type
x	number
z	number

Returns

AdvancedBrush

Inherited from

BrushTool.setXZ

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/LocationBoundTool.ts:60

---

start

▸ start(): AdvancedBrush

Returns

AdvancedBrush

Inherited from

BrushTool.start

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:133

---

stop

▸ stop(): AdvancedBrush

Returns

AdvancedBrush

Inherited from

BrushTool.stop

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/Brush.ts:138

---

update

▸ update(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:53

---

updateAndAwait

▸ updateAndAwait(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Brush/AdvancedBrushTool.ts:64