kastro/dev.jamesyox.kastro.sol/SolarState

SolarState

class SolarState

Single class containing all the information Kastro can calculate about Sol for a given instant of time. Contains the result of multiple calculations.

Properties

val altitude: Double

The visible altitude of the center of the sun above the horizon.

atmosphericRefraction

val atmosphericRefraction: Double

The atmospheric refraction of the Sun's light in degrees

val azimuth: Double

Sun azimuth, in degrees, north-based.

val distance: Double

Sun's distance, in kilometers.

horizonMovementState

val horizonMovementState: HorizonMovementState

Whether the Sun is rising or setting.

val horizonState: HorizonState

Whether the sun is HorizonState.Up or HorizonState.Down

val lightStates: List<LightState>

The current active LightStates. There can be more than one active LightState at a time. For instance, LightState.GoldenHourDusk and LightState.BlueHourDusk intersect a bit, so it's possible to have both of those or neither. Can be empty.

val parallax: Double

The parallax, in degrees.

val solarPhase: SolarPhase

The current SolarPhase. There can be only one active SolarPhase at a given time

val trueAltitude: Double

The true altitude of the center of the sun above the horizon.

Functions

fun altitudeAt(angularPosition: Double): Double

Obtains the altitude of a particular position of the sun above the horizon.