@equinor/videx-3d
    Preparing search index...

    Type Alias BuoyancyOptions

    Options for useBuoyancy.

    type BuoyancyOptions = {
        damping?: number;
        enabled?: boolean;
        mass?: number;
        points: BuoyancyPoint[];
    }
    Index

    Properties

    damping?: number

    Response rate (per second) of the heave/pitch/roll smoothing. Higher snaps to the waves faster; lower is more sluggish. Default 3.

    enabled?: boolean

    Master switch; when false the object is left untouched. Default true.

    mass?: number

    Relative mass / inertia of the object (default 1). Models how heavy the object is: the effective response rate is divided by this, so a heavier object follows the surface more slowly and its motion amplitude shrinks for fast waves it cannot keep up with. Use a value relative to a "typical" object of its kind (e.g. weight / referenceWeight).

    points: BuoyancyPoint[]

    Sample points in the object's local X/Z (at its waterline). Required.

    Place them at the true hull extents (e.g. bow / stern / port / starboard): this is how the object's length and width feed into the motion. Waves shorter than the span between points decorrelate, so the fitted plane yields little pitch/roll (a long ship barely reacts to short chop), while swells longer than the object move it as a whole.