BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Interface ShadowState

    interface ShadowState {
        active: boolean;
        groundElevation: number | null;
        lastPass:
            | {
                elapsedMs: number;
                ms: number;
                size: number;
                steps: number;
                subset: boolean;
                texelSize: number;
                translucentTriangles: number;
                triangles: number;
            }
            | null;
        mapSize: number
        | null;
        mode: "off" | "sun" | "ground";
        quality: "auto" | "standard" | "high";
        sectionPlanesCutShadows: boolean;
        texelSize: number | null;
        threshold: number;
        transparentCasters: "none" | "threshold" | "attenuate" | "tint";
        updating: boolean;
        viewMap:
            | {
                lastPass: {
                    elapsedMs: number;
                    ms: number;
                    steps: number;
                    subset: boolean;
                    triangles: number;
                };
                size: number;
                texelSize: number;
            }
            | null;
    }
    Index

    Properties

    active: boolean

    Whether shadows are drawn now: "sun" draws none while the sun is off or below the horizon

    groundElevation: number | null
    lastPass:
        | {
            elapsedMs: number;
            ms: number;
            size: number;
            steps: number;
            subset: boolean;
            texelSize: number;
            translucentTriangles: number;
            triangles: number;
        }
        | null

    The last shadow map drawn: CPU ms to submit it, ms from start to finish, the frames it was drawn in, triangles (all passes), triangles of the transparent casters, size, texel, and whether it held only the largest casters (drawn while the sun moves over a large scene)

    mapSize: number | null

    The shadow map's size in texels, null before the first

    mode: "off" | "sun" | "ground"
    quality: "auto" | "standard" | "high"
    sectionPlanesCutShadows: boolean
    texelSize: number | null

    One texel of the shadow map in mm

    threshold: number
    transparentCasters: "none" | "threshold" | "attenuate" | "tint"
    updating: boolean

    Whether a new shadow map is being drawn over several frames (large scenes); the previous one shows meanwhile

    viewMap:
        | {
            lastPass: {
                elapsedMs: number;
                ms: number;
                steps: number;
                subset: boolean;
                triangles: number;
            };
            size: number;
            texelSize: number;
        }
        | null

    The view map in use (high quality, drawn when the camera rests close by): its size, texel in mm, and its last pass (subset: drawn from the casters over its window only)