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_any_unchecked(object: 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.

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

Returns the object as an Instance<T>.

pub fn entity(&self) -> Entity

Returns the object as an Entity.

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

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

Creates a new Object<T> from an Object<Any> if it is a valid instance of T.

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Returns the associated Instance<T>.

fn entity(&self) -> Entity

Returns the Entity of the associated Instance<T>.

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

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

Formats the value using the given formatter.

impl<T: Kind> Display 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<T: Kind> ObjectHierarchy<T> for Object<'_, '_, '_, T>

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

Returns the parent of this object, if it exists.

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

Iterates over all children of this object.

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

Iterates over all ancestors of this object.

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

Iterates over all descendants of this object in breadth-first order.

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

Iterates over all descendants of this object in depth-first order.

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>

Returns the root of this object’s hierarchy.

fn is_root(&self) -> bool

Returns true if this object is the root of its hierarchy.

fn is_related_to<U: Kind>(&self, other: &impl ObjectHierarchy<U>) -> bool

Returns true if this object has the same root as another.

fn is_child(&self) -> bool

Returns true if this object is a child of another.

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

Returns true if this object is a child of the given Entity.

fn has_children(&self) -> bool

Returns true if this object has any children.

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

Iterates over all children of this object which match the given Query.

fn children_of_kind<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>> + 'a

Iterates over all children of this object which match the given Kind.

fn find_child_of_kind<'w, 's, 'a, U: Kind>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>

Returns the first child of this object which matches the given kind, if it exists.

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

Iterates over this object, followed by all of its ancestors.

fn is_ancestor_of<U: Kind>(&self, other: &impl ObjectHierarchy<U>) -> bool

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

Returns true if this object is an ancestor of another.

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

Iterates over all ancestors of this object which match the given Query.

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

Iterates over this object, followed by all its ancestors which match the given Query.

fn ancestors_of_kind<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>

Iterates over all ancestors of this object which match the given Kind.

fn self_and_ancestors_of_kind<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>

Iterates over this object, followed by all its ancestors which match the given Kind.

fn find_ancestor_of_kind<'w, 's, 'a, U: Kind>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>

Returns the first ancestor of this object which matches the given Kind, if it exists.

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

Iterates over this object and all its descendants in breadth-first order.

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

Iterates over this object and all its descendants in depth-first order.

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

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

Returns true if this object is a descendant of the given entity.

fn descendants_of_kind_wide<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>

Iterates over all descendants of this object which match the given Kind in breadth-first order.

fn descendants_of_kind_deep<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>

Iterates over all descendants of this object which match the given Kind in depth-first order.

fn self_and_descendants_of_kind_wide<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>

Iterates over this object, followed by all its descendants which match the given Kind in breadth-first order.

fn self_and_descendants_of_kind_deep<'w, 's, 'a, U: Kind>( &'a self, objects: &'a Objects<'w, 's, U>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U>>

Iterates over this object, followed by all its descendants which match the given Kind in depth-first order.

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

Iterates over all descendants of this object which match the given Query in breadth-first order.

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

Iterates over all descendants of this object which match the given Kind in depth-first order.

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

Iterates over this object, followed by all its descendants which match the given Query in breadth-first order.

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

Iterates over this object, followed by all its descendants which match the given Query in depth-first order.

fn find_descendant_of_kind_wide<'w, 's, 'a, U: Kind>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>

Returns the first descendant of this object (breadth-first order) which matches the given Kind, if it exists.

fn find_descendant_of_kind_deep<'w, 's, 'a, U: Kind>( &self, objects: &'a Objects<'w, 's, U>, ) -> Option<Object<'w, 's, 'a, U>>

Returns the first descendant of this object (depth-first order) which matches the given Kind, if it exists.

fn path(&self) -> String

Returns the path to 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>

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

Rebinds this object to an Instance of another Kind.

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

Rebinds this object to another Instance of the same Kind.

unsafe 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.

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

Returns this object as an Object<Any>.

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

fn tags(&self) -> &Tags

Returns the Tags of this Object.

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

fn eq(&self, other: &Entity) -> 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> PartialEq<Instance<T>> for Object<'_, '_, '_, T>

fn eq(&self, other: &Instance<T>) -> 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> PartialEq<Object<'_, '_, '_, T>> for Entity

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

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

fn eq(&self, other: &Object<'_, '_, '_, U>) -> 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>