Class: RichDataTool

Contexts/RichWorld/Tools/RichDataTool.RichDataTool

Hierarchy

• RichDataSegmentTool

  ↳ RichDataTool

Constructors

constructor

• new RichDataTool(): RichDataTool

Returns

RichDataTool

Inherited from

RichDataSegmentTool.constructor

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/RichDataToolBase.ts:8

Properties

_c

• _c: SharedArrayBuffer | ArrayBuffer | DataView

Inherited from

RichDataSegmentTool._c

Defined in

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

---

_dimensionRegister

• _dimensionRegister: DimensionsRegister

Inherited from

RichDataSegmentTool._dimensionRegister

Defined in

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

---

columnTool

• columnTool: ColumnDataTool

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:10

---

data

• data: any

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:8

---

location

• location: LocationData

Inherited from

RichDataSegmentTool.location

Defined in

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

---

richColumn

• richColumn: RichColumnDataTool

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:9

---

sceham

• sceham: RichDataSchema = {}

Inherited from

RichDataSegmentTool.sceham

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/RichDataToolBase.ts:6

---

segment

• segment: string = "voxel"

Inherited from

RichDataSegmentTool.segment

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/RichDataToolBase.ts:7

---

tags

• tags: RemoteTagManager

Inherited from

RichDataSegmentTool.tags

Defined in

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

Accessors

dimension

• get dimension(): string

Returns

string

Inherited from

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

RichDataSegmentTool.dimension

Defined in

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

---

x

• get x(): number

Returns

number

Inherited from

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

RichDataSegmentTool.x

Defined in

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

---

y

• get y(): number

Returns

number

Inherited from

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

RichDataSegmentTool.y

Defined in

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

---

z

• get z(): number

Returns

number

Inherited from

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

RichDataSegmentTool.z

Defined in

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

Methods

commit

▸ commit(): boolean

Returns

boolean

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:55

---

delete

▸ delete(): undefined | boolean

Returns

undefined | boolean

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:33

---

getAll

▸ getAll(): false | RichDataSchema

Returns

false | RichDataSchema

Inherited from

RichDataSegmentTool.getAll

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/RichDataToolBase.ts:24

---

getArrayTagValue

▸ getArrayTagValue(id, index): number

Parameters

Name	Type
id	string
index	number

Returns

number

Inherited from

RichDataSegmentTool.getArrayTagValue

Defined in

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

---

getAsArrayBuffer

▸ getAsArrayBuffer(): ArrayBuffer

Returns

ArrayBuffer

Inherited from

RichDataSegmentTool.getAsArrayBuffer

Defined in

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

---

getBuffer

▸ getBuffer(): ArrayBuffer

Returns

ArrayBuffer

Inherited from

RichDataSegmentTool.getBuffer

Defined in

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

---

getBufferSize

▸ getBufferSize(): number

Returns

number

Inherited from

RichDataSegmentTool.getBufferSize

Defined in

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

---

getData

▸ getData<T>(): T

Type parameters

Name
T

Returns

T

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:29

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

RichDataSegmentTool.getLocation

Defined in

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

---

getSegment

▸ getSegment(): false | Record<string, any>

Returns

false | Record<string, any>

Inherited from

RichDataSegmentTool.getSegment

Defined in

divinevoxel/foundation/src/Default/Tools/Classes/RichDataToolBase.ts:18

---

getTagValue

▸ getTagValue(id): number

Parameters

Name	Type
id	string

Returns

number

Inherited from

RichDataSegmentTool.getTagValue

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

RichDataSegmentTool.getXYZ

Defined in

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

---

getXYZAsArray

▸ getXYZAsArray(): Vec3Array

Returns

Vec3Array

Inherited from

RichDataSegmentTool.getXYZAsArray

Defined in

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

---

loadIn

▸ loadIn(): boolean

Returns

boolean

Overrides

RichDataSegmentTool.loadIn

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:11

---

loadInAt

▸ loadInAt(x, y, z): boolean

Parameters

Name	Type
x	number
y	number
z	number

Returns

boolean

Inherited from

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

RichDataSegmentTool.loadInAtLocation

Defined in

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

---

loadInVec3

▸ loadInVec3(vec3): boolean

Parameters

Name	Type
vec3	Position3Matrix

Returns

boolean

Inherited from

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

RichDataSegmentTool.loadInVec3Array

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

Inherited from

RichDataSegmentTool.setArrayTagValue

Defined in

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

---

setBuffer

▸ setBuffer(buffer): void

Parameters

Name	Type
buffer	SharedArrayBuffer | ArrayBuffer | DataView

Returns

void

Inherited from

RichDataSegmentTool.setBuffer

Defined in

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

---

setData

▸ setData<T>(data): RichDataTool

Type parameters

Name	Type
T	any

Parameters

Name	Type
data	T

Returns

RichDataTool

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:24

---

setDimension

▸ setDimension(dimensionId): RichDataTool

Parameters

Name	Type
dimensionId	string

Returns

RichDataTool

Inherited from

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

RichDataSegmentTool.setLocation

Defined in

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

---

setSegment

▸ setSegment(segment): RichDataTool

Parameters

Name	Type
segment	string

Returns

RichDataTool

Inherited from

RichDataSegmentTool.setSegment

Defined in

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

---

setTagValue

▸ setTagValue(id, value): boolean

Parameters

Name	Type
id	string
value	number

Returns

boolean

Inherited from

RichDataSegmentTool.setTagValue

Defined in

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

---

setXYZ

▸ setXYZ(x, y, z): RichDataTool

Parameters

Name	Type
x	number
y	number
z	number

Returns

RichDataTool

Inherited from

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

RichDataSegmentTool.setXZ

Defined in

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

---

toBuffer

▸ toBuffer(): false | ArrayBuffer

Returns

false | ArrayBuffer

Defined in

divinevoxel/foundation/src/Contexts/RichWorld/Tools/RichDataTool.ts:68