Class: BrushToolBase

Interfaces/Tools/BrushToolBase.BrushToolBase

Hierarchy

• LocationBoundToolBase

  ↳ BrushToolBase

Constructors

constructor

• new BrushToolBase(): BrushToolBase

Returns

BrushToolBase

Inherited from

LocationBoundToolBase.constructor

Properties

location

• location: LocationData

Inherited from

LocationBoundToolBase.location

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:4

Accessors

dimension

• get dimension(): string

Returns

string

Inherited from

LocationBoundToolBase.dimension

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:6

• set dimension(dimension): void

Parameters

Name	Type
dimension	string

Returns

void

Inherited from

LocationBoundToolBase.dimension

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:9

---

x

• get x(): number

Returns

number

Inherited from

LocationBoundToolBase.x

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:13

• set x(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

LocationBoundToolBase.x

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:16

---

y

• get y(): number

Returns

number

Inherited from

LocationBoundToolBase.y

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:20

• set y(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

LocationBoundToolBase.y

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:23

---

z

• get z(): number

Returns

number

Inherited from

LocationBoundToolBase.z

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:27

• set z(value): void

Parameters

Name	Type
value	number

Returns

void

Inherited from

LocationBoundToolBase.z

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:30

Methods

erase

▸ erase(): void

Returns

void

Defined in

divinevoxel/core/src/Interfaces/Tools/BrushToolBase.ts:6

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

LocationBoundToolBase.getLocation

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:39

---

getXYZ

▸ getXYZ(): Object

Returns

Object

Name	Type
x	number
y	number
z	number

Inherited from

LocationBoundToolBase.getXYZ

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:46

---

getXYZAsArray

▸ getXYZAsArray(): Vec3Array

Returns

Vec3Array

Inherited from

LocationBoundToolBase.getXYZAsArray

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:43

---

paint

▸ paint(): void

Returns

void

Defined in

divinevoxel/core/src/Interfaces/Tools/BrushToolBase.ts:5

---

setDimension

▸ setDimension(dimensionId): BrushToolBase

Parameters

Name	Type
dimensionId	string

Returns

BrushToolBase

Inherited from

LocationBoundToolBase.setDimension

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:34

---

setId

▸ setId(...args): void

Parameters

Name	Type
...args	any

Returns

void

Defined in

divinevoxel/core/src/Interfaces/Tools/BrushToolBase.ts:4

---

setLocation

▸ setLocation(location): BrushToolBase

Parameters

Name	Type
location	LocationData

Returns

BrushToolBase

Inherited from

LocationBoundToolBase.setLocation

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:65

---

setXYZ

▸ setXYZ(x, y, z): BrushToolBase

Parameters

Name	Type
x	number
y	number
z	number

Returns

BrushToolBase

Inherited from

LocationBoundToolBase.setXYZ

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:53

---

setXZ

▸ setXZ(x, z): BrushToolBase

Parameters

Name	Type
x	number
z	number

Returns

BrushToolBase

Inherited from

LocationBoundToolBase.setXZ

Defined in

divinevoxel/core/src/Interfaces/Data/LocationBoundToolBase.ts:60