threejs-worldgen
    Preparing search index...

    Interface PopulationOverlayProps

    Props of <PopulationOverlay>: every overlay setting plus the ones below.

    interface PopulationOverlayProps {
        autoDistance?: number;
        camera?: Camera;
        coarsest?: number;
        extrude?: number;
        gap?: number;
        mode?: PopulationMode;
        networkOffset?: number;
        networks?: boolean;
        offset?: number;
        opacity?: number;
        origin?: Vec3;
        population: Population;
        ref?: Ref<PopulationOverlay | null>;
        resolution?: number | "auto";
        style?: Partial<PopulationStyle>;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index
    autoDistance? camera? coarsest? extrude? gap? mode? networkOffset? networks? offset? opacity? origin? population ref? resolution? style? visible?
    autoDistance?: number

    'auto': stay at the finest resolution until the camera is this many fine-cell edges away.

    camera?: Camera

    Camera for resolution: 'auto'. Defaults to the R3F default camera.

    coarsest?: number

    'auto': at most this many resolutions coarser than the data.

    extrude?: number

    Prism height at the top of the ramp, metres (0 = flat, ground-draped tiles).

    gap?: number

    0…0.5: shrink each hexagon towards its centre, leaving a gap between cells.

    mode?: PopulationMode

    What cells are coloured (and extruded) by.

    networkOffset?: number

    Lift of network lines above the ground, metres.

    networks?: boolean

    Draw roads, rails and power lines.

    offset?: number

    Lift above the ground, metres.

    opacity?: number

    0…1 opacity.

    origin?: Vec3

    Floating origin: the world position at render-space zero (as in WorldTerrain).

    population: Population

    The population to draw (see usePopulation).

    ref?: Ref<PopulationOverlay | null>

    Receives the underlying overlay instance.

    resolution?: number | "auto"

    H3 resolution to draw, or 'auto' to step coarser as the camera pulls away.

    style?: Partial<PopulationStyle>

    Colours (merged into the current ones).

    visible?: boolean

    Show the overlay.

    Settings
    Member Visibility

    On This Page
    Properties