Class: DataLoaderTool

Default/Tools/Loader/DataLoaderTool.DataLoaderTool

Hierarchy

• LocationBoundTool

  ↳ DataLoaderTool

Constructors

constructor

• new DataLoaderTool(): DataLoaderTool

Returns

DataLoaderTool

Overrides

LocationBoundTool.constructor

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:27

Properties

_enabled

• _enabled: boolean = true

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:24

---

dataComm

• dataComm: CommBase

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:25

---

location

• location: LocationData

Inherited from

LocationBoundTool.location

Defined in

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

---

mode

• mode: "server" | "indexdb" | "both" = "server"

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:23

---

columnDataTool

▪ Static columnDataTool: ColumnDataTool

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:17

Accessors

dimension

• get dimension(): string

Returns

string

Inherited from

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

LocationBoundTool.dimension

Defined in

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

---

x

• get x(): number

Returns

number

Inherited from

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

LocationBoundTool.x

Defined in

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

---

y

• get y(): number

Returns

number

Inherited from

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

LocationBoundTool.y

Defined in

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

---

z

• get z(): number

Returns

number

Inherited from

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

LocationBoundTool.z

Defined in

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

Methods

_runTask

▸ _runTask(id, location, onDone?): void

Parameters

Name	Type
id	string
location	LocationData
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:48

---

allColumns

▸ allColumns(run): void

Parameters

Name	Type
run	(column: ColumnDataTool) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:284

---

columnExists

▸ columnExists(onDone?): void

Parameters

Name	Type
onDone?	(exists: boolean) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:155

---

columnExistsAsync

▸ columnExistsAsync(): Promise<boolean>

Returns

Promise<boolean>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:195

---

columnTimestamp

▸ columnTimestamp(onDone?): void

Parameters

Name	Type
onDone?	(timestamp: number) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:203

---

columnTimestampAsync

▸ columnTimestampAsync(): Promise<number>

Returns

Promise<number>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:210

---

getAllUnStoredColumns

▸ getAllUnStoredColumns(run): void

Parameters

Name	Type
run	(dimension: string, x: number, y: number, z: number) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:296

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

LocationBoundTool.getLocation

Defined in

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

---

getXYZ

▸ getXYZ(): Object

Returns

Object

Name	Type
x	number
y	number
z	number

Inherited from

LocationBoundTool.getXYZ

Defined in

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

---

getXYZAsArray

▸ getXYZAsArray(): Vec3Array

Returns

Vec3Array

Inherited from

LocationBoundTool.getXYZAsArray

Defined in

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

---

isEnabled

▸ isEnabled(): boolean

Returns

boolean

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:54

---

loadColumn

▸ loadColumn(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:132

---

loadColumnAsync

▸ loadColumnAsync(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:138

---

loadIfExists

▸ loadIfExists(onDone?): false | void

Parameters

Name	Type
onDone?	(loaded: boolean) => void

Returns

false | void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:109

---

loadRegion

▸ loadRegion(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:73

---

loadRegionAsync

▸ loadRegionAsync(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:80

---

loadRegionHeader

▸ loadRegionHeader(onDone?): void

Parameters

Name	Type
onDone?	(success: boolean) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:175

---

loadRegionHeaderAsync

▸ loadRegionHeaderAsync(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:187

---

saveColumn

▸ saveColumn(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:88

---

saveColumnAsync

▸ saveColumnAsync(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:124

---

saveColumnIfNotStored

▸ saveColumnIfNotStored(onDone?): boolean | void

Parameters

Name	Type
onDone?	(saved: boolean) => void

Returns

boolean | void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:95

---

saveRegion

▸ saveRegion(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:58

---

saveRegionAsync

▸ saveRegionAsync(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:65

---

setDimension

▸ setDimension(dimensionId): DataLoaderTool

Parameters

Name	Type
dimensionId	string

Returns

DataLoaderTool

Inherited from

LocationBoundTool.setDimension

Defined in

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

---

setLocation

▸ setLocation(location): DataLoaderTool

Parameters

Name	Type
location	LocationData

Returns

DataLoaderTool

Inherited from

LocationBoundTool.setLocation

Defined in

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

---

setXYZ

▸ setXYZ(x, y, z): DataLoaderTool

Parameters

Name	Type
x	number
y	number
z	number

Returns

DataLoaderTool

Inherited from

LocationBoundTool.setXYZ

Defined in

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

---

setXZ

▸ setXZ(x, z): DataLoaderTool

Parameters

Name	Type
x	number
z	number

Returns

DataLoaderTool

Inherited from

LocationBoundTool.setXZ

Defined in

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

---

unLoadAllColumns

▸ unLoadAllColumns(onDone?): void

Parameters

Name	Type
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:258

---

unLoadAllColumnsAsync

▸ unLoadAllColumnsAsync(): Promise<unknown>

Returns

Promise<unknown>

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:251

---

unLoadAllOutsideRadius

▸ unLoadAllOutsideRadius(radius, run?, onDone?): void

Parameters

Name	Type
radius	number
run	(column: ColumnDataTool) => boolean
onDone?	Function

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:218

---

unLoadColumn

▸ unLoadColumn(onDone): false | void

Parameters

Name	Type
onDone	(done: boolean) => void

Returns

false | void

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:146

---

isEnabled

▸ isEnabled(): boolean

Returns

boolean

Defined in

divinevoxel/foundation/src/Default/Tools/Loader/DataLoaderTool.ts:18