Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.12 KB

next-planet-apsis.md

File metadata and controls

18 lines (11 loc) · 1.12 KB

//astronomy/io.github.cosinekitty.astronomy/nextPlanetApsis

nextPlanetApsis

fun nextPlanetApsis(body: Body, apsis: ApsisInfo): ApsisInfo

Finds the next planetary perihelion or aphelion event in a series.

This function requires an ApsisInfo value obtained from a call to searchPlanetApsis or nextPlanetApsis. Given an aphelion event, this function finds the next perihelion event, and vice versa.

See searchPlanetApsis for more details. See planetApsidesAfter for convenient iteration of consecutive apsides.

Parameters

body The planet for which to find the next perihelion/aphelion event. Not allowed to be Body.Sun or Body.Moon. Must match the body passed into the call that produced the apsis parameter.
apsis An apsis event obtained from a call to searchPlanetApsis or nextPlanetApsis.