Struct Body

pub struct Body {
    pub name: String,
    pub mass: f64,
    pub radius: f64,
    pub orbit: Option<Orbit>,
    pub progress: f64,
}

A struct representing a celestial body.

Fields

name: String

The name of the celestial body.

mass: f64

The mass of the celestial body, in kilograms.

radius: f64

The radius of the celestial body, in meters.

orbit: Option<Orbit>

The orbit of the celestial body, if it is orbiting one.

progress: f64

The orbit progress, between 0 and 1.

Implementations

impl Body

pub fn new(name: String, mass: f64, radius: f64, orbit: Option<Orbit>) -> Body

Creates a new Body instance.

Arguments

• name - The name of the celestial body.
• mass - The mass of the celestial body, in kilograms.
• radius - The radius of the celestial body, in meters.
• orbit - An optional orbit for the celestial body.

Returns

A new Body instance.

pub fn new_default() -> Body

Creates a default Body instance.

Currently, this function returns the Earth.
However, do not rely on this behavior, as it may change in the future.

pub fn release_from_orbit(&mut self)

Releases the body from its orbit.

pub fn get_orbital_period(&self, g: f64) -> Option<f64>

Get the amount of time it takes for the body to complete one orbit, given a gravitational constant.

pub fn progress_orbit(&mut self, dt: f64, g: f64) -> Result<(), String>

Progresses this body’s orbit, given a time step and the gravitational acceleration towards the parent body.

pub fn get_relative_position(&self) -> (f64, f64, f64)

Gets the relative position of this body, in meters.

The position is relative to the parent body, if there is one.
If the body is not orbiting anything, this function will return (0, 0, 0).

Each coordinate is in meters.

Trait Implementations

impl Clone for Body

fn clone(&self) -> Body

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Body

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

Formats the value using the given formatter.

impl PartialEq for Body

fn eq(&self, other: &Body) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Body