Class: RichDataTool

Default/Tools/Data/RichDataTool.RichDataTool

Hierarchy

• LocationBoundTool

  ↳ RichDataTool

Constructors

constructor

• new RichDataTool(): RichDataTool

Returns

RichDataTool

Overrides

LocationBoundTool.constructor

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:17

Properties

_enabled

• _enabled: boolean = false

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:15

---

comm

• comm: CommBase

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:14

---

location

• location: LocationData

Inherited from

LocationBoundTool.location

Defined in

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

---

segment

• segment: string = "voxels"

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:12

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

columnHasData

▸ columnHasData(check): void

Parameters

Name	Type
check	(hasData: boolean) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:43

---

columnHasDataAsync

▸ columnHasDataAsync(): Promise<boolean>

Returns

Promise<boolean>

Defined in

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

---

getColumn

▸ getColumn(onDone): void

Parameters

Name	Type
onDone	(data: ArrayBuffer) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:140

---

getColumnAsync

▸ getColumnAsync(): Promise<ArrayBuffer>

Returns

Promise<ArrayBuffer>

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:151

---

getData

▸ getData<T>(onDone): void

Type parameters

Name	Type
T	any

Parameters

Name	Type
onDone	(data: false | T) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:62

---

getDataAsync

▸ getDataAsync<T>(): Promise<false | T>

Type parameters

Name	Type
T	any

Returns

Promise<false | T>

Defined in

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

---

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/Data/RichDataTool.ts:34

---

releaeAllData

▸ releaeAllData(): void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:178

---

removeColumn

▸ removeColumn(onDone): void

Parameters

Name	Type
onDone	(removed: boolean) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:121

---

removeColumnAsync

▸ removeColumnAsync<T>(): Promise<boolean>

Type parameters

Name	Type
T	any

Returns

Promise<boolean>

Defined in

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

---

removeData

▸ removeData(onDone): void

Parameters

Name	Type
onDone	(removed: boolean) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:102

---

removeDataAsync

▸ removeDataAsync<T>(): Promise<boolean>

Type parameters

Name	Type
T	any

Returns

Promise<boolean>

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:113

---

setColumn

▸ setColumn(column, onDone): void

Parameters

Name	Type
column	ArrayBuffer
onDone	(success: boolean) => void

Returns

void

Defined in

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

---

setColumnAsync

▸ setColumnAsync(column): Promise<boolean>

Parameters

Name	Type
column	ArrayBuffer

Returns

Promise<boolean>

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:170

---

setData

▸ setData<T>(data, onDone?): void

Type parameters

Name	Type
T	any

Parameters

Name	Type
data	T
onDone	(data: boolean) => void

Returns

void

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:82

---

setDataAsync

▸ setDataAsync<T>(data): Promise<boolean>

Type parameters

Name	Type
T	any

Parameters

Name	Type
data	T

Returns

Promise<boolean>

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:94

---

setDimension

▸ setDimension(dimensionId): RichDataTool

Parameters

Name	Type
dimensionId	string

Returns

RichDataTool

Inherited from

LocationBoundTool.setDimension

Defined in

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

---

setLocation

▸ setLocation(location): RichDataTool

Parameters

Name	Type
location	LocationData

Returns

RichDataTool

Inherited from

LocationBoundTool.setLocation

Defined in

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

---

setSegment

▸ setSegment(segment): RichDataTool

Parameters

Name	Type
segment	string

Returns

RichDataTool

Defined in

divinevoxel/foundation/src/Default/Tools/Data/RichDataTool.ts:38

---

setXYZ

▸ setXYZ(x, y, z): RichDataTool

Parameters

Name	Type
x	number
y	number
z	number

Returns

RichDataTool

Inherited from

LocationBoundTool.setXYZ

Defined in

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

---

setXZ

▸ setXZ(x, z): RichDataTool

Parameters

Name	Type
x	number
z	number

Returns

RichDataTool

Inherited from

LocationBoundTool.setXZ

Defined in

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