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

    Interface SunOptions

    interface SunOptions {
        altitude?: number;
        azimuth?: number;
        date?: string | null;
        enabled?: boolean;
        mode?: "manual" | "geo";
        time?: string;
        timeZone?: string | null;
    }
    Index

    Properties

    altitude? azimuth? date? enabled? mode? time? timeZone?

    Properties

    altitude?: number

    Manual mode: degrees above the horizon, -90..90. Default 50.

    azimuth?: number

    Manual mode: degrees clockwise from true north, or from the model's +Y without a location. Default 135.

    date?: string | null

    Local calendar date, "YYYY-MM-DD"; null for today.

    enabled?: boolean

    Light the scene with the sun (true) or the headlight (false, the default).

    mode?: "manual" | "geo"

    "geo" (default): the sun for the reference model's location at date and time. "manual": azimuth and altitude. Without a location the sun is always manual.

    time?: string

    Local clock time, "HH:MM". Default "12:00".

    timeZone?: string | null

    IANA time zone, e.g. "Europe/Amsterdam"; null for the location's default. Daylight saving time follows the zone.

    Settings

    Member Visibility

    On This Page

    Properties