Struct bevy::render::prelude::SpatialBundle
[−]pub struct SpatialBundle {
pub visibility: Visibility,
pub computed: ComputedVisibility,
pub transform: Transform,
pub global_transform: GlobalTransform,
}
Expand description
A Bundle
with the following Component
s:
-
Visibility
andComputedVisibility
, which describe the visibility of an entity -
Transform
andGlobalTransform
, which describe the position of an entity -
To show or hide an entity, you should set its
Visibility
. -
To get the computed visibility of an entity, you should get its
ComputedVisibility
. -
To place or move an entity, you should set its
Transform
. -
To get the global transform of an entity, you should get its
GlobalTransform
. -
For hierarchies to work correctly, you must have all four components.
- You may use the
SpatialBundle
to guarantee this.
- You may use the
Fields
visibility: Visibility
The visibility of the entity.
computed: ComputedVisibility
The computed visibility of the entity.
transform: Transform
The transform of the entity.
global_transform: GlobalTransform
The global transform of the entity.
Implementations
impl SpatialBundle
impl SpatialBundle
pub const fn from_transform(transform: Transform) -> SpatialBundle
pub const fn from_transform(transform: Transform) -> SpatialBundle
Creates a new SpatialBundle
from a Transform
.
This initializes GlobalTransform
as identity, and visibility as visible
pub const fn visible_identity() -> SpatialBundle
pub const fn visible_identity() -> SpatialBundle
Creates a new identity SpatialBundle
, with no translation, rotation, and a scale of 1
on all axes.
Trait Implementations
impl Bundle for SpatialBundle
impl Bundle for SpatialBundle
SAFETY: ComponentId is returned in field-definition-order. [from_components] and [get_components] use field-definition-order
fn component_ids(
components: &mut Components,
storages: &mut Storages
) -> Vec<ComponentId, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn component_ids(
components: &mut Components,
storages: &mut Storages
) -> Vec<ComponentId, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
unsafe fn from_components<__T, __F>(ctx: &mut __T, func: __F) -> SpatialBundle where
__F: FnMut(&mut __T) -> OwningPtr<'_>,
unsafe fn from_components<__T, __F>(ctx: &mut __T, func: __F) -> SpatialBundle where
__F: FnMut(&mut __T) -> OwningPtr<'_>,
fn get_components(self, func: impl FnMut(OwningPtr<'_>))
fn get_components(self, func: impl FnMut(OwningPtr<'_>))
Calls func
on each value, in the order of this bundle’s Component
s. This will
std::mem::forget
the bundle fields, so callers are responsible for dropping the fields
if that is desirable. Read more
impl Debug for SpatialBundle
impl Debug for SpatialBundle
impl Default for SpatialBundle
impl Default for SpatialBundle
fn default() -> SpatialBundle
fn default() -> SpatialBundle
Returns the “default value” for a type. Read more
impl From<Transform> for SpatialBundle
impl From<Transform> for SpatialBundle
fn from(transform: Transform) -> SpatialBundle
fn from(transform: Transform) -> SpatialBundle
Converts to this type from the input type.
Auto Trait Implementations
impl RefUnwindSafe for SpatialBundle
impl Send for SpatialBundle
impl Sync for SpatialBundle
impl Unpin for SpatialBundle
impl UnwindSafe for SpatialBundle
Blanket Implementations
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U
Return the T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
impl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more