Class Graph<NodeDataType, VertexDataType>

Type parameters

NodeDataType
VertexDataType

Hierarchy

Graph

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Graph(nodes: Map<string, Node<NodeDataType>>, vertices: Vertex<VertexDataType>[]): Graph

- Defined in src/types/Graph.ts:5
Parameters
- nodes: Map<string, Node<NodeDataType>>
- vertices: Vertex<VertexDataType>[]
Returns Graph

Properties

nodes

nodes: Map<string, Node<NodeDataType>>

vertices

vertices: Vertex<VertexDataType>[]

Methods

coulombEsqueForce

coulombEsqueForce(delta: Vector3, forceStrength: number, maxDistance: number): void

- Defined in src/types/Graph.ts:13
Add in Coulomb-esque node-node repulsive forces

Parameters
- delta: Vector3
- forceStrength: number
- maxDistance: number
Returns void

hookeEsqueForce

hookeEsqueForce(delta: Vector3, maxDistance: number, forceStrength: number): void

- Defined in src/types/Graph.ts:38
Add Hooke-esque edge spring forces

Parameters
- delta: Vector3
- maxDistance: number
- forceStrength: number
Returns void

moveEdges

moveEdges(dampening: number, maxVelocity: number): void

- Defined in src/types/Graph.ts:65
Parameters
- dampening: number
- maxVelocity: number
Returns void

moveVertices

moveVertices(): void

- Defined in src/types/Graph.ts:76
Returns void

optimize

optimize(iterations?: number, forceStrength?: number, dampening?: number, maxVelocity?: number, maxDistance?: number, delta?: Vector3): void

- Defined in src/types/Graph.ts:99
Parameters
- Default value iterations: number = 10
- Default value forceStrength: number = 10
- Default value dampening: number = 0.01
- Default value maxVelocity: number = 2
- Default value maxDistance: number = 50
- Default value delta: Vector3 = new Vector3()
Returns void

Generated using TypeDoc