Enum nyx_space::celestia::eclipse::EclipseState

pub enum EclipseState {
    Umbra,
    Penumbra(f64),
    Visibilis,
}

Stores the eclipse state

Variants

Umbra

Penumbra(f64)

The f64 is between ]0; 1[ and corresponds to the percentage of penumbra: the closer to 1, the more light is seen.

Visibilis

Implementations

impl EclipseState

pub fn as_f64(self) -> f64

Returns the eclipse state as an f64: 1.0 total visibility, 0.0 total umbra.

Trait Implementations

impl Clone for EclipseState

fn clone(&self) -> EclipseState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EclipseState

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

Formats the value using the given formatter.

impl Display for EclipseState

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

Formats the value using the given formatter.

impl Ord for EclipseState

fn cmp(&self, other: &Self) -> Ordering

Orders eclipse states to the greatest eclipse.

Examples

extern crate nyx_space as nyx;
use nyx::celestia::eclipse::EclipseState;
assert!(EclipseState::Umbra == EclipseState::Umbra);
assert!(EclipseState::Visibilis == EclipseState::Visibilis);
assert!(EclipseState::Penumbra(0.5) == EclipseState::Penumbra(0.5));
assert!(EclipseState::Umbra > EclipseState::Penumbra(0.1));
assert!(EclipseState::Umbra > EclipseState::Penumbra(0.9));
assert!(EclipseState::Penumbra(0.1) < EclipseState::Umbra);
assert!(EclipseState::Penumbra(0.9) < EclipseState::Umbra);
assert!(EclipseState::Penumbra(0.9) > EclipseState::Visibilis);
assert!(EclipseState::Visibilis < EclipseState::Penumbra(0.9));

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<EclipseState> for EclipseState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<EclipseState> for EclipseState

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for EclipseState

impl Eq for EclipseState

impl StructuralPartialEq for EclipseState