pub struct NodeQuery { /* private fields */ }Expand description
Main query for ui_focus_system
Trait Implementations§
Source§impl QueryData for NodeQuery
SAFETY: we assert fields are readonly below
impl QueryData for NodeQuery
SAFETY: we assert fields are readonly below
Source§unsafe fn fetch<'__w, '__s>(
_state: &'__s Self::State,
_fetch: &mut <Self as WorldQuery>::Fetch<'__w>,
_entity: Entity,
_table_row: TableRow,
) -> Self::Item<'__w, '__s>
unsafe fn fetch<'__w, '__s>( _state: &'__s Self::State, _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _entity: Entity, _table_row: TableRow, ) -> Self::Item<'__w, '__s>
SAFETY: we call fetch for each member that implements Fetch.
Source§const IS_READ_ONLY: bool = false
const IS_READ_ONLY: bool = false
True if this query is read-only and may not perform mutable access.
Source§type ReadOnly = NodeQueryReadOnly
type ReadOnly = NodeQueryReadOnly
The read-only variant of this
QueryData, which satisfies the ReadOnlyQueryData trait.Source§type Item<'__w, '__s> = NodeQueryItem<'__w, '__s>
type Item<'__w, '__s> = NodeQueryItem<'__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, '__wshort, '__s>(
item: Self::Item<'__wlong, '__s>,
) -> Self::Item<'__wshort, '__s>
fn shrink<'__wlong: '__wshort, '__wshort, '__s>( item: Self::Item<'__wlong, '__s>, ) -> Self::Item<'__wshort, '__s>
This function manually implements subtyping for the query items.
Source§fn provide_extra_access(
state: &mut Self::State,
access: &mut Access,
available_access: &Access,
)
fn provide_extra_access( state: &mut Self::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 moreSource§impl ReleaseStateQueryData for NodeQuerywhere
for<'__a> Entity: ReleaseStateQueryData,
for<'__a> &'static ComputedNode: ReleaseStateQueryData,
for<'__a> &'static UiGlobalTransform: ReleaseStateQueryData,
for<'__a> Option<&'static mut Interaction>: ReleaseStateQueryData,
for<'__a> Option<&'static mut RelativeCursorPosition>: ReleaseStateQueryData,
for<'__a> Option<&'static FocusPolicy>: ReleaseStateQueryData,
for<'__a> Option<&'static InheritedVisibility>: ReleaseStateQueryData,
for<'__a> &'static ComputedUiTargetCamera: ReleaseStateQueryData,
impl ReleaseStateQueryData for NodeQuerywhere
for<'__a> Entity: ReleaseStateQueryData,
for<'__a> &'static ComputedNode: ReleaseStateQueryData,
for<'__a> &'static UiGlobalTransform: ReleaseStateQueryData,
for<'__a> Option<&'static mut Interaction>: ReleaseStateQueryData,
for<'__a> Option<&'static mut RelativeCursorPosition>: ReleaseStateQueryData,
for<'__a> Option<&'static FocusPolicy>: ReleaseStateQueryData,
for<'__a> Option<&'static InheritedVisibility>: ReleaseStateQueryData,
for<'__a> &'static ComputedUiTargetCamera: ReleaseStateQueryData,
Source§fn release_state<'__w>(_item: Self::Item<'__w, '_>) -> Self::Item<'__w, 'static>
fn release_state<'__w>(_item: Self::Item<'__w, '_>) -> Self::Item<'__w, 'static>
Releases the borrow from the query state by converting an item to have a
'static state lifetime.Source§impl WorldQuery for NodeQuery
impl WorldQuery for NodeQuery
Source§unsafe fn set_archetype<'__w, '__s>(
_fetch: &mut <Self as WorldQuery>::Fetch<'__w>,
_state: &'__s Self::State,
_archetype: &'__w Archetype,
_table: &'__w Table,
)
unsafe fn set_archetype<'__w, '__s>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &'__s Self::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 <Self as WorldQuery>::Fetch<'__w>,
_state: &'__s Self::State,
_table: &'__w Table,
)
unsafe fn set_table<'__w, '__s>( _fetch: &mut <Self as WorldQuery>::Fetch<'__w>, _state: &'__s Self::State, _table: &'__w Table, )
SAFETY: we call set_table for each member that implements Fetch
Source§const IS_DENSE: bool = true
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> = NodeQueryFetch<'__w>
type Fetch<'__w> = NodeQueryFetch<'__w>
Per archetype/table state retrieved by this
WorldQuery to compute Self::Item for each entity.Source§type State = NodeQueryState
type State = NodeQueryState
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, '__wshort>(
fetch: <NodeQuery as WorldQuery>::Fetch<'__wlong>,
) -> <NodeQuery as WorldQuery>::Fetch<'__wshort>
fn shrink_fetch<'__wlong: '__wshort, '__wshort>( fetch: <NodeQuery as WorldQuery>::Fetch<'__wlong>, ) -> <NodeQuery as WorldQuery>::Fetch<'__wshort>
This function manually implements subtyping for the query fetches.
Source§unsafe fn init_fetch<'__w, '__s>(
_world: UnsafeWorldCell<'__w>,
state: &'__s Self::State,
_last_run: Tick,
_this_run: Tick,
) -> <Self as WorldQuery>::Fetch<'__w>
unsafe fn init_fetch<'__w, '__s>( _world: UnsafeWorldCell<'__w>, state: &'__s Self::State, _last_run: Tick, _this_run: Tick, ) -> <Self 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 moreSource§fn update_component_access(state: &Self::State, _access: &mut FilteredAccess)
fn update_component_access(state: &Self::State, _access: &mut FilteredAccess)
Source§fn init_state(world: &mut World) -> NodeQueryState
fn init_state(world: &mut World) -> NodeQueryState
Creates and initializes a
State for this WorldQuery type.Source§fn get_state(components: &Components) -> Option<NodeQueryState>
fn get_state(components: &Components) -> Option<NodeQueryState>
Source§fn matches_component_set(
state: &Self::State,
_set_contains_id: &impl Fn(ComponentId) -> bool,
) -> bool
fn matches_component_set( state: &Self::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool
Auto Trait Implementations§
impl Freeze for NodeQuery
impl RefUnwindSafe for NodeQuery
impl Send for NodeQuery
impl Sync for NodeQuery
impl Unpin for NodeQuery
impl !UnwindSafe for NodeQuery
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
Mutably borrows from an owned value. Read more
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>
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>
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)
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)
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> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.