Struct bevy_ecs::reflect::ReflectComponent
source · pub struct ReflectComponent(/* private fields */);
Expand description
A struct used to operate on reflected Component
trait of a type.
A ReflectComponent
for type T
can be obtained via
bevy_reflect::TypeRegistration::data
.
Implementations§
source§impl ReflectComponent
impl ReflectComponent
sourcepub fn insert(
&self,
entity: &mut EntityWorldMut<'_>,
component: &dyn Reflect,
registry: &TypeRegistry
)
pub fn insert( &self, entity: &mut EntityWorldMut<'_>, component: &dyn Reflect, registry: &TypeRegistry )
sourcepub fn apply_or_insert(
&self,
entity: &mut EntityWorldMut<'_>,
component: &dyn Reflect,
registry: &TypeRegistry
)
pub fn apply_or_insert( &self, entity: &mut EntityWorldMut<'_>, component: &dyn Reflect, registry: &TypeRegistry )
Uses reflection to set the value of this Component
type in the entity to the given value or insert a new one if it does not exist.
sourcepub fn remove(&self, entity: &mut EntityWorldMut<'_>)
pub fn remove(&self, entity: &mut EntityWorldMut<'_>)
Removes this Component
type from the entity. Does nothing if it doesn’t exist.
sourcepub fn contains<'a>(&self, entity: impl Into<FilteredEntityRef<'a>>) -> bool
pub fn contains<'a>(&self, entity: impl Into<FilteredEntityRef<'a>>) -> bool
Returns whether entity contains this Component
sourcepub fn reflect<'a>(
&self,
entity: impl Into<FilteredEntityRef<'a>>
) -> Option<&'a dyn Reflect>
pub fn reflect<'a>( &self, entity: impl Into<FilteredEntityRef<'a>> ) -> Option<&'a dyn Reflect>
Gets the value of this Component
type from the entity as a reflected reference.
sourcepub fn reflect_mut<'a>(
&self,
entity: impl Into<FilteredEntityMut<'a>>
) -> Option<Mut<'a, dyn Reflect>>
pub fn reflect_mut<'a>( &self, entity: impl Into<FilteredEntityMut<'a>> ) -> Option<Mut<'a, dyn Reflect>>
Gets the value of this Component
type from the entity as a mutable reflected reference.
sourcepub unsafe fn reflect_unchecked_mut<'a>(
&self,
entity: UnsafeEntityCell<'a>
) -> Option<Mut<'a, dyn Reflect>>
pub unsafe fn reflect_unchecked_mut<'a>( &self, entity: UnsafeEntityCell<'a> ) -> Option<Mut<'a, dyn Reflect>>
§Safety
This method does not prevent you from having two mutable pointers to the same data, violating Rust’s aliasing rules. To avoid this:
- Only call this method with a
UnsafeEntityCell
that may be used to mutably access the component on the entityentity
- Don’t call this method more than once in the same scope for a given
Component
.
sourcepub fn copy(
&self,
source_world: &World,
destination_world: &mut World,
source_entity: Entity,
destination_entity: Entity,
registry: &TypeRegistry
)
pub fn copy( &self, source_world: &World, destination_world: &mut World, source_entity: Entity, destination_entity: Entity, registry: &TypeRegistry )
sourcepub fn new(fns: ReflectComponentFns) -> Self
pub fn new(fns: ReflectComponentFns) -> Self
Create a custom implementation of ReflectComponent
.
This is an advanced feature, useful for scripting implementations, that should not be used by most users unless you know what you are doing.
Usually you should derive Reflect
and add the #[reflect(Component)]
component
to generate a ReflectComponent
implementation automatically.
See ReflectComponentFns
for more information.
sourcepub fn fn_pointers(&self) -> &ReflectComponentFns
pub fn fn_pointers(&self) -> &ReflectComponentFns
The underlying function pointers implementing methods on ReflectComponent
.
This is useful when you want to keep track locally of an individual function pointer.
Calling TypeRegistry::get
followed by
TypeRegistration::data::<ReflectComponent>
can be costly if done several
times per frame. Consider cloning ReflectComponent
and keeping it
between frames, cloning a ReflectComponent
is very cheap.
If you only need a subset of the methods on ReflectComponent
,
use fn_pointers
to get the underlying ReflectComponentFns
and copy the subset of function pointers you care about.
Trait Implementations§
source§impl Clone for ReflectComponent
impl Clone for ReflectComponent
source§fn clone(&self) -> ReflectComponent
fn clone(&self) -> ReflectComponent
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ReflectComponent
impl RefUnwindSafe for ReflectComponent
impl Send for ReflectComponent
impl Sync for ReflectComponent
impl Unpin for ReflectComponent
impl UnwindSafe for ReflectComponent
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.