Module

Hylograph.ForceEngine.Types

Package
purescript-hylograph-simulation
Repository
afcondon/purescript-hylograph-simulation

Force configuration for force-directed layouts.

ForceSpec and its per-force configuration records — what forces to apply and how strongly. Pure data; interpreted by Hylograph.ForceEngine.Simulation.

This module does NOT define the node or link types. Those live in Hylograph.ForceEngine.Simulation as SimulationNode and Link, which is what setNodes and setLinks consume.

#defaultSimParams Source

defaultSimParams :: { alpha :: Number, alphaDecay :: Number, alphaMin :: Number, alphaTarget :: Number, velocityRetention :: Number }

Default simulation parameters

#ManyBodyConfig Source

type ManyBodyConfig = { distanceMax :: Number, distanceMin :: Number, strength :: Number, theta :: Number }

Configuration for a many-body (charge) force

#CollideConfig Source

type CollideConfig = { iterations :: Int, radius :: Number, strength :: Number }

Configuration for a collision force

#LinkConfig Source

type LinkConfig = { distance :: Number, iterations :: Int, strength :: Number }

Configuration for a link force

#CenterConfig Source

type CenterConfig = { strength :: Number, x :: Number, y :: Number }

Configuration for centering force

#ForceXConfig Source

type ForceXConfig = { strength :: Number, x :: Number }

Configuration for X positioning force

#ForceYConfig Source

type ForceYConfig = { strength :: Number, y :: Number }

Configuration for Y positioning force

#RadialConfig Source

type RadialConfig = { radius :: Number, strength :: Number, x :: Number, y :: Number }

Configuration for radial force

#forceName Source

forceName :: ForceSpec -> String

Get the name of a force