Class: BuilderDataTool

Default/Builder/Tools/BuilderDataTool.BuilderDataTool

Hierarchy

• DataTool

  ↳ BuilderDataTool

Constructors

constructor

• new BuilderDataTool(): BuilderDataTool

Returns

BuilderDataTool

Inherited from

DataTool.constructor

Defined in

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

Properties

__secondary

• __secondary: boolean = false

secondary

If the data tool is processing secondary voxoels

Inherited from

DataTool.__secondary

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:65

---

_c

• _c: SharedArrayBuffer | ArrayBuffer | DataView

Inherited from

DataTool._c

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:10

---

_chunkTool

• _chunkTool: ChunkDataTool

Inherited from

DataTool._chunkTool

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:50

---

_dimensionRegister

• _dimensionRegister: DimensionsRegister

Inherited from

DataTool._dimensionRegister

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:11

---

_loadedIn

• _loadedIn: boolean = false

Inherited from

DataTool._loadedIn

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:53

---

_mode

• _mode: DataToolModes = DataToolModes.WORLD

Inherited from

DataTool._mode

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:54

---

_substanceTool

• _substanceTool: SubstanceDataTool

Inherited from

DataTool._substanceTool

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:51

---

data

• data: Object

Type declaration

Name	Type
baseId	number
id	number
raw	RawVoxelData
secondaryBaseId	number
secondaryId	number

Inherited from

DataTool.data

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:55

---

location

• location: LocationData

Inherited from

DataTool.location

Defined in

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

---

tags

• tags: VDTags = VoxelTags

Inherited from

DataTool.tags

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:67

---

Modes

▪ Static Modes: typeof DataToolModes = DataToolModes

Inherited from

DataTool.Modes

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:46

---

_columntool

▪ Static _columntool: ColumnDataTool

Inherited from

DataTool._columntool

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:49

---

_dtutil

▪ Static _dtutil: DataTool

Inherited from

DataTool._dtutil

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:47

---

_heightMapTool

▪ Static _heightMapTool: HeightMapTool

Inherited from

DataTool._heightMapTool

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:48

Accessors

dimension

• get dimension(): string

Returns

string

Inherited from

DataTool.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

DataTool.dimension

Defined in

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

---

x

• get x(): number

Returns

number

Inherited from

DataTool.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

DataTool.x

Defined in

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

---

y

• get y(): number

Returns

number

Inherited from

DataTool.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

DataTool.y

Defined in

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

---

z

• get z(): number

Returns

number

Inherited from

DataTool.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

DataTool.z

Defined in

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

Methods

__process

▸ __process(): void

Returns

void

Inherited from

DataTool.__process

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:120

---

_getBaseId

▸ _getBaseId(id): number

Parameters

Name	Type
id	number

Returns

number

Inherited from

DataTool._getBaseId

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:101

---

checkCollisions

▸ checkCollisions(): boolean

Returns

boolean

Inherited from

DataTool.checkCollisions

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:323

---

clear

▸ clear(): BuilderDataTool

Returns

BuilderDataTool

Inherited from

DataTool.clear

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:74

---

commit

▸ commit(heightMapUpdate?): boolean

Parameters

Name	Type	Default value
heightMapUpdate	number	0

Returns

boolean

Inherited from

DataTool.commit

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:159

---

getArrayTagValue

▸ getArrayTagValue(id, index): number

Parameters

Name	Type
id	string
index	number

Returns

number

Inherited from

DataTool.getArrayTagValue

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:26

---

getAsArrayBuffer

▸ getAsArrayBuffer(): ArrayBuffer

Returns

ArrayBuffer

Inherited from

DataTool.getAsArrayBuffer

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:45

---

getBuffer

▸ getBuffer(): ArrayBuffer

Returns

ArrayBuffer

Inherited from

DataTool.getBuffer

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:40

---

getBufferSize

▸ getBufferSize(): number

Returns

number

Inherited from

DataTool.getBufferSize

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:52

---

getCollider

▸ getCollider(): string

Returns

string

Inherited from

DataTool.getCollider

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:313

---

getConstructor

▸ getConstructor(): VoxelConstructor

Returns

VoxelConstructor

Defined in

divinevoxel/foundation/src/Default/Builder/Tools/BuilderDataTool.ts:5

---

getHardness

▸ getHardness(): number

Returns

number

Inherited from

DataTool.getHardness

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:307

---

getId

▸ getId(base?): number

Parameters

Name	Type	Default value
base	boolean	false

Returns

number

Inherited from

DataTool.getId

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:369

---

getLevel

▸ getLevel(): number

Returns

number

Inherited from

DataTool.getLevel

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:236

---

getLevelState

▸ getLevelState(): number

Returns

number

Inherited from

DataTool.getLevelState

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:243

---

getLight

▸ getLight(): number

Returns

number

Inherited from

DataTool.getLight

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:207

---

getLightSourceValue

▸ getLightSourceValue(): number

Returns

number

Inherited from

DataTool.getLightSourceValue

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:278

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

DataTool.getLocation

Defined in

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

---

getMaterial

▸ getMaterial(): string

Returns

string

Inherited from

DataTool.getMaterial

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:297

---

getRaw

▸ getRaw(): RawVoxelData

Returns

RawVoxelData

Inherited from

DataTool.getRaw

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:110

---

getShapeId

▸ getShapeId(): string

Returns

string

Inherited from

DataTool.getShapeId

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:262

---

getShapeState

▸ getShapeState(): number

Returns

number

Inherited from

DataTool.getShapeState

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:250

---

getState

▸ getState(): number

Returns

number

Inherited from

DataTool.getState

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:338

---

getStringId

▸ getStringId(): string

Returns

string

Inherited from

DataTool.getStringId

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:392

---

getSubstance

▸ getSubstance(): string

Returns

string

Inherited from

DataTool.getSubstance

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:284

---

getSubstnaceData

▸ getSubstnaceData(): SubstanceDataTool

Returns

SubstanceDataTool

Inherited from

DataTool.getSubstnaceData

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:105

---

getTagValue

▸ getTagValue(id): number

Parameters

Name	Type
id	string

Returns

number

Inherited from

DataTool.getTagValue

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:17

---

getTemplateSubstance

▸ getTemplateSubstance(): string

Returns

string

Inherited from

DataTool.getTemplateSubstance

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:331

---

getXYZ

▸ getXYZ(): Object

Returns

Object

Name	Type
x	number
y	number
z	number

Inherited from

DataTool.getXYZ

Defined in

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

---

getXYZAsArray

▸ getXYZAsArray(): Vec3Array

Returns

Vec3Array

Inherited from

DataTool.getXYZAsArray

Defined in

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

---

hasRGBLight

▸ hasRGBLight(): boolean

Returns

boolean

Inherited from

DataTool.hasRGBLight

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:197

---

hasSecondaryVoxel

▸ hasSecondaryVoxel(): boolean

Returns

boolean

Inherited from

DataTool.hasSecondaryVoxel

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:257

---

hasSunLight

▸ hasSunLight(): boolean

Returns

boolean

Inherited from

DataTool.hasSunLight

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:202

---

isAir

▸ isAir(): boolean

Returns

boolean

Inherited from

DataTool.isAir

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:357

---

isBarrier

▸ isBarrier(): boolean

Returns

boolean

Inherited from

DataTool.isBarrier

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:365

---

isLightSource

▸ isLightSource(): boolean

Returns

boolean

Inherited from

DataTool.isLightSource

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:272

---

isOpaque

▸ isOpaque(): undefined | true

Returns

undefined | true

Inherited from

DataTool.isOpaque

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:231

---

isRenderable

▸ isRenderable(): boolean

Returns

boolean

Inherited from

DataTool.isRenderable

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:400

---

isRich

▸ isRich(): number

Returns

number

Inherited from

DataTool.isRich

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:344

---

isSameVoxel

▸ isSameVoxel(cx, cy, cz): boolean

Parameters

Name	Type
cx	number
cy	number
cz	number

Returns

boolean

Inherited from

DataTool.isSameVoxel

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:404

---

loadIn

▸ loadIn(): boolean

Returns

boolean

Inherited from

DataTool.loadIn

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:132

---

loadInAt

▸ loadInAt(x, y, z): boolean

Parameters

Name	Type
x	number
y	number
z	number

Returns

boolean

Inherited from

DataTool.loadInAt

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:58

---

loadInAtLocation

▸ loadInAtLocation(location): boolean

Parameters

Name	Type
location	LocationData

Returns

boolean

Inherited from

DataTool.loadInAtLocation

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:70

---

loadInRaw

▸ loadInRaw(rawData): BuilderDataTool

Parameters

Name	Type
rawData	RawVoxelData

Returns

BuilderDataTool

Inherited from

DataTool.loadInRaw

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:114

---

loadInVec3

▸ loadInVec3(vec3): boolean

Parameters

Name	Type
vec3	Position3Matrix

Returns

boolean

Inherited from

DataTool.loadInVec3

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:66

---

loadInVec3Array

▸ loadInVec3Array(vec3): boolean

Parameters

Name	Type
vec3	Vec3Array

Returns

boolean

Inherited from

DataTool.loadInVec3Array

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:62

---

setAir

▸ setAir(): BuilderDataTool

Returns

BuilderDataTool

Inherited from

DataTool.setAir

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:352

---

setArrayTagValue

▸ setArrayTagValue(id, index, value): number | void

Parameters

Name	Type
id	string
index	number
value	number

Returns

number | void

Inherited from

DataTool.setArrayTagValue

Defined in

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

---

setBarrier

▸ setBarrier(): BuilderDataTool

Returns

BuilderDataTool

Inherited from

DataTool.setBarrier

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:360

---

setBuffer

▸ setBuffer(buffer): void

Parameters

Name	Type
buffer	SharedArrayBuffer | ArrayBuffer | DataView

Returns

void

Inherited from

DataTool.setBuffer

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:35

---

setDimension

▸ setDimension(dimensionId): BuilderDataTool

Parameters

Name	Type
dimensionId	string | number

Returns

BuilderDataTool

Inherited from

DataTool.setDimension

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:87

---

setId

▸ setId(id): BuilderDataTool

Parameters

Name	Type
id	number

Returns

BuilderDataTool

Inherited from

DataTool.setId

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:377

---

setLevel

▸ setLevel(level): BuilderDataTool

Parameters

Name	Type
level	number

Returns

BuilderDataTool

Inherited from

DataTool.setLevel

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:239

---

setLevelState

▸ setLevelState(state): BuilderDataTool

Parameters

Name	Type
state	number

Returns

BuilderDataTool

Inherited from

DataTool.setLevelState

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:246

---

setLight

▸ setLight(light): BuilderDataTool

Parameters

Name	Type
light	number

Returns

BuilderDataTool

Inherited from

DataTool.setLight

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:226

---

setLocation

▸ setLocation(location): BuilderDataTool

Parameters

Name	Type
location	LocationData

Returns

BuilderDataTool

Inherited from

DataTool.setLocation

Defined in

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

---

setMode

▸ setMode(mode): BuilderDataTool

Parameters

Name	Type
mode	DataToolModes

Returns

BuilderDataTool

Inherited from

DataTool.setMode

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:69

---

setSecondary

▸ setSecondary(enable): BuilderDataTool

Parameters

Name	Type
enable	boolean

Returns

BuilderDataTool

Inherited from

DataTool.setSecondary

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:92

---

setShapeState

▸ setShapeState(state): BuilderDataTool

Parameters

Name	Type
state	number

Returns

BuilderDataTool

Inherited from

DataTool.setShapeState

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:253

---

setStringId

▸ setStringId(id): BuilderDataTool

Parameters

Name	Type
id	string

Returns

BuilderDataTool

Inherited from

DataTool.setStringId

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:389

---

setTagValue

▸ setTagValue(id, value): boolean

Parameters

Name	Type
id	string
value	number

Returns

boolean

Inherited from

DataTool.setTagValue

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/DataToolBase.ts:21

---

setXYZ

▸ setXYZ(x, y, z): BuilderDataTool

Parameters

Name	Type
x	number
y	number
z	number

Returns

BuilderDataTool

Inherited from

DataTool.setXYZ

Defined in

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

---

setXZ

▸ setXZ(x, z): BuilderDataTool

Parameters

Name	Type
x	number
z	number

Returns

BuilderDataTool

Inherited from

DataTool.setXZ

Defined in

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

---

GetVoxelIDFromNumber

▸ GetVoxelIDFromNumber(id): string

Parameters

Name	Type
id	number

Returns

string

Inherited from

DataTool.GetVoxelIDFromNumber

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:42

---

GetVoxelIDFromString

▸ GetVoxelIDFromString(id): number

Parameters

Name	Type
id	string

Returns

number

Inherited from

DataTool.GetVoxelIDFromString

Defined in

divinevoxel/foundation/src/Default/Tools/Data/DataTool.ts:39