Struct PointerCapture 

pub struct PointerCapture {
    pub dragging: bool,
    pub over_ui: bool,
}

Whether the React UI currently owns the mouse pointer. Refreshed every frame in PointerCaptureSet; world-input systems (a 3D camera controller, picking, …) should consult it and ignore the mouse when it reports captured, so a UI drag or click doesn’t also drive the scene.

Order such a system after the set to read the current frame’s state:

app.add_systems(Update, orbit_camera.after(PointerCaptureSet));

Fields

dragging: bool

A bevy-react element is being dragged (an onPointer* press is in progress). Stays true for the whole gesture — even after the cursor leaves the element’s bounds — until the button is released.

over_ui: bool

The pointer is over an interactive UI element (its Interaction is Hovered or Pressed).

Implementations

impl PointerCapture

pub fn is_captured(&self) -> bool

The UI owns the current pointer input; world systems should ignore the mouse. True while dragging a UI element or while over interactive UI.

Trait Implementations

impl Clone for PointerCapture

fn clone(&self) -> PointerCapture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for PointerCapture

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Copy for PointerCapture

impl Debug for PointerCapture

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

Formats the value using the given formatter.

impl Default for PointerCapture

fn default() -> PointerCapture

Returns the “default value” for a type.

impl Resource for PointerCapture

where Self: Send + Sync + 'static,