SolarEvent

sealed interface SolarEvent : Comparable<SolarEvent>

Times when particular solar events of interest happen. Examples would be things like Sunrise, sunset, solar noon, start of civil dawn, etc. These events represent moments or Instants in time. This time can be extracted via SolarEvent.time

Inheritors

Types

Link copied to clipboard
class AstronomicalDawn(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun rises to -18.0 degrees. Begins SolarPhase.AstronomicalDawn.

Link copied to clipboard
class AstronomicalDusk(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun sets to -12.0 degrees. Begins SolarPhase.AstronomicalDusk.

Link copied to clipboard
class BlueHourDawn(val time: Instant) : SolarEvent.LightEvent

When the solar angle rises to -8.0. Marks the start of LightState.BlueHourDawn.

Link copied to clipboard
class BlueHourDawnEnd(val time: Instant) : SolarEvent.LightEvent

The end of LightState.BlueHourDawn. Happens when the sun rises past -4.0 degrees.

Link copied to clipboard
class BlueHourDusk(val time: Instant) : SolarEvent.LightEvent

When the solar angle sets to -4.0. Marks the start of LightState.BlueHourDusk.

Link copied to clipboard
class BlueHourDuskEnd(val time: Instant) : SolarEvent.LightEvent

The end of LightState.BlueHourDusk. Happens when the sun sets past -8.0 degrees.

Link copied to clipboard
class CivilDawn(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun rises to -6.0 degrees. Begins SolarPhase.CivilDawn.

Link copied to clipboard
class CivilDusk(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun sets to 0.0 degrees. Begins SolarPhase.CivilDusk.

Link copied to clipboard
class Day(val time: Instant) : SolarEvent.TwilightEvent

Moment when the solar angle rises to 0.0. Begins SolarPhase.Day.

Link copied to clipboard
class GoldenHourDawn(val time: Instant) : SolarEvent.LightEvent

When the solar angle rises to -6.0. Marks the start of LightState.GoldenHourDawn.

Link copied to clipboard
class GoldenHourDawnEnd(val time: Instant) : SolarEvent.LightEvent

The end of LightState.GoldenHourDawn. Happens when the sun rises past 6.0 degrees.

Link copied to clipboard
class GoldenHourDusk(val time: Instant) : SolarEvent.LightEvent

When the solar angle sets to 0.0. Marks the start of LightState.GoldenHourDusk.

Link copied to clipboard
class GoldenHourDuskEnd(val time: Instant) : SolarEvent.LightEvent

The end of LightState.GoldenHourDusk. Happens when the sun sets past - 6.0 degrees.

Link copied to clipboard
sealed interface HorizonEvent : SolarEvent

Horizon Events are solar events that involve the sun transiting the horizon. For instance Sunrise and Sunset. Also includes events like SunsetBegin and SunriseEnd

Link copied to clipboard
sealed interface LightEvent : SolarEvent

Light events are solar events pertaining to interesting light effects created by the position of the sun. Examples are things like the start of Golden Hour or Blue Hour. These event types are of particular interest to photographers.

Link copied to clipboard
class Nadir(val time: Instant) : SolarEvent

The opposite of solar noon. When the sun is at its lowest position in the sky for a given cycle.

Link copied to clipboard
class NauticalDawn(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun rises to -12.0 degrees. Begins SolarPhase.NauticalDawn.

Link copied to clipboard
class NauticalDusk(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun sets to -6.0 degrees. Begins SolarPhase.NauticalDusk.

Link copied to clipboard
class Night(val time: Instant) : SolarEvent.TwilightEvent

Moment when the sun sets to -18.0 degrees. Begins SolarPhase.Night.

Link copied to clipboard
class Noon(val time: Instant) : SolarEvent

Solar noon. When the sun is at its highest position in the sky for a given cycle.

Link copied to clipboard
class Sunrise(val time: Instant) : SolarEvent.HorizonEvent.Simple

Moment when the top edge of the sun first rises from the horizon.

Link copied to clipboard
class SunriseEnd(val time: Instant) : SolarEvent.HorizonEvent

When the bottom edge of the sun rises above the horizon.

Link copied to clipboard
class Sunset(val time: Instant) : SolarEvent.HorizonEvent.Simple

Moment when the top edge of the sun completely disappears behind the horizon

Link copied to clipboard
class SunsetBegin(val time: Instant) : SolarEvent.HorizonEvent

When the bottom edge of the sun touches the horizon when the sun is setting.

Link copied to clipboard
sealed interface TwilightEvent : SolarEvent

A type of Solar Event that includes the beginning of various SolarPhases

Properties

Link copied to clipboard
abstract val time: Instant

Time of the event

Functions

Link copied to clipboard
open operator override fun compareTo(other: SolarEvent): Int