Class: RichDataSegmentTool

Default/Tools/Classes/RichDataToolBase.RichDataSegmentTool

Hierarchy

• DataToolBase

  ↳ RichDataSegmentTool

  ↳↳ RichColumnDataTool

  ↳↳ RichDataTool

Constructors

constructor

• new RichDataSegmentTool(): RichDataSegmentTool

Returns

RichDataSegmentTool

Overrides

DataToolBase.constructor

Defined in

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

Properties

_c

• _c: SharedArrayBuffer | ArrayBuffer | DataView

Inherited from

DataToolBase._c

Defined in

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

---

_dimensionRegister

• _dimensionRegister: DimensionsRegister

Inherited from

DataToolBase._dimensionRegister

Defined in

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

---

location

• location: LocationData

Inherited from

DataToolBase.location

Defined in

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

---

sceham

• sceham: RichDataSchema = {}

Defined in

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

---

segment

• segment: string = "voxel"

Defined in

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

---

tags

• tags: RemoteTagManager

Inherited from

DataToolBase.tags

Defined in

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

Accessors

dimension

• get dimension(): string

Returns

string

Inherited from

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

DataToolBase.dimension

Defined in

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

---

x

• get x(): number

Returns

number

Inherited from

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

DataToolBase.x

Defined in

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

---

y

• get y(): number

Returns

number

Inherited from

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

DataToolBase.y

Defined in

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

---

z

• get z(): number

Returns

number

Inherited from

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

DataToolBase.z

Defined in

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

Methods

getAll

▸ getAll(): false | RichDataSchema

Returns

false | RichDataSchema

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

DataToolBase.getArrayTagValue

Defined in

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

---

getAsArrayBuffer

▸ getAsArrayBuffer(): ArrayBuffer

Returns

ArrayBuffer

Inherited from

DataToolBase.getAsArrayBuffer

Defined in

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

---

getBuffer

▸ getBuffer(): ArrayBuffer

Returns

ArrayBuffer

Inherited from

DataToolBase.getBuffer

Defined in

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

---

getBufferSize

▸ getBufferSize(): number

Returns

number

Inherited from

DataToolBase.getBufferSize

Defined in

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

---

getLocation

▸ getLocation(): LocationData

Returns

LocationData

Inherited from

DataToolBase.getLocation

Defined in

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

---

getSegment

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

Returns

false | Record<string, any>

Defined in

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

---

getTagValue

▸ getTagValue(id): number

Parameters

Name	Type
id	string

Returns

number

Inherited from

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

DataToolBase.getXYZ

Defined in

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

---

getXYZAsArray

▸ getXYZAsArray(): Vec3Array

Returns

Vec3Array

Inherited from

DataToolBase.getXYZAsArray

Defined in

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

---

loadIn

▸ loadIn(): boolean

Returns

boolean

Inherited from

DataToolBase.loadIn

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

Inherited from

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

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

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

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

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

DataToolBase.setBuffer

Defined in

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

---

setDimension

▸ setDimension(dimensionId): RichDataSegmentTool

Parameters

Name	Type
dimensionId	string

Returns

RichDataSegmentTool

Inherited from

DataToolBase.setDimension

Defined in

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

---

setLocation

▸ setLocation(location): RichDataSegmentTool

Parameters

Name	Type
location	LocationData

Returns

RichDataSegmentTool

Inherited from

DataToolBase.setLocation

Defined in

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

---

setSegment

▸ setSegment(segment): RichDataSegmentTool

Parameters

Name	Type
segment	string

Returns

RichDataSegmentTool

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

DataToolBase.setTagValue

Defined in

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

---

setXYZ

▸ setXYZ(x, y, z): RichDataSegmentTool

Parameters

Name	Type
x	number
y	number
z	number

Returns

RichDataSegmentTool

Inherited from

DataToolBase.setXYZ

Defined in

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

---

setXZ

▸ setXZ(x, z): RichDataSegmentTool

Parameters

Name	Type
x	number
z	number

Returns

RichDataSegmentTool

Inherited from

DataToolBase.setXZ

Defined in

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