PointerTraversal

Struct PointerTraversal 

Source
pub struct PointerTraversal { /* private fields */ }
Expand description

A traversal query (i.e. it implements Traversal) intended for use with Pointer events.

This will always traverse to the parent, if the entity being visited has one. Otherwise, it propagates to the pointer’s window and stops there.

Trait Implementations§

Source§

impl QueryData for PointerTraversal

SAFETY: we assert fields are readonly below

Source§

unsafe fn fetch<'__w, '__s>( _state: &'__s <PointerTraversal as WorldQuery>::State, _fetch: &mut <PointerTraversal as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> <PointerTraversal as QueryData>::Item<'__w, '__s>

SAFETY: we call fetch for each member that implements Fetch.

Source§

const IS_READ_ONLY: bool = true

True if this query is read-only and may not perform mutable access.
Source§

type ReadOnly = PointerTraversal

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.
Source§

type Item<'__w, '__s> = PointerTraversalItem<'__w, '__s>

The item returned by this WorldQuery This will be the data retrieved by the query, and is visible to the end user when calling e.g. Query<Self>::get.
Source§

fn shrink<'__wlong, '__wshort, '__s>( item: <PointerTraversal as QueryData>::Item<'__wlong, '__s>, ) -> <PointerTraversal as QueryData>::Item<'__wshort, '__s>
where '__wlong: '__wshort,

This function manually implements subtyping for the query items.
Source§

fn provide_extra_access( state: &mut <PointerTraversal as WorldQuery>::State, access: &mut Access, available_access: &Access, )

Offers additional access above what we requested in update_component_access. Implementations may add additional access that is a subset of available_access and does not conflict with anything in access, and must update access to include that access. Read more
Source§

impl ReleaseStateQueryData for PointerTraversal
where Option<&'static ChildOf>: for<'__a> ReleaseStateQueryData, Option<&'static Window>: for<'__a> ReleaseStateQueryData,

Source§

fn release_state<'__w>( _item: <PointerTraversal as QueryData>::Item<'__w, '_>, ) -> <PointerTraversal as QueryData>::Item<'__w, 'static>

Releases the borrow from the query state by converting an item to have a 'static state lifetime.
Source§

impl<E> Traversal<Pointer<E>> for PointerTraversal
where E: Debug + Clone + Reflect,

Source§

fn traverse( item: <PointerTraversal as QueryData>::Item<'_, '_>, pointer: &Pointer<E>, ) -> Option<Entity>

Returns the next entity to visit.
Source§

impl WorldQuery for PointerTraversal

Source§

unsafe fn set_archetype<'__w, '__s>( _fetch: &mut <PointerTraversal as WorldQuery>::Fetch<'__w>, _state: &'__s <PointerTraversal as WorldQuery>::State, _archetype: &'__w Archetype, _table: &'__w Table, )

SAFETY: we call set_archetype for each member that implements Fetch

Source§

unsafe fn set_table<'__w, '__s>( _fetch: &mut <PointerTraversal as WorldQuery>::Fetch<'__w>, _state: &'__s <PointerTraversal as WorldQuery>::State, _table: &'__w Table, )

SAFETY: we call set_table for each member that implements Fetch

Source§

const IS_DENSE: bool = true

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components. Read more
Source§

type Fetch<'__w> = PointerTraversalFetch<'__w>

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.
Source§

type State = PointerTraversalState

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.
Source§

fn shrink_fetch<'__wlong, '__wshort>( fetch: <PointerTraversal as WorldQuery>::Fetch<'__wlong>, ) -> <PointerTraversal as WorldQuery>::Fetch<'__wshort>
where '__wlong: '__wshort,

This function manually implements subtyping for the query fetches.
Source§

unsafe fn init_fetch<'__w, '__s>( _world: UnsafeWorldCell<'__w>, state: &'__s <PointerTraversal as WorldQuery>::State, _last_run: Tick, _this_run: Tick, ) -> <PointerTraversal as WorldQuery>::Fetch<'__w>

Creates a new instance of Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access. Read more
Source§

fn update_component_access( state: &<PointerTraversal as WorldQuery>::State, _access: &mut FilteredAccess, )

Adds any component accesses used by this WorldQuery to access. Read more
Source§

fn init_state(world: &mut World) -> PointerTraversalState

Creates and initializes a State for this WorldQuery type.
Source§

fn get_state(components: &Components) -> Option<PointerTraversalState>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.
Source§

fn matches_component_set( state: &<PointerTraversal as WorldQuery>::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false. Read more
Source§

impl ReadOnlyQueryData for PointerTraversal

SAFETY: we assert fields are readonly below

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &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)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,