Grid3Holder | gtools

Type parameters

Hierarchy

Grid3Holder

Implemented by

Index

Properties

length

Methods

Properties

Readonly length

length: number

Methods

clear

clear(): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:50
Returns void

fill

fill<R>(value: R | ((x: number, y: number, z: number) => R)): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:30
Fill all holder with value or with result of callback value

Type parameters
- R: Record<string | number, unknown>
Parameters
- value: R | ((x: number, y: number, z: number) => R)
  
  value or function returning value
Returns void

forEach

forEach(callback: (block: T, x: number, y: number, z: number) => unknown): boolean

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:44
deprecated

use either forEachUntil or forEach

Parameters
- callback: (block: T, x: number, y: number, z: number) => unknown
  
  function to be executed on each element
  - - (block: T, x: number, y: number, z: number): unknown
    - Parameters
      - block: T
      - x: number
      - y: number
      - z: number
      Returns unknown
Returns boolean

Optional forEachUntil

forEachUntil(callback: (block: T, x: number, y: number, z: number) => unknown): boolean

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:38
Iterate over all elements. If callback returns false, iteration will breaks and function returns false. If any callback call returns false, function returns false otherwise function returns true

Parameters
- callback: (block: T, x: number, y: number, z: number) => unknown
  
  function to be executed on each element
  - - (block: T, x: number, y: number, z: number): unknown
    - Parameters
      - block: T
      - x: number
      - y: number
      - z: number
      Returns unknown
Returns boolean

get

get(x: number, y: number, z: number): T

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:11
Parameters
- x: number
- y: number
- z: number
Returns T

Optional mirror

mirror(orientation: "XY" | "XZ" | "YZ"): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:19
Parameters
- orientation: "XY" | "XZ" | "YZ"
Returns void

Optional rotateCCW

rotateCCW(): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:23
Returns void

Optional rotateCW

rotateCW(): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:21
Returns void

set

set(x: number, y: number, z: number, value: T): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:13
Parameters
- x: number
- y: number
- z: number
- value: T
Returns void

setHolder

setHolder(holder: Grid3Holder<T>): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:48
Parameters
- holder: Grid3Holder<T>
Returns void

swap

swap(ax: number, ay: number, az: number, bx: number, by: number, bz: number): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:17
Parameters
- ax: number
- ay: number
- az: number
- bx: number
- by: number
- bz: number
Returns void

transform

transform(x: number, y: number, z: number, transformer: (value: T) => T): void

- Defined in src/models/data-structures/grid-accessor/holders-3d/grid3-holder.ts:15
Parameters
- x: number
- y: number
- z: number
- transformer: (value: T) => T
  - - (value: T): T
    - Parameters
      - value: T
      Returns T
Returns void

Type parameters

T

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly length

Methods

clear

Returns void

fill

Type parameters

R: Record<string | number, unknown>

Parameters

value: R | ((x: number, y: number, z: number) => R)

Returns void

forEach

Parameters

callback: (block: T, x: number, y: number, z: number) => unknown

Parameters

block: T

x: number

y: number

z: number

Returns unknown

Returns boolean

Optional forEachUntil

Parameters

callback: (block: T, x: number, y: number, z: number) => unknown

Parameters

block: T

x: number

y: number

z: number

Returns unknown

Returns boolean

get

Parameters

x: number

y: number

z: number

Returns T

Optional mirror

Parameters

orientation: "XY" | "XZ" | "YZ"

Returns void

Optional rotateCCW

Returns void

Optional rotateCW

Returns void

set

Parameters

x: number

y: number

z: number

value: T

Returns void

setHolder

Parameters

holder: Grid3Holder<T>

Returns void

swap

Parameters

ax: number

ay: number

az: number

bx: number

by: number

bz: number

Returns void

transform

Parameters

x: number

y: number

z: number

transformer: (value: T) => T

Parameters

value: T