Interface PaintHeatMapOptions

Options accepted by paintHeatMap.

interface PaintHeatMapOptions {
    backgroundColor?: [number, number, number];
    grid?: boolean | HeatMapGridOptions;
    metallic?: number;
    ramp?: readonly HeatMapStop[];
    range?: [number, number];
    roughness?: number;
    size?: number;
    worldUp?: ArrayLike<number>;
}

Properties

backgroundColor? grid? metallic? ramp? range? roughness? size? worldUp?

Properties

OptionalbackgroundColor

backgroundColor?: [number, number, number]

RGB fill for texture pixels not covered by any triangle (the gaps between projected triangles in UV space). Default [0, 0, 0].

Optionalgrid

grid?: boolean | HeatMapGridOptions

Optional grid overlay drawn on painted pixels (background pixels are left alone). Useful for inspecting how the planar projection laid the geometry's UVs into texture space. Pass true for the defaults, an options object for control, or false/omit to skip.

Optionalmetallic

metallic?: number

Constant metallic written into the metallic-roughness map. Default 0.

Optionalramp

ramp?: readonly HeatMapStop[]

Colour ramp sampled left→right as the scalar value goes from range[0]→range[1]. Stops do not have to be evenly spaced. Default DEFAULT_HEATMAP_RAMP.

Optionalrange

range?: [number, number]

Scalar value range mapped onto the ramp's [0, 1] domain. When omitted, the range is auto-computed from the input scalars.

Optionalroughness

roughness?: number

Constant roughness written into the metallic-roughness map. Default 0.6.

Optionalsize

size?: number

Square texture size in pixels. Default 256.

OptionalworldUp

worldUp?: ArrayLike<number>

World-up axis. Used to align the planar UV projection so a "wall-like" geometry's V axis runs vertically — same heuristic attachSceneModelMaterials uses, kept consistent for free interchange with that path.

Settings

Member Visibility

On This Page

Properties