Struct nyx_space::cosmic::eclipse::EclipseLocator
source · pub struct EclipseLocator {
pub light_source: Frame,
pub shadow_bodies: Vec<Frame>,
}
Fields§
§light_source: Frame
§shadow_bodies: Vec<Frame>
Implementations§
source§impl EclipseLocator
impl EclipseLocator
sourcepub fn cislunar(almanac: Arc<Almanac>) -> Self
pub fn cislunar(almanac: Arc<Almanac>) -> Self
Creates a new typical eclipse locator. The light source is the Sun, and the shadow bodies are the Earth and the Moon.
sourcepub fn compute(
&self,
observer: Orbit,
almanac: Arc<Almanac>
) -> AlmanacResult<EclipseState>
pub fn compute( &self, observer: Orbit, almanac: Arc<Almanac> ) -> AlmanacResult<EclipseState>
Compute the visibility/eclipse between an observer and an observed state
sourcepub fn to_umbra_event(&self) -> UmbraEvent
pub fn to_umbra_event(&self) -> UmbraEvent
Creates an umbra event from this eclipse locator. Evaluation of the event, returns 0.0 for umbra, 1.0 for visibility (no shadow) and some value in between for penumbra
sourcepub fn to_penumbra_event(&self) -> PenumbraEvent
pub fn to_penumbra_event(&self) -> PenumbraEvent
Creates a penumbra event from this eclipse locator
Trait Implementations§
source§impl Clone for EclipseLocator
impl Clone for EclipseLocator
source§fn clone(&self) -> EclipseLocator
fn clone(&self) -> EclipseLocator
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl Freeze for EclipseLocator
impl RefUnwindSafe for EclipseLocator
impl Send for EclipseLocator
impl Sync for EclipseLocator
impl Unpin for EclipseLocator
impl UnwindSafe for EclipseLocator
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.