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

    Interface SunState

    interface SunState {
        altitude: number;
        azimuth: number;
        date: string;
        direction: number[];
        effectiveMode: "manual" | "geo";
        enabled: boolean;
        frame: "LOCAL" | "GEO";
        gridConvergence: number | null;
        location: { latitude: number; longitude: number } | null;
        mode: "manual" | "geo";
        north: "true" | "georeference" | "project";
        polarDay: boolean | null;
        rotation: number;
        solarNoon: string | null;
        sunrise: string | null;
        sunset: string | null;
        time: string;
        timeZone: string;
        timeZoneIsDefault: boolean;
        timeZoneLabel: string | null;
        utc: string | null;
    }
    Index

    Properties

    altitude: number

    Degrees above the horizon, including refraction

    azimuth: number

    Degrees clockwise from north

    date: string
    direction: number[]

    Unit vector towards the sun in the render frame (Z up)

    effectiveMode: "manual" | "geo"

    "manual" when mode is "geo" but the reference model has no location

    enabled: boolean
    frame: "LOCAL" | "GEO"

    The render frame: LOCAL is the reference model's own frame, GEO an east/north/up frame

    gridConvergence: number | null

    Degrees from its CRS's grid north to true north, clockwise; null when not grid-based

    location: { latitude: number; longitude: number } | null

    WGS84 of the reference model, null when it has no georeference

    mode: "manual" | "geo"
    north: "true" | "georeference" | "project"

    What azimuth 0 means: true north, the georeference's north without grid correction, or the model's +Y

    polarDay: boolean | null

    true: the sun does not set; false: it does not rise; null: it does both

    rotation: number

    The reference model's georeference rotation, degrees counter-clockwise from (grid) east

    solarNoon: string | null
    sunrise: string | null

    Local clock times "HH:MM"; null without a location or when the sun does not rise or set

    sunset: string | null
    time: string
    timeZone: string
    timeZoneIsDefault: boolean

    Whether timeZone is the location's default rather than a chosen one

    timeZoneLabel: string | null

    "CET", "CEST" or an offset such as "UTC+1"; null without a location

    utc: string | null

    The UTC instant of date and time, ISO 8601; null without a location