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

    Type Alias OceanContact

    An oriented footprint of a floating object resting on the ocean surface, used to spread contact foam around it. All values are in the ocean's local frame (sea level = local y 0).

    type OceanContact = {
        endFalloff?: number;
        foamWidth: number;
        halfLength: number;
        halfWidth: number;
        heading: number;
        intensity?: number;
        x: number;
        z: number;
    }
    Index

    Properties

    endFalloff? foamWidth halfLength halfWidth heading intensity? x z

    Properties

    endFalloff?: number

    How much the foam is reduced toward the bow/stern (the forward axis), 0..1. 0 = an even collar all around; 1 = foam only along the sides (where a hull pushes the most water). Default 0.

    foamWidth: number

    Width (m) of the foam band straddling the footprint edge.

    halfLength: number

    Half-extent along the heading (e.g. half the hull length).

    halfWidth: number

    Half-extent across the heading (e.g. half the beam).

    heading: number

    Heading in radians (rotation about +Y).

    intensity?: number

    Foam strength multiplier (0 = none, 1 = full). Contact foam is independent of the wind-driven foamAmount, so this controls how much foam the object generates. Default 1.

    x: number

    Footprint centre X (local).

    z: number

    Footprint centre Z (local).

    Settings

    On This Page

    Properties