mwg API
    Preparing search index...

    Interface XpbdLink<T>

    A live spring in XpbdWorld.links: its spec, resolved (rest filled in) and the load state the last step left. A broken link carries no load but keeps its index.

    interface XpbdLink<T = undefined> {
        a: number;
        b: number;
        broken: boolean;
        data: T | undefined;
        force: number;
        ratio: number;
        rest: number;
        stiffness: number;
        strength: number | undefined;
        tensionOnly: boolean;
        tensionStrength: number | undefined;
    }

    Type Parameters

    • T = undefined
    Index
    a b broken data force ratio rest stiffness strength tensionOnly tensionStrength
    a: number
    b: number
    broken: boolean
    data: T | undefined

    the payload given to addLink, untouched by the solver

    force: number

    the force it carried over the last step, positive in tension, negative in compression

    ratio: number

    smoothed load as a fraction of what it can carry; it breaks above 1

    rest: number
    stiffness: number
    strength: number | undefined
    tensionOnly: boolean
    tensionStrength: number | undefined

    Settings
    Member Visibility

    On This Page
    Properties