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

WorldOctantIterator

Implements:

  • Iterator
    • ,
  • Iterable

A world octant iterator.

Constructor Summary

Public Constructor
public

Constructs a new octant iterator.

Method Summary

Public Methods
public

Returns this iterator.
public

next(): IteratorResult

Iterates over the octants.
public

Resets this iterator.
public

return(value: Object): IteratorResult

Called when this iterator will no longer be run to completion.

Public Constructors

public constructor(world: WorldOctree, lod: Number) source

Constructs a new octant iterator.

Params:

NameTypeAttributeDescription
world WorldOctree

An octree.
lod Number
  • optional
  • default: 0

The LOD grid to consider.

Public Methods

public [Symbol.iterator](): WorldOctantIterator source

Returns this iterator.

Return:

WorldOctantIterator

An iterator.

public next(): IteratorResult source

Iterates over the octants.

Return:

IteratorResult

The next key.

public reset(): KeyIterator source

Resets this iterator.

Return:

KeyIterator

This iterator.

public return(value: Object): IteratorResult source

Called when this iterator will no longer be run to completion.

Params:

NameTypeAttributeDescription
value Object

An interator result value.

Return:

IteratorResult

A premature completion result.