Struct PointerCaptureMap 

pub struct PointerCaptureMap(pub HashMap<PointerId, (Entity, HitData)>);

Overrides the HoverMap for captured pointers, forcing a single entity to be reported as hovered regardless of where the pointer physically is.

When a pointer is captured by an entity, that entity is reported as the sole hover target for that pointer. This keeps interactions (like dragging a slider) working correctly even when the pointer drifts outside the entity’s bounding box while a button is held.

Use PointerCaptureMap::capture to lock a pointer to an entity, and PointerCaptureMap::release to remove the lock. Captures are automatically cleaned up when the associated pointer entity is removed.

A pointer’s capture is also released automatically when that pointer reports a button release or cancel action.

Tuple Fields

0: HashMap<PointerId, (Entity, HitData)>

Implementations

impl PointerCaptureMap

pub fn capture(&mut self, pointer: PointerId, entity: Entity, hit: HitData)

Lock pointer to entity. The provided hit is injected into the HoverMap for the duration of the capture so downstream systems see consistent hit data.

pub fn release(&mut self, pointer: PointerId) -> Option<(Entity, HitData)>

Remove the capture for pointer, returning the previously captured entity and hit data if one existed.

pub fn get(&self, pointer: &PointerId) -> Option<(Entity, &HitData)>

Return the captured (Entity, &HitData) for pointer, or None if not captured.

pub fn is_captured(&self, pointer: &PointerId) -> bool

Returns true if pointer is currently captured.

Trait Implementations

impl Component for PointerCaptureMap

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]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for PointerCaptureMap

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

Formats the value using the given formatter.

impl Default for PointerCaptureMap

fn default() -> PointerCaptureMap

Returns the “default value” for a type.

impl Resource for PointerCaptureMap

where Self: Send + Sync + 'static,