Struct bevy::render::prelude::ComputedVisibility

pub struct ComputedVisibility { /* private fields */ }

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering

Implementations

impl ComputedVisibility

pub const INVISIBLE: ComputedVisibility = ComputedVisibility{ is_visible_in_hierarchy: false, is_visible_in_view: false,}

A ComputedVisibility, set as invisible.

pub fn is_visible(&self) -> bool

Whether this entity is visible to something this frame. This is true if and only if Self::is_visible_in_hierarchy and Self::is_visible_in_view are true. This is the canonical method to call to determine if an entity should be drawn. This value is updated in CoreStage::PostUpdate during the VisibilitySystems::CheckVisibility system label. Reading it from the CoreStage::Update stage will yield the value from the previous frame.

pub fn is_visible_in_hierarchy(&self) -> bool

Whether this entity is visible in the entity hierarchy, which is determined by the Visibility component. This takes into account “visibility inheritance”. If any of this entity’s ancestors (see Parent) are hidden, this entity will be hidden as well. This value is updated in the CoreStage::PostUpdate stage in the VisibilitySystems::VisibilityPropagate system label.

pub fn is_visible_in_view(&self) -> bool

Whether this entity is visible in any view (Cameras, Lights, etc). Each entity type (and view type) should choose how to set this value. For cameras and drawn entities, this will take into account RenderLayers.

This value is reset to false every frame in VisibilitySystems::VisibilityPropagate during CoreStage::PostUpdate. Each entity type then chooses how to set this field in the CoreStage::PostUpdate stage in the VisibilitySystems::CheckVisibility system label. Meshes might use frustum culling to decide if they are visible in a view. Other entities might just set this to true every frame.

pub fn set_visible_in_view(&mut self)

Sets is_visible_in_view to true. This is not reversible for a given frame, as it encodes whether or not this is visible in any view. This will be automatically reset to false every frame in VisibilitySystems::VisibilityPropagate and then set to the proper value in VisibilitySystems::CheckVisibility. This should only be set in systems with the VisibilitySystems::CheckVisibility label. Don’t call this unless you are defining a custom visibility system. For normal user-defined entity visibility, see Visibility.

Trait Implementations

impl Clone for ComputedVisibility

fn clone(&self) -> ComputedVisibility

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ComputedVisibilitywhere
    ComputedVisibility: 'static + Send + Sync,

type Storage = TableStorage

impl Debug for ComputedVisibility

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

Formats the value using the given formatter.

impl Default for ComputedVisibility

fn default() -> ComputedVisibility

Returns the “default value” for a type.

impl GetTypeRegistration for ComputedVisibility

fn get_type_registration() -> TypeRegistration

impl PartialEq<ComputedVisibility> for ComputedVisibility

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for ComputedVisibility

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(
    self: Box<ComputedVisibility, Global>
) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(
    self: Box<ComputedVisibility, Global>
) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

fn set(
    &mut self,
    value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<ComputedVisibility, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl Struct for ComputedVisibility

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl Typed for ComputedVisibility

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for ComputedVisibility

impl StructuralEq for ComputedVisibility

impl StructuralPartialEq for ComputedVisibility