Home Reference Source 
import {WorldOctantId} from 'rabbit-hole'
public class | source

WorldOctantId

A world octant identifier.

Each octant can be identified by a LOD index and a positional key.

Constructor Summary

Public Constructor
public

constructor(lod: Number, key: Number)

Constructs a new world octant identifier.

Member Summary

Public Members
public

The unique key of the world octant.
public

The LOD grid in which the world octant resides.

Method Summary

Public Methods
public

Clones this octant identifier.
public

Copies the given octant identifier.
public

Sets the LOD index and key.

Public Constructors

public constructor(lod: Number, key: Number) source

Constructs a new world octant identifier.

Params:

NameTypeAttributeDescription
lod Number
  • optional
  • default: 0

The LOD index.
key Number
  • optional
  • default: 0

The key.

Public Members

public key: Number source

The unique key of the world octant.

public lod: Number source

The LOD grid in which the world octant resides.

Public Methods

public clone(): WorldOctantId source

Clones this octant identifier.

Return:

WorldOctantId

The cloned octant identifier.

public copy(id: WorldOctantId): WorldOctantId source

Copies the given octant identifier.

Params:

NameTypeAttributeDescription
id WorldOctantId

An octant identifier.

Return:

WorldOctantId

This octant identifier.

public set(lod: Number, key: Number): WorldOctantId source

Sets the LOD index and key.

Params:

NameTypeAttributeDescription
lod Number

The LOD index.
key Number

The key.

Return:

WorldOctantId

This octant identifier.