Struct Opacity 

pub struct Opacity { /* private fields */ }

Component of opacity of this entity and its children.

Implementations

impl Opacity

pub const INVISIBLE: Opacity

Opacity 0.0.

pub const OPAQUE: Opacity

Opacity 1.0.

pub const fn new(opacity: f32) -> Opacity

Creates a new opacity value.

pub const fn get(&self) -> f32

Returns the current opacity value.

pub const fn get_target(&self) -> f32

Returns the target opacity value.

pub fn set(&mut self, opacity: f32)

Set the opacity value and cancels interpolation or fade out.

pub const fn is_opaque(&self) -> bool

Returns true if opacity is greater than or equal to 1.0.

pub const fn is_visible(&self) -> bool

Returns true if opacity is greater than to 0.0.

pub const fn is_invisible(&self) -> bool

Returns true if opacity is less than or equal to 0.0.

pub const fn is_despawning(&self) -> bool

Returns true if is despawning, only when fade_out was called but not completed.

pub const fn new_fade_in(time: f32) -> Opacity

Set opacity to 0.0 and interpolate to 1.0.

pub const fn and_fade_in(self, time: f32) -> Self

Interpolate to 1.0.

pub fn fade_in(&mut self, time: f32)

Interpolate opacity to 1.0.

pub fn fade_out(&mut self, time: f32)

Interpolate opacity to 0.0 and despawns the entity when that happens.

Deletion can be stopped by calling set, fade_in or interpolate_to before fade out completed. If deletion is not desired, call interpolate_to with opacity 0.0 instead.

pub fn interpolate_to(&mut self, opacity: f32, time: f32)

Interpolate opacity to a specific value.

pub fn interpolate_by_speed(&mut self, opacity: f32, time_zero_to_one: f32)

Interpolate opacity to a specific value.

Trait Implementations

impl Clone for Opacity

fn clone(&self) -> Opacity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Opacity

where Self: Send + Sync + 'static,

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 clone_behavior() -> ComponentCloneBehavior

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

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

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

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

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

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

Gets the on_replace 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 Debug for Opacity

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

Formats the value using the given formatter.

impl Default for Opacity

Why default 1.0

It’s better to show something by default than hide it implicitly.

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Opacity

fn eq(&self, other: &Opacity) -> 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 PartialOrd for Opacity

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Opacity

impl StructuralPartialEq for Opacity