threejs-worldgen
    Preparing search index...

    Interface RoadPathCreateOptions

    Options of RoadPath: settings plus live inputs.

    interface RoadPathCreateOptions {
        coords?: Node;
        curbHeight?: number;
        halfWidth?: Node;
        height?: (x: number, z: number) => number;
        look?: StateLook;
        offset?: number;
        part?: Node;
        points?: [number, number][] | [number, number, number][];
        receiveShadow?: boolean;
        scene?: Object3D<Object3DEventMap>;
        sidewalk?: number;
        smoothing?: number;
        states?: Partial<
            Record<StateChannel | "heat" | "ash", number | Node<"float">>,
        >;
        step?: number;
        surface?: RoadSurfaceInput;
        surfaceIndex?: Node;
        time?: Node;
        verge?: number;
        width?: number;
    }

    Hierarchy (View Summary)

    Index
    coords? curbHeight? halfWidth? height? look? offset? part? points? receiveShadow? scene? sidewalk? smoothing? states? step? surface? surfaceIndex? time? verge? width?
    coords?: Node

    (metres across from the centreline, metres along). Default: uv().

    curbHeight?: number

    Curb height, metres.

    halfWidth?: Node

    Half carriageway width node. Default: width / 2. threejs-city: attribute('road', 'vec4').x.

    height?: (x: number, z: number) => number

    Ground height (x, z) => y to drape on, e.g. world.height or frame.height.

    look?: StateLook

    Weathering look.

    offset?: number

    Surface height above the ground, metres.

    part?: Node

    Part code node (ROAD_PART). Default: the roadPart vertex attribute. threejs-city: attribute('road', 'vec4').w.

    points?: [number, number][] | [number, number, number][]

    The centreline (frame-local [x, z] or [x, y, z]).

    receiveShadow?: boolean

    Receive shadows.

    scene?: Object3D<Object3DEventMap>

    If given, the path is added to it.

    sidewalk?: number

    Sidewalk width per side, metres (0 = rural: a sloped verge instead of curbs).

    smoothing?: number

    Smoothing passes over the centreline height (removes bumps of the ground).

    states?: Partial<Record<StateChannel | "heat" | "ash", number | Node<"float">>>

    Per-pixel weather, e.g. a threejs-weathering StateField.node(). Combined with options.states by max.

    step?: number

    Resampling step along the path, metres.

    surface?: RoadSurfaceInput

    Surface look (its width follows the ribbon's).

    surfaceIndex?: Node

    Surface index node (ROAD_SURFACE_KINDS). Default: options.surface. threejs-city: attribute('road', 'vec4').z.

    time?: Node

    Seconds for animated weather.

    verge?: number

    Width of the verge (rural) or sidewalk skirt sloping down to the ground, metres.

    width?: number

    Carriageway width, metres.

    Settings
    Member Visibility

    On This Page
    Properties