Struct Atmosphere 

pub struct Atmosphere {
    pub inner_radius: f32,
    pub outer_radius: f32,
    pub ground_albedo: Vec3,
    pub medium: Handle<ScatteringMedium>,
}

Atmosphere for one planet. The entity’s GlobalTransform is the planet center in world space.

Add AtmosphereSettings to each 3D camera that should use it, the nearest atmosphere is used for rendering.

If GlobalTransform is still Default when this component is first added, it is placed radius units directly below the origin on the Y axis, so that the planet’s normal is roughly Vec3::Y around the origin, likely where your camera/scene is located. Unless you’re making a game set in space, this is probably what you want. Otherwise, feel free to override this default by setting a transform manually.

The scale on GlobalTransform rescales the planet in world space. Tune it with the radius offset when your scene uses other units, like kilometer-sized scenes.

Fields

inner_radius: f32

Radius of the planet

units: m

outer_radius: f32

Radius at which we consider the atmosphere to ‘end’ for our calculations (from center of planet)

units: m

ground_albedo: Vec3

An approximation of the average albedo (or color, roughly) of the planet’s surface. This is used when calculating multiscattering.

units: N/A

medium: Handle<ScatteringMedium>

A handle to a ScatteringMedium, which describes the substance of the atmosphere and how it scatters light.

Implementations

impl Atmosphere

pub fn earth(medium: Handle<ScatteringMedium>) -> Atmosphere

An atmosphere like that of earth. Use this with a ScatteringMedium::earth handle.

pub fn mars(medium: Handle<ScatteringMedium>) -> Atmosphere

Martian atmosphere; use this with a ScatteringMedium::mars handle.

Mean radius 3389.50 ± 0.2 km Seidelmann et al. 2007, Table 4.

Trait Implementations

impl Clone for Atmosphere

fn clone(&self) -> Atmosphere

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Atmosphere

where Atmosphere: Send + Sync + 'static,

Required Components: GlobalTransform.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Atmosphere>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl FromTemplate for Atmosphere

type Template = AtmosphereTemplate

The Template for this type.

impl Unpin for Atmosphere

where [()]: for<'a> SpecializeFromTemplate,