Struct ObjectWorldRef 

pub struct ObjectWorldRef<'w, T: Kind = Any, R: Relationship = ChildOf> { /* private fields */ }

Similar to an ObjectRef, but accessible via World.

Implementations

impl<'w, T: Kind, R: Relationship> ObjectWorldRef<'w, T, R>

pub unsafe fn from_any_unchecked(object: ObjectWorldRef<'w, Any, R>) -> Self

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

This is semantically equivalent to an unsafe downcast.

Safety

Assumes object is of Kind T.

pub fn from_any(object: ObjectWorldRef<'w, Any, R>) -> Option<Self>

where T: Component,

Creates a new ObjectWorldRef<T> from an ObjectWorldRef<Any> if the object contains the given Component T.

This is semantically equivalent to a safe downcast.

pub fn get<U: Component>(&self) -> Option<&U>

See EntityRef::get.

pub fn contains<U: Component>(&self) -> bool

See EntityRef::contains.

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

Returns the object as an Instance<T>.

pub fn entity(&self) -> Entity

Returns the object as an Entity.

pub fn as_entity(&self) -> EntityRef<'w>

Returns the object as an EntityRef.

Trait Implementations

impl<T: Kind, R: Relationship> Clone for ObjectWorldRef<'_, T, R>

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, R: Relationship> ContainsInstance<T> for ObjectWorldRef<'_, T, R>

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, R: Relationship> Copy for ObjectWorldRef<'_, T, R>

impl<T: Kind, R: Relationship> Debug for ObjectWorldRef<'_, T, R>

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

Formats the value using the given formatter.

impl<T: Component, R: Relationship> Deref for ObjectWorldRef<'_, T, R>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Kind, R: Relationship> Display for ObjectWorldRef<'_, T, R>

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

Formats the value using the given formatter.

impl<T: Kind, R: Relationship> Eq for ObjectWorldRef<'_, T, R>

impl<T: Kind, R: Relationship> From<ObjectWorldRef<'_, T, R>> for Entity

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

Converts to this type from the input type.

impl<T: Kind, R: Relationship> From<ObjectWorldRef<'_, T, R>> for Instance<T>

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

Converts to this type from the input type.

impl<T: Kind, R: Relationship> ObjectHierarchy<T, R> for ObjectWorldRef<'_, T, R>

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

Returns the parent of this object, if it exists.

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

Iterates over all children of this object.

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

Iterates over all ancestors of this object.

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

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

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

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

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

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

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

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, R>) -> 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, F2: QueryFilter, R2: Relationship>( &'a self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U, R2>> + 'a

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

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

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, R>>

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

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

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

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, F2: QueryFilter, R2: Relationship>( &'a self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U, R2>>

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

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

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

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

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, R>>

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

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

where for<'i> SourceIter<'i, R::RelationshipTarget>: DoubleEndedIterator,

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

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

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

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

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

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, F2: QueryFilter, R2: Relationship>( &'a self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U, R2>>

where for<'i> SourceIter<'i, R::RelationshipTarget>: DoubleEndedIterator,

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, F2: QueryFilter, R2: Relationship>( &'a self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U, R2>>

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, F2: QueryFilter, R2: Relationship>( &'a self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> impl Iterator<Item = Object<'w, 's, 'a, U, R2>>

where for<'i> SourceIter<'i, R::RelationshipTarget>: DoubleEndedIterator,

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

where for<'i> SourceIter<'i, R::RelationshipTarget>: DoubleEndedIterator,

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

where for<'i> SourceIter<'i, R::RelationshipTarget>: DoubleEndedIterator,

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, F2: QueryFilter, R2: Relationship>( &self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> Option<Object<'w, 's, 'a, U, R2>>

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, F2: QueryFilter, R2: Relationship>( &self, objects: &'a Objects<'w, 's, U, F2, R2>, ) -> Option<Object<'w, 's, 'a, U, R2>>

where for<'i> SourceIter<'i, R::RelationshipTarget>: DoubleEndedIterator,

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, R: Relationship> ObjectName for ObjectWorldRef<'_, T, R>

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

Returns the Name of this object.

impl<'w, T: Kind, R: Relationship> ObjectRebind<T, R> for ObjectWorldRef<'w, T, R>

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

Rebinds this object to an Instance of another Kind.

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

Rebinds this object to another Instance of the same Kind.

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

Rebinds this object to another Entity.

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

where T: CastInto<U>,

Casts this object into another of a related Kind.

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

Casts this object into an Object<Any>.

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

Casts this object into another of a different Kind.

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

Returns this object as an Object<Any>.

impl<T: Kind, R: Relationship> ObjectTags for ObjectWorldRef<'_, T, R>

fn tags(&self) -> &Tags

Returns the Tags of this Object.

impl<T: Kind, R: Relationship> PartialEq<Entity> for ObjectWorldRef<'_, T, R>

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, R: Relationship> PartialEq<Instance<T>> for ObjectWorldRef<'_, T, R>

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, R: Relationship> PartialEq<ObjectWorldRef<'_, T, R>> for Instance<T>

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

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

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