WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

The base data structure for the datum of a Simulation Node. The optional properties contained in this data structure are internally assigned by the Simulation upon (re-)initialization.

When defining a data type to use for node data, it should be an extension of this interface and respect the already "earmarked" properties used by the simulation.

IMPORTANT: Prior to initialization, the following properties are optional: index, x, y, vx, and vy. After initialization they will be defined. The optional properties fx and fy are ONLY defined, if the node's position has been fixed.

Hierarchy

  • SimulationNodeDatum

Index

Properties

Properties

fx

fx: number | null

Node’s fixed x-position (if position was fixed)

fy

fy: number | null

Node’s fixed y-position (if position was fixed)

index

index: number

Node’s zero-based index into nodes array. This property is set during the initialization process of a simulation.

vx

vx: number

Node’s current x-velocity

vy

vy: number

Node’s current y-velocity

x

x: number

Node’s current x-position

y

y: number

Node’s current y-position

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc