Crate astronomy_engine_bindings

Crate astronomy_engine_bindings 

Source

Structs§

astro_angle_result_t
@brief An angular value expressed in degrees.
astro_apsis_t
@brief An apsis event: pericenter (closest approach) or apocenter (farthest distance).
astro_atmosphere_t
@brief Information about idealized atmospheric variables at a given elevation.
astro_axis_t
@brief Information about a body’s rotation axis at a given time.
astro_constellation_t
@brief Reports the constellation that a given celestial point lies within.
astro_eclipse_event_t
@brief Holds a time and the observed altitude of the Sun at that time.
astro_ecliptic_t
@brief Ecliptic angular and Cartesian coordinates.
astro_elongation_t
@brief Contains information about the visibility of a celestial body at a given date and time. See #Astronomy_Elongation for more detailed information about the members of this structure. See also #Astronomy_SearchMaxElongation for how to search for maximum elongation events.
astro_equatorial_t
@brief Equatorial angular and cartesian coordinates.
astro_func_result_t
@brief A real value returned by a function whose ascending root is to be found.
astro_global_solar_eclipse_t
@brief Reports the time and geographic location of the peak of a solar eclipse.
astro_grav_sim_s
astro_horizon_t
@brief Coordinates of a celestial body as seen by a topocentric observer.
astro_hour_angle_t
@brief Information about a celestial body crossing a specific hour angle.
astro_illum_t
@brief Information about the brightness and illuminated shape of a celestial body.
astro_jupiter_moons_t
@brief Holds the positions and velocities of Jupiter’s major 4 moons.
astro_libration_t
@brief Lunar libration angles, returned by #Astronomy_Libration.
astro_local_solar_eclipse_t
@brief Information about a solar eclipse as seen by an observer at a given time and geographic location.
astro_lunar_eclipse_t
@brief Information about a lunar eclipse.
astro_moon_quarter_t
@brief A lunar quarter event (new moon, first quarter, full moon, or third quarter) along with its date and time.
astro_node_event_t
@brief Information about an ascending or descending node of a body.
astro_observer_t
@brief The location of an observer on (or near) the surface of the Earth.
astro_rotation_t
@brief Contains a rotation matrix that can be used to transform one coordinate system to another.
astro_search_result_t
@brief The result of a search for an astronomical event.
astro_seasons_t
@brief The dates and times of changes of season for a given calendar year. Call #Astronomy_Seasons to calculate this data structure for a given year.
astro_spherical_t
@brief Spherical coordinates: latitude, longitude, distance.
astro_state_vector_t
@brief A state vector that contains a position (AU) and velocity (AU/day).
astro_time_t
@brief A date and time used for astronomical calculations.
astro_transit_t
@brief Information about a transit of Mercury or Venus, as seen from the Earth.
astro_utc_t
@brief A calendar date and time expressed in UTC.
astro_vector_t
@brief A 3D Cartesian vector whose components are expressed in Astronomical Units (AU).
max_align_t

Constants§

AU_PER_LY
CALLISTO_RADIUS_KM
C_AUDAY
DEG2RAD
EARTH_EQUATORIAL_RADIUS_KM
EARTH_FLATTENING
EARTH_POLAR_RADIUS_KM
EUROPA_RADIUS_KM
GANYMEDE_RADIUS_KM
HOUR2RAD
IO_RADIUS_KM
JUPITER_EQUATORIAL_RADIUS_KM
JUPITER_MEAN_RADIUS_KM
JUPITER_POLAR_RADIUS_KM
MARS_EQUATORIAL_RADIUS_KM
MARS_POLAR_RADIUS_KM
MERCURY_EQUATORIAL_RADIUS_KM
MERCURY_POLAR_RADIUS_KM
MOON_EQUATORIAL_RADIUS_KM
MOON_POLAR_RADIUS_KM
NEPTUNE_EQUATORIAL_RADIUS_KM
NEPTUNE_POLAR_RADIUS_KM
PLUTO_RADIUS_KM
RAD2DEG
RAD2HOUR
SATURN_EQUATORIAL_RADIUS_KM
SATURN_POLAR_RADIUS_KM
SUN_RADIUS_KM
TIME_TEXT_BYTES
URANUS_EQUATORIAL_RADIUS_KM
URANUS_POLAR_RADIUS_KM
VENUS_RADIUS_KM
astro_aberration_t_ABERRATION
< Request correction for aberration.
astro_aberration_t_NO_ABERRATION
< Do not correct for aberration.
astro_apsis_kind_t_APSIS_APOCENTER
< The body is at its farthest distance from the object it orbits.
astro_apsis_kind_t_APSIS_INVALID
< Undefined or invalid apsis.
astro_apsis_kind_t_APSIS_PERICENTER
< The body is at its closest approach to the object it orbits.
astro_body_t_BODY_EARTH
< Earth
astro_body_t_BODY_EMB
< Earth/Moon Barycenter
astro_body_t_BODY_INVALID
< An invalid or undefined celestial body.
astro_body_t_BODY_JUPITER
< Jupiter
astro_body_t_BODY_MARS
< Mars
astro_body_t_BODY_MERCURY
< Mercury
astro_body_t_BODY_MOON
< Moon
astro_body_t_BODY_NEPTUNE
< Neptune
astro_body_t_BODY_PLUTO
< Pluto
astro_body_t_BODY_SATURN
< Saturn
astro_body_t_BODY_SSB
< Solar System Barycenter
astro_body_t_BODY_STAR1
< user-defined star #1
astro_body_t_BODY_STAR2
< user-defined star #2
astro_body_t_BODY_STAR3
< user-defined star #3
astro_body_t_BODY_STAR4
< user-defined star #4
astro_body_t_BODY_STAR5
< user-defined star #5
astro_body_t_BODY_STAR6
< user-defined star #6
astro_body_t_BODY_STAR7
< user-defined star #7
astro_body_t_BODY_STAR8
< user-defined star #8
astro_body_t_BODY_SUN
< Sun
astro_body_t_BODY_URANUS
< Uranus
astro_body_t_BODY_VENUS
< Venus
astro_direction_t_DIRECTION_RISE
< Search for the time a body begins to rise above the horizon.
astro_direction_t_DIRECTION_SET
< Search for the time a body finishes sinking below the horizon.
astro_eclipse_kind_t_ECLIPSE_ANNULAR
< An annular solar eclipse. (Never used for a lunar eclipse.)
astro_eclipse_kind_t_ECLIPSE_NONE
< No eclipse found.
astro_eclipse_kind_t_ECLIPSE_PARTIAL
< A partial lunar/solar eclipse.
astro_eclipse_kind_t_ECLIPSE_PENUMBRAL
< A penumbral lunar eclipse. (Never used for a solar eclipse.)
astro_eclipse_kind_t_ECLIPSE_TOTAL
< A total lunar/solar eclipse.
astro_equator_date_t_EQUATOR_J2000
< Represent equatorial coordinates in the J2000 epoch.
astro_equator_date_t_EQUATOR_OF_DATE
< Represent equatorial coordinates using the Earth’s equator at the given date and time.
astro_node_kind_t_ASCENDING_NODE
< The body passes through the ecliptic plane from south to north.
astro_node_kind_t_DESCENDING_NODE
< The body passes through the ecliptic plane from north to south.
astro_node_kind_t_INVALID_NODE
< Placeholder value for a missing or invalid node.
astro_refraction_t_REFRACTION_JPLHOR
< Used only for compatibility testing with JPL Horizons online tool.
astro_refraction_t_REFRACTION_NONE
< No atmospheric refraction correction (airless).
astro_refraction_t_REFRACTION_NORMAL
< Recommended correction for standard atmospheric refraction.
astro_status_t_ASTRO_BAD_TIME
< The provided date/time is outside the range allowed by this function.
astro_status_t_ASTRO_BAD_VECTOR
< Vector magnitude is too small to be normalized into a unit vector.
astro_status_t_ASTRO_BUFFER_TOO_SMALL
< A provided buffer’s size is too small to receive the requested data.
astro_status_t_ASTRO_EARTH_NOT_ALLOWED
< The Earth cannot be treated as a celestial body seen from an observer on the Earth itself.
astro_status_t_ASTRO_FAIL_APSIS
< Special-case logic for finding Neptune/Pluto apsis failed.
astro_status_t_ASTRO_INCONSISTENT_TIMES
< The provided initial state vectors did not have matching times.
astro_status_t_ASTRO_INTERNAL_ERROR
< A self-check failed inside the code somewhere, indicating a bug needs to be fixed.
astro_status_t_ASTRO_INVALID_BODY
< The celestial body was not valid. Different sets of bodies are supported depending on the function.
astro_status_t_ASTRO_INVALID_PARAMETER
< A parameter value passed to a function was not valid.
astro_status_t_ASTRO_NOT_INITIALIZED
< A placeholder that can be used for data that is not yet initialized.
astro_status_t_ASTRO_NO_CONVERGE
< A numeric solver failed to converge. This should not happen unless there is a bug in Astronomy Engine.
astro_status_t_ASTRO_NO_MOON_QUARTER
< No lunar quarter occurs inside the specified time range.
astro_status_t_ASTRO_OUT_OF_MEMORY
< An attempt to allocate memory failed.
astro_status_t_ASTRO_SEARCH_FAILURE
< Search was not able to find an ascending root crossing of the function in the specified time interval.
astro_status_t_ASTRO_SUCCESS
< The operation was successful.
astro_status_t_ASTRO_WRONG_MOON_QUARTER
< Internal error: Astronomy_NextMoonQuarter found the wrong moon quarter.
astro_time_format_t_TIME_FORMAT_DAY
< Truncate to UTC calendar date only, e.g. 2020-12-31. Buffer size must be at least 11 characters.
astro_time_format_t_TIME_FORMAT_MILLI
< Round to nearest UTC millisecond, e.g. 2020-12-31T15:47:32.397Z. Buffer size must be at least 25 characters.
astro_time_format_t_TIME_FORMAT_MINUTE
< Round to nearest UTC minute, e.g. 2020-12-31T15:47Z. Buffer size must be at least 18 characters.
astro_time_format_t_TIME_FORMAT_SECOND
< Round to nearest UTC second, e.g. 2020-12-31T15:47:32Z. Buffer size must be at least 21 characters.
astro_visibility_t_VISIBLE_EVENING
< The body is best visible in the evening, after sunset.
astro_visibility_t_VISIBLE_MORNING
< The body is best visible in the morning, before sunrise.

Functions§

Astronomy_AddDays
Astronomy_AngleBetween
Astronomy_AngleFromSun
Astronomy_Atmosphere
Astronomy_BackdatePosition
Astronomy_BaryState
Astronomy_BodyCode
Astronomy_BodyName
Astronomy_CombineRotation
Astronomy_Constellation
Astronomy_CorrectLightTravel
Astronomy_CurrentTime
Astronomy_DefineStar
Astronomy_DeltaT_EspenakMeeus
Astronomy_DeltaT_JplHorizons
Astronomy_Ecliptic
Astronomy_EclipticGeoMoon
Astronomy_EclipticLongitude
Astronomy_Elongation
Astronomy_Equator
Astronomy_EquatorFromVector
Astronomy_FormatTime
Astronomy_GeoEmbState
Astronomy_GeoMoon
Astronomy_GeoMoonState
Astronomy_GeoVector
Astronomy_GravSimBodyState
Astronomy_GravSimFree
Astronomy_GravSimInit
Astronomy_GravSimNumBodies
Astronomy_GravSimOrigin
Astronomy_GravSimSwap
Astronomy_GravSimTime
Astronomy_GravSimUpdate
Astronomy_HelioDistance
Astronomy_HelioState
Astronomy_HelioVector
Astronomy_Horizon
Astronomy_HorizonFromVector
Astronomy_HourAngle
Astronomy_IdentityMatrix
Astronomy_Illumination
Astronomy_InverseRefraction
Astronomy_InverseRotation
Astronomy_JupiterMoons
Astronomy_LagrangePoint
Astronomy_LagrangePointFast
Astronomy_Libration
Astronomy_MakeObserver
Astronomy_MakeTime
Astronomy_MassProduct
Astronomy_MoonPhase
Astronomy_NextGlobalSolarEclipse
Astronomy_NextLocalSolarEclipse
Astronomy_NextLunarApsis
Astronomy_NextLunarEclipse
Astronomy_NextMoonNode
Astronomy_NextMoonQuarter
Astronomy_NextPlanetApsis
Astronomy_NextTransit
Astronomy_ObserverGravity
Astronomy_ObserverState
Astronomy_ObserverVector
Astronomy_PairLongitude
Astronomy_Pivot
Astronomy_PlanetOrbitalPeriod
Astronomy_Refraction
Astronomy_Reset
Astronomy_RotateState
Astronomy_RotateVector
Astronomy_RotationAxis
Astronomy_Rotation_ECL_EQD
Astronomy_Rotation_ECL_EQJ
Astronomy_Rotation_ECL_HOR
Astronomy_Rotation_ECT_EQD
Astronomy_Rotation_ECT_EQJ
Astronomy_Rotation_EQD_ECL
Astronomy_Rotation_EQD_ECT
Astronomy_Rotation_EQD_EQJ
Astronomy_Rotation_EQD_HOR
Astronomy_Rotation_EQJ_ECL
Astronomy_Rotation_EQJ_ECT
Astronomy_Rotation_EQJ_EQD
Astronomy_Rotation_EQJ_GAL
Astronomy_Rotation_EQJ_HOR
Astronomy_Rotation_GAL_EQJ
Astronomy_Rotation_HOR_ECL
Astronomy_Rotation_HOR_EQD
Astronomy_Rotation_HOR_EQJ
Astronomy_Search
Astronomy_SearchAltitude
Astronomy_SearchGlobalSolarEclipse
Astronomy_SearchHourAngleEx
Astronomy_SearchLocalSolarEclipse
Astronomy_SearchLunarApsis
Astronomy_SearchLunarEclipse
Astronomy_SearchMaxElongation
Astronomy_SearchMoonNode
Astronomy_SearchMoonPhase
Astronomy_SearchMoonQuarter
Astronomy_SearchPeakMagnitude
Astronomy_SearchPlanetApsis
Astronomy_SearchRelativeLongitude
@endcond
Astronomy_SearchRiseSetEx
@endcond
Astronomy_SearchSunLongitude
Astronomy_SearchTransit
Astronomy_Seasons
Astronomy_SetDeltaTFunction
Astronomy_SiderealTime
Astronomy_SphereFromVector
Astronomy_SunPosition
Astronomy_TerrestrialTime
Astronomy_TimeFromDays
Astronomy_TimeFromUtc
Astronomy_UtcFromTime
Astronomy_VectorFromHorizon
Astronomy_VectorFromSphere
Astronomy_VectorLength
Astronomy_VectorObserver

Type Aliases§

astro_aberration_t
@brief Aberration calculation options.
astro_apsis_kind_t
@brief The type of apsis: pericenter (closest approach) or apocenter (farthest distance).
astro_body_t
@brief A celestial body.
astro_deltat_func
@brief A pointer to a function that calculates Delta T.
astro_direction_t
@brief Selects whether to search for a rise time or a set time.
astro_eclipse_kind_t
@brief The different kinds of lunar/solar eclipses.
astro_equator_date_t
@brief Selects the date for which the Earth’s equator is to be used for representing equatorial coordinates.
astro_grav_sim_t
@brief A data type used for managing simulation of the gravitational forces on a small body.
astro_node_kind_t
@brief Indicates whether a crossing through the ecliptic plane is ascending or descending.
astro_position_func_t
@brief A function for which to solve a light-travel time problem.
astro_refraction_t
@brief Selects whether to correct for atmospheric refraction, and if so, how.
astro_search_func_t
@brief A pointer to a function that is to be passed as a callback to #Astronomy_Search.
astro_status_t
@brief Indicates success/failure of an Astronomy Engine function call.
astro_time_format_t
@brief Selects the output format of the function #Astronomy_FormatTime.
astro_visibility_t
@brief Indicates whether a body (especially Mercury or Venus) is best seen in the morning or evening.
wchar_t