import {EdgeIterator} from 'rabbit-hole'

public class | source

EdgeIterator

An edge iterator.

Constructor Summary

Public Constructor
public	constructor(edgeData: EdgeData, cellPosition: Vector3, cellSize: Number, c: Number, d: Number) Constructs a new edge iterator.

Public Members
public	lengths: Number[] The amount of edges for each internal set of edges (X -> Y -> Z).

Public Methods
public	[Symbol.iterator](): EdteIterator Returns this iterator.
public	next(): IteratorResult Iterates over the edges.
public	reset(): EdgeIterator Resets this iterator.
public	return(value: Object): IteratorResult Called when this iterator will no longer be run to completion.

Constructs a new edge iterator.

Name	Type	Attribute	Description
edgeData	EdgeData		A set of edge data.
cellPosition	Vector3		The position of the data cell.
cellSize	Number		The size of the data cell.
c	Number	optional default: 0	The dimension index to start at.
d	Number	optional default: 3	The dimension limit.

The amount of edges for each internal set of edges (X -> Y -> Z).

Returns this iterator.

EdteIterator

An iterator.

Iterates over the edges.

IteratorResult

The next edge.

Resets this iterator.

This iterator.

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

Name	Type	Attribute	Description
value	Object		An interator result value.

IteratorResult

A premature completion result.