kastro/dev.jamesyox.kastro.sol

Package-level declarations

Types

LightPhase

sealed interface LightPhase

A state the sun can be in where the angle can cause lighting effects. This is mostly relevant to photographers.

LightPhaseInfo

sealed interface LightPhaseInfo

Describes what a LightPhase is by defining the range of angles for which a particular LightPhase is active for.

LightState

sealed interface LightState : LightPhase

A state the sun can be in where the angle can cause lighting effects. This is mostly relevant to photographers.

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

SolarEventSequence

class SolarEventSequence(start: Instant, latitude: Double, longitude: Double, limit: Duration = 365.days, requestedSolarEvents: List<SolarEventType> = SolarEventType.simple, reverse: Boolean = false) : Sequence<SolarEvent>

Sequence representing all SolarEvents supported by Kastro. The sequence will be ordered by SolarEvent.time either advancing forwards or backwards in time depending on the reverse parameter.

SolarEventType

sealed interface SolarEventType

Types of SolarEvents that can be requested in a SolarEventSequence

SolarPhase

sealed interface SolarPhase

Represents the "state" of the sun. SolarEvents represent moments in time where state transitions may occur. SolarPhase, in contrast, represents the ranges between SolarEvents. For a given location there is always a SolarPhase to describe the sun at any given kotlinx.datetime.Instant

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.

Twilight

sealed interface Twilight

Twilights are states of the sun defined by the number of degrees below the horizon. Each Twilight has a TwilightInfo.angleRange that defines the range of angles for which the sun would be considered to be in that associated Twilight.

TwilightInfo

sealed interface TwilightInfo

Describes what a Twilight is by defining the range of angles for which a particular Twilight is active for.

Properties

angleRange

val LightPhaseInfo.angleRange: ClosedRange<Double>

Range of angles for which a given LightPhaseInfo is active for.

val TwilightInfo.angleRange: ClosedRange<Double>

Range of angles for which a given TwilightInfo is active for.

Functions

calculateSolarState

fun Instant.calculateSolarState(location: Pair<Double, Double>, height: Double = 0.0): SolarState

fun Instant.calculateSolarState(latitude: Double, longitude: Double, height: Double = 0.0): SolarState

Calculates the SolarState for a given Instant in time