Struct holding_solar::Orbit

pub struct Orbit {
    pub parent: PlanetId,
    pub body: PlanetId,
    pub shift: usize,
    pub eccentricity: f32,
    pub period: usize,
}

Describes the orbit of a given planet.

For the sake of simplicity, orbits are rounded to the nearest day relative to the parent object. This makes calendar calculation much much simpler, as you do not need to manage leap seconds / days.

Fields

parent: PlanetId

The id of the parent planet.

body: PlanetId

The body that is orbiting.

shift: usize

The starting offset for the orbit in days.

eccentricity: f32

The eccentricity of the orbit, or how elliptic it is.

period: usize

The amount of time a single orbit takes in seconds.

For simplicity, valid planets must have a period that is a multiple of the number of seconds in a day.

Implementations

impl Orbit

pub fn from_period(
    target: &CelestialBody,
    parent: PlanetId,
    period: usize,
    shift: usize
) -> Self

Create a new orbit with a given perion.

pub fn from_radius(
    target: &CelestialBody,
    parent: PlanetId,
    semimajor_axis: f32,
    shift: usize
) -> Self

Creates a new orbit at a given semimajor axis. Note that for now, since the period is a fixed number of days relative to the parent, this will be rounded. This is for simpler interop with the calendar. Nobody wants to RP leap seconds!

pub fn get_phase(
    &self,
    lookup: &dyn PlanetStore,
    date_time: CalendarDateTime<'_>
) -> Option<Phase>

Get the phase of the orbit.

Only valid if the body being orbited is in turn orbiting something else (that gives off light).

pub fn get_orbit_radians(&self, seconds: u32) -> f32

Given some day, gets the radians relative to the periapsis.

pub fn get_distance(&self, seconds: u32) -> f32

Calculates the distance between a body and its parent.

pub fn get_semimajor_axis(&self) -> f32

Gets the semimajor axis

pub fn validate_calendar(
    &self,
    calendar: &Calendar
) -> Result<bool, OrbitValidationError>

Validates an orbit against a calendar, ensuring the period is correct.

Trait Implementations

impl Clone for Orbit

fn clone(&self) -> Orbit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Orbit

impl Debug for Orbit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Orbit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Orbit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.