Struct StyleOverrides 

pub struct StyleOverrides { /* private fields */ }

The values runtime systems hold on one element; see the module docs.

Carried by every element a holder can act on (its marker components require it), so a holder writes here in place rather than through a deferred insert another holder could race.

Implementations

impl StyleOverrides

pub fn held(&self) -> StyleFields

Every field some holder holds.

pub fn is_empty(&self) -> bool

True when nothing is held.

pub fn held_by<O: StyleOwner>(&self) -> Option<&StyleValues>

What O holds, if anything.

pub fn resting(&self) -> &StyleValues

What the cascade resolved for the held fields.

pub fn hold<O: StyleOwner>( &mut self, values: StyleValues, live: &Live<'_>, ) -> StyleValues

Hold values for O, replacing whatever O held before.

live is read for a field nobody held yet: until then the live value is the cascade’s. Returns the composed value of every field whose top layer may have moved (what O held before and holds now), to write onto the live components.

pub fn release<O: StyleOwner>(&mut self) -> StyleValues

Stop holding anything for O. Returns the composed value of every field it held, which for a field nobody else holds is the cascade’s, to write onto the live components.

pub fn below<O: StyleOwner>( &self, fields: StyleFields, live: &Live<'_>, ) -> StyleValues

The value of fields under O’s layer: the cascade’s, with every lower-ranked holder laid over it. A field nobody holds reads live.

pub fn rebase(&mut self, fresh: &StyleValues) -> StyleValues

Record what a restyle resolved: fresh is the cascade’s value for every field. Returns the composed value of every held field, to lay over fresh before it is written onto the live components.

Trait Implementations

impl Clone for StyleOverrides

fn clone(&self) -> StyleOverrides

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for StyleOverrides

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

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_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 Debug for StyleOverrides

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

Formats the value using the given formatter.

impl Default for StyleOverrides

fn default() -> StyleOverrides

Returns the “default value” for a type.