Interface AnimateOptions

Options for Atmosphere.animate — a real-time day/night time-lapse driven by requestAnimationFrame.

interface AnimateOptions {
    from?: Date;
    loop?: boolean;
    rate?: number;
    to?: Date;
}

Properties

from?: Date

Start of the loop window (inclusive). Default: the facade's current date.

loop?: boolean

Wrap back to AnimateOptions.from on reaching AnimateOptions.to; when false, the animation stops at to. Default true.

rate?: number

Simulated seconds advanced per real second (the time-lapse speed). 3600 is one hour per second; 86400 is one day per second. Default 3600.

to?: Date

End of the loop window. Default: 24 h after AnimateOptions.from.