Struct Object

pub struct Object<'w, 's, 'a, T: Kind = Any> { /* private fields */ }

Represents an Entity of Kind T with hierarchy and name information.

Implementations

impl<'w, 's, 'a, T: Kind> Object<'w, 's, 'a, T>

pub unsafe fn from_base_unchecked(base: Object<'w, 's, 'a>) -> Self

Creates a new Object<T> from an Object<Any>.

This is semantically equivalent to an unsafe downcast.

Safety

Assumes base is of Kind T.

impl<'w, 's, 'a, T: Component> Object<'w, 's, 'a, T>

pub fn from_base( world: &World, object: Object<'w, 's, 'a>, ) -> Option<Object<'w, 's, 'a, T>>

Trait Implementations

impl<T: Kind> Clone for Object<'_, '_, '_, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Kind> Debug for Object<'_, '_, '_, T>

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

Formats the value using the given formatter.

impl<'w, 's, 'a, T: Kind> From<&ObjectRef<'w, 's, 'a, T>> for Object<'w, 's, 'a, T>

fn from(object: &ObjectRef<'w, 's, 'a, T>) -> Self

Converts to this type from the input type.

impl<T: Kind> From<Object<'_, '_, '_, T>> for Entity

fn from(object: Object<'_, '_, '_, T>) -> Self

Converts to this type from the input type.

impl<T: Kind> From<Object<'_, '_, '_, T>> for Instance<T>

fn from(object: Object<'_, '_, '_, T>) -> Self

Converts to this type from the input type.

impl<'w, 's, 'a, T: Kind> From<ObjectRef<'w, 's, 'a, T>> for Object<'w, 's, 'a, T>

fn from(object: ObjectRef<'w, 's, 'a, T>) -> Self

Converts to this type from the input type.

impl<'w, 's, 'a, T: Kind> ObjectHierarchy<T> for Object<'w, 's, 'a, T>

fn parent(&self) -> Option<Self::Rebind<Any>>

fn children(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn ancestors(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn descendants_wide(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn descendants_deep(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn find_by_path(&self, path: impl AsRef<str>) -> Option<Self::Rebind<Any>>

Attempts to find an object by its path, relative to this one.

fn root(&self) -> Self::Rebind<Any>

fn is_root(&self) -> bool

fn is_child(&self) -> bool

fn is_child_of(&self, parent: Entity) -> bool

fn has_children(&self) -> bool

fn query_children<'a, Q: QueryData, F: QueryFilter>( &'a self, query: &'a Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn children_of_kind<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

fn find_child_of_kind<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

fn self_and_ancestors(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn is_ancestor_of(&self, entity: Entity) -> bool

where Self::Rebind<Any>: ObjectHierarchy<Any>,

fn query_ancestors<'a, Q: QueryData, F: QueryFilter>( &'a self, query: &'a Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn query_self_and_ancestors<'a, Q: QueryData, F: QueryFilter>( &'a self, query: &'a Query<'_, '_, Q, F>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn ancestors_of_kind<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

fn find_ancestor_of_kind<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

fn self_and_descendants_wide(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn self_and_descendants_deep(&self) -> impl Iterator<Item = Self::Rebind<Any>>

fn is_descendant_of(&self, entity: Entity) -> bool

where Self::Rebind<Any>: ObjectHierarchy<Any>,

fn descendants_of_kind_wide<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

fn descendants_of_kind_deep<'a, U: Kind>( &'a self, objects: &'a Objects<'_, '_, U>, ) -> impl Iterator<Item = Self::Rebind<U>> + 'a

fn query_descendants_wide<'a, Q: QueryData>( &'a self, query: &'a Query<'_, '_, Q>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn query_descendants_deep<'a, Q: QueryData>( &'a self, query: &'a Query<'_, '_, Q>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn query_self_and_descendants_wide<'a, Q: QueryData>( &'a self, query: &'a Query<'_, '_, Q>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn query_self_and_descendants_deep<'a, Q: QueryData>( &'a self, query: &'a Query<'_, '_, Q>, ) -> impl Iterator<Item = QueryItem<'a, Q::ReadOnly>> + 'a

fn find_descendant_of_kind_wide<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

fn find_descendant_of_kind_deep<U: Kind>( &self, objects: &Objects<'_, '_, U>, ) -> Option<Self::Rebind<U>>

impl<T: Kind> ObjectInstance<T> for Object<'_, '_, '_, T>

fn instance(&self) -> Instance<T>

Returns the Instance of this object.

fn entity(&self) -> Entity

Returns the Entity of this object.

impl<T: Kind> ObjectName for Object<'_, '_, '_, T>

fn name(&self) -> Option<&str>

Returns the Name of this object.

impl<'w, 's, 'a, T: Kind> ObjectRebind<T> for Object<'w, 's, 'a, T>

type Rebind<U: Kind> = Object<'w, 's, 'a, U>

fn rebind_as<U: Kind>(&self, instance: Instance<U>) -> Self::Rebind<U>

Rebinds this object to an Instance of another Kind.

fn rebind(&self, instance: Instance<T>) -> Self::Rebind<T>

Rebinds this object to another Instance of the same Kind.

fn rebind_any(&self, entity: Entity) -> Self::Rebind<Any>

Rebinds this object to another Entity.

fn cast_into<U: Kind>(self) -> Self::Rebind<U>

where T: CastInto<U>,

Casts this object into another of a related Kind.

fn cast_into_any(self) -> Self::Rebind<Any>

Casts this object into an Object<Any>.

unsafe fn cast_into_unchecked<U: Kind>(self) -> Self::Rebind<U>

Casts this object into another of a different Kind.

impl<T: Kind> PartialEq for Object<'_, '_, '_, T>

fn eq(&self, other: &Self) -> 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<T: Kind> Copy for Object<'_, '_, '_, T>

impl<T: Kind> Eq for Object<'_, '_, '_, T>