Class Neighbors

Neighbors contains information about a node's connections to other nodes.

See

Hierarchy

Neighbors

Index

Constructors

constructor

new Neighbors(node: DirectionNode<any>): Neighbors
Parameters
- node: DirectionNode<any>
Returns Neighbors
- Defined in DirectionNode/Neighbors/Neighbors.ts:25

Properties

`Private` _neighbors

_neighbors: Neighbor[]

`Private` _node

_node: DirectionNode<any>

`Private` _parentNeighbor

_parentNeighbor: Neighbor

Methods

align

align(inDirection: Direction | Alignment, newAlignmentMode?: Alignment): void
Parameters
- inDirection: Direction | Alignment
- Optional newAlignmentMode: Alignment
Returns void
- Defined in DirectionNode/Neighbors/Neighbors.ts:239

assignParent

assignParent(fromNode?: DirectionNode<any>, parentDirection?: Direction): void
Parameters
- Optional fromNode: DirectionNode<any>
- Optional parentDirection: Direction
Returns void
- Defined in DirectionNode/Neighbors/Neighbors.ts:30

at

at(dir: Direction): Neighbor
Parameters
- dir: Direction
Returns Neighbor
- Defined in DirectionNode/Neighbors/Neighbors.ts:69

axisOverlap

axisOverlap(inDirection?: Direction): AxisOverlap
Parameters
- Optional inDirection: Direction
Returns AxisOverlap
- Defined in DirectionNode/Neighbors/Neighbors.ts:258

ensure

ensure(inDirection: Direction): Neighbor
Parameters
- inDirection: Direction
Returns Neighbor
- Defined in DirectionNode/Neighbors/Neighbors.ts:73

getAlignment

getAlignment(inDirection: Direction): Alignment
Parameters
- inDirection: Direction
Returns Alignment
- Defined in DirectionNode/Neighbors/Neighbors.ts:221

`Private` getParentDirection

getParentDirection(): Direction
Returns Direction
- Defined in DirectionNode/Neighbors/Neighbors.ts:228

hasAncestor

hasAncestor(parent: DirectionNode<any>): boolean
Parameters
- parent: DirectionNode<any>
Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:117

hasAnyNeighbors

hasAnyNeighbors(): boolean
Returns whether this DirectionNode has any non-parent neighbors in any direction.

Returns
true if this DirectionNode has any child neighbors in any direction.

See
hasChildAt

Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:138

hasChild

hasChild(direction: Direction): boolean
Parameters
- direction: Direction
Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:113

hasChildAt

hasChildAt(direction: Direction): boolean
Parameters
- direction: Direction
Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:106

hasNode

hasNode(atDirection: Direction): boolean
Parameters
- atDirection: Direction
Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:80

hasNodes

hasNodes(axis: Axis): [Direction, Direction]
Parameters
- axis: Axis
Returns [Direction, Direction]
- Defined in DirectionNode/Neighbors/Neighbors.ts:90

isRoot

isRoot(): boolean
Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:181

isRootlike

isRootlike(): boolean
Returns boolean
- Defined in DirectionNode/Neighbors/Neighbors.ts:185

lineLengthAt

lineLengthAt(direction: Direction): number
Parameters
- direction: Direction
Returns number
- Defined in DirectionNode/Neighbors/Neighbors.ts:193

node

node(): DirectionNode<any>
Returns DirectionNode<any>
- Defined in DirectionNode/Neighbors/Neighbors.ts:65

nodeAt

nodeAt(atDirection: Direction): DirectionNode<any>
Parameters
- atDirection: Direction
Returns DirectionNode<any>
- Defined in DirectionNode/Neighbors/Neighbors.ts:148

parent

parent(): Neighbor
Returns Neighbor
- Defined in DirectionNode/Neighbors/Neighbors.ts:44

parentDirection

parentDirection(): Direction
Returns Direction
- Defined in DirectionNode/Neighbors/Neighbors.ts:51

parentNode

parentNode(): DirectionNode<any>
Returns DirectionNode<any>
- Defined in DirectionNode/Neighbors/Neighbors.ts:58

parentX

parentX(): number
Returns number
- Defined in DirectionNode/Neighbors/Neighbors.ts:296

parentY

parentY(): number
Returns number
- Defined in DirectionNode/Neighbors/Neighbors.ts:303

root

root(): DirectionNode<any>
Returns DirectionNode<any>
- Defined in DirectionNode/Neighbors/Neighbors.ts:169

separationAt

separationAt(inDirection: Direction): number
Parameters
- inDirection: Direction
Returns number
- Defined in DirectionNode/Neighbors/Neighbors.ts:200

setAxisOverlap

setAxisOverlap(inDirection: Direction | AxisOverlap, newAxisOverlap?: AxisOverlap): void
Parameters
- inDirection: Direction | AxisOverlap
- Optional newAxisOverlap: AxisOverlap
Returns void
- Defined in DirectionNode/Neighbors/Neighbors.ts:275

Generated using TypeDoc