threejs-worldgen
    Preparing search index...

    Interface MPMLavaProps

    Props of <MPMLava>: every LavaInput setting plus the ones below.

    interface MPMLavaProps {
        envMap?: Texture<unknown, TextureEventMap> | null;
        lighting?: ParticleLighting;
        material?: string;
        ref?: Ref<MPMLava | null>;
        render?: {
            clasts?: number;
            cracks?: number;
            crackSize?: number;
            crackWidth?: number;
            crust?: string;
            intensity?: number;
            iterations?: number;
            radius?: number;
            resolution?: number;
            ropeLength?: number;
            ropes?: number;
            roughness?: number;
            smoothing?: number;
        };
        solver: MPMSolver;
        timeStep?: number;
    }

    Hierarchy (View Summary)

    Index
    envMap? lighting? material? ref? render? solver timeStep?
    envMap?: Texture<unknown, TextureEventMap> | null

    Reflected environment (default: the scene's environment, followed each frame; null: the lighting's sky colour).

    lighting?: ParticleLighting

    Sun and sky light (default: one per surface, filled from the scene each frame).

    material?: string

    Name of the solver material that is lava (compiled into the solver).

    ref?: Ref<MPMLava | null>

    Receives the MPMLavaImpl instance (emit through its vent gate with emit).

    render?: {
        clasts?: number;
        cracks?: number;
        crackSize?: number;
        crackWidth?: number;
        crust?: string;
        intensity?: number;
        iterations?: number;
        radius?: number;
        resolution?: number;
        ropeLength?: number;
        ropes?: number;
        roughness?: number;
        smoothing?: number;
    }

    The screen-space surface: particle spheres → depth → bilateral smoothing → normals, shaded with the lava field.

    Type Declaration

    • Optionalclasts?: number

      Clinker: each crack cell is a clast tilted at random up to this much (0 a continuous skin, 1 rubble).

    • Optionalcracks?: number

      Glow of the crust's crack network, 0…1: cooling-joint cells of crackSize whose edges, crackWidth wide, glow at the melt temperature under the crust (dark where the lava below has cooled too), and of crust cracks opening in the flow.

    • OptionalcrackSize?: number

      Crack cell size, metres (pāhoehoe crust plates ~0.3 m, ʻaʻā clinker ~0.1 m).

    • OptionalcrackWidth?: number

      Crack width, metres.

    • Optionalcrust?: string

      Basalt albedo, #rrggbb (sRGB; ~0.05 linear).

    • Optionalintensity?: number

      Emission scale (1: against a noon sun of intensity 3, 1400 K lava has radiance LAVA_GLOW_1400).

    • Optionaliterations?: number

      Smoothing passes (each a horizontal and a vertical blur), 0…4.

    • Optionalradius?: number

      Sphere radius of a particle, in particle spacings (Δx / 2). About 1.3 makes neighbours overlap into one surface.

    • Optionalresolution?: number

      Resolution of the offscreen passes relative to the drawing buffer (0.25…1).

    • OptionalropeLength?: number

      Rope spacing, metres.

    • Optionalropes?: number

      Ropy folds of the cooled skin (pāhoehoe), 0…1: ridges across the surface flow, where the skin has gone dark.

    • Optionalroughness?: number

      Crust roughness: glassy pāhoehoe skin ~0.5, clinkery ʻaʻā ~0.9.

    • Optionalsmoothing?: number

      Depth smoothing radius, in sphere radii: large for smooth pāhoehoe skin, small to keep ʻaʻā clinker lumpy.

    solver: MPMSolver

    The solver (from <MPM ref>); materials must include material (default lava).

    timeStep?: number

    Seconds simulated per frame (default: the frame's delta).

    Settings
    Member Visibility

    On This Page
    Properties