Struct TouchPad 

pub struct TouchPad<A: UiAction> { /* private fields */ }

The virtual stick and its tap buttons, pushing into the kit’s action sink.

Owned by the app for the life of the game, like the games’ own touch state: the pad holds the finger that is down, its origin and the gate.

Implementations

impl<A: UiAction> TouchPad<A>

pub fn new(kit: Kit<A>) -> Self

A pad sharing kit’s sink, palette and scale.

pub fn with_zone(self, fraction: f32) -> Result<Self, TouchError>

Cover a different fraction of the viewport width with the stick’s zone.

pub fn kit(&self) -> &Kit<A>

pub fn enabled(&self) -> bool

Whether the pad is taking pointers this frame.

pub fn active(&self) -> bool

Whether a finger is on the stick.

pub fn stick(&self) -> Vec2

The stick’s value: dead-zoned, clamped to the unit disc, y down.

Poll it where the game already combines its move axes; it is not an action because movement is a level, not an edge.

pub fn begin_frame(&self, flow: FlowState)

Per-frame gate: the pad takes pointers only while the game owns input.

Call before composing (or before the sim step) with the same FlowState the gameplay systems read. Closing the gate releases a finger that is still down, so the game cannot keep moving under a modal.

pub fn begin_frame_in(&self, world: &World)

Per-frame gate read straight from the sim world.

A world where the flow was never installed reads as FlowState::CLOSED, so the overlay is closed rather than live.

pub fn release(&self)

Forget the stick without touching the gate.

pub fn view(&self, viewport: [f32; 2]) -> View

The stick’s touch zone and ring, to be composed over the game.

Nothing is composed while the gate is closed.

pub fn tap( &self, viewport: [f32; 2], glyph: &str, at: [f32; 2], radius: f32, action: A, ) -> View

A round tap button at a design-space point, pushing action on release.

Sized like the glyph buttons and placed absolutely, so it can sit under the thumb. Touch buttons stay out of keyboard traversal: a finger is not a focus.

pub fn driver(&self) -> NavDriver

The traversal driver for the pad’s controls, when a game wants a panel’s buttons reachable from a stick as well as from a finger: a touch stick is a pointer, so this is only for a game that also reads it as a directional axis.

Trait Implementations

impl<A: Clone + UiAction> Clone for TouchPad<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.