Class OctantId

An octant identifier.

Each octant can be identified by a positional key and a level.

Index

Constructors

Properties

Methods

Constructors

constructor

new OctantId(key?: number, level?: number): OctantId
Constructs a new octant ID.
Parameters
- key: number = 0
  The key.
- level: number = 0
  The level.
Returns OctantId
- Defined in core/OctantId.ts:28

Properties

key

key: number

The key.

level

level: number

The level.

Methods

clone

clone(): OctantId
Clones this octant identifier.

Returns OctantId
The cloned octant ID.
- Defined in core/OctantId.ts:74

copy

copy(id: OctantId): OctantId
Copies the given octant identifier.
Parameters
- id: OctantId
  An octant ID.
Returns OctantId
This octant ID.
- Defined in core/OctantId.ts:59

set

set(key: number, level: number): OctantId
Sets the key and level.
Parameters
- key: number
  The key.
- level: number
  The level.
Returns OctantId
This ID.
- Defined in core/OctantId.ts:43