Class: DataToolBase

Default/Tools/Classes/DataToolBase.DataToolBase

Hierarchy

• LocationBoundTool

  ↳ DataToolBase

  ↳↳ EncodedPositionDataTool

  ↳↳ RichDataSegmentTool

  ↳↳ DataTool

Constructors

constructor

• new DataToolBase(): DataToolBase

Returns

DataToolBase

Overrides

LocationBoundTool.constructor

Defined in

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

Properties

_c

• _c: SharedArrayBuffer | ArrayBuffer | DataView

Defined in

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

---

_dimensionRegister

• _dimensionRegister: DimensionsRegister

Defined in

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

---

location

• location: LocationData

Inherited from

LocationBoundTool.location

Defined in

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

---

tags

• tags: RemoteTagManager

Defined in

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

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

getArrayTagValue

▸ getArrayTagValue(id, index): number

Parameters

Name	Type
id	string
index	number

Returns

number

Defined in

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

---

getAsArrayBuffer

▸ getAsArrayBuffer(): ArrayBuffer

Returns

ArrayBuffer

Defined in

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

---

getBuffer

▸ getBuffer(): ArrayBuffer

Returns

ArrayBuffer

Defined in

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

---

getBufferSize

▸ getBufferSize(): number

Returns

number

Defined in

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

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

LocationBoundTool.getLocation

Defined in

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

---

getTagValue

▸ getTagValue(id): number

Parameters

Name	Type
id	string

Returns

number

Defined in

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

---

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

---

loadIn

▸ loadIn(): boolean

Returns

boolean

Defined in

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

---

loadInAt

▸ loadInAt(x, y, z): boolean

Parameters

Name	Type
x	number
y	number
z	number

Returns

boolean

Defined in

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

---

loadInAtLocation

▸ loadInAtLocation(location): boolean

Parameters

Name	Type
location	LocationData

Returns

boolean

Defined in

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

---

loadInVec3

▸ loadInVec3(vec3): boolean

Parameters

Name	Type
vec3	Position3Matrix

Returns

boolean

Defined in

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

---

loadInVec3Array

▸ loadInVec3Array(vec3): boolean

Parameters

Name	Type
vec3	Vec3Array

Returns

boolean

Defined in

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

---

setArrayTagValue

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

Parameters

Name	Type
id	string
index	number
value	number

Returns

number | void

Defined in

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

---

setBuffer

▸ setBuffer(buffer): void

Parameters

Name	Type
buffer	SharedArrayBuffer | ArrayBuffer | DataView

Returns

void

Defined in

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

---

setDimension

▸ setDimension(dimensionId): DataToolBase

Parameters

Name	Type
dimensionId	string

Returns

DataToolBase

Inherited from

LocationBoundTool.setDimension

Defined in

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

---

setLocation

▸ setLocation(location): DataToolBase

Parameters

Name	Type
location	LocationData

Returns

DataToolBase

Inherited from

LocationBoundTool.setLocation

Defined in

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

---

setTagValue

▸ setTagValue(id, value): boolean

Parameters

Name	Type
id	string
value	number

Returns

boolean

Defined in

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

---

setXYZ

▸ setXYZ(x, y, z): DataToolBase

Parameters

Name	Type
x	number
y	number
z	number

Returns

DataToolBase

Inherited from

LocationBoundTool.setXYZ

Defined in

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

---

setXZ

▸ setXZ(x, z): DataToolBase

Parameters

Name	Type
x	number
z	number

Returns

DataToolBase

Inherited from

LocationBoundTool.setXZ

Defined in

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