Class OctreeIterator<T>

An octree iterator.

Type Parameters

T
The type of the octant data.

Implements

Iterator<OctantWrapper<T>>
Iterable<OctantWrapper<T>>

Index

Constructors

Methods

[iterator] next reset return

Constructors

constructor

new OctreeIterator<T>(octree, level?): OctreeIterator<T>
Constructs a new octant iterator.
Type Parameters
- T
Parameters
- octree: Octree<T>
  An octree.
- level: number = 0
  The level.
Returns OctreeIterator<T>
- Defined in core/OctreeIterator.ts:51

Methods

[iterator]

[iterator](): Iterator<OctantWrapper<T>, any, undefined>
Returns this iterator.

Returns Iterator<OctantWrapper<T>, any, undefined>
This iterator.
Implementation of Iterable.[iterator]
- Defined in core/OctreeIterator.ts:139

next

next(): IteratorResult<OctantWrapper<T>, any>
Iterates over the octants.

Returns IteratorResult<OctantWrapper<T>, any>
The next key.
Implementation of Iterator.next
- Defined in core/OctreeIterator.ts:89

reset

reset(): OctreeIterator<T>
Resets this iterator.

Returns OctreeIterator<T>
This iterator.
- Defined in core/OctreeIterator.ts:67

return

return(value): IteratorResult<OctantWrapper<T>, any>
Called when this iterator will no longer be run to completion.
Parameters
- value: OctantWrapper<T>
  An interator result value.
Returns IteratorResult<OctantWrapper<T>, any>
A premature completion result.
Implementation of Iterator.return
- Defined in core/OctreeIterator.ts:124