Struct MotionEvent

pub struct MotionEvent { /* private fields */ }

A motion event

Wraps an AInputEvent * of the ffi::AINPUT_EVENT_TYPE_MOTION type.

For general discussion of motion events in Android, see the relevant javadoc.

Implementations

impl MotionEvent

pub unsafe fn from_ptr(ptr: NonNull<AInputEvent>) -> Self

Constructs a MotionEvent from a pointer to a native ffi::AInputEvent

Safety

By calling this method, you assert that the pointer is a valid, non-null pointer to a native ffi::AInputEvent and that ffi::AInputEvent is an AMotionEvent.

pub unsafe fn from_java( env: *mut JNIEnv, key_event: jobject, ) -> Option<InputEventJava>

Available on crate feature api-level-31 only.

Creates a native InputEvent object that is a copy of the specified Java android.view.MotionEvent. The result may be used with generic and MotionEvent-specific functions.

Safety

This function should be called with a healthy JVM pointer and with a non-null android.view.MotionEvent.

pub fn ptr(&self) -> NonNull<AInputEvent>

Returns a pointer to the native ffi::AInputEvent.

pub fn source(&self) -> Source

Get the source of the event.

See the NDK docs

pub fn device_id(&self) -> i32

Get the device id associated with the event.

See the NDK docs

pub fn action(&self) -> MotionAction

Returns the motion action associated with the event.

See the NDK docs

pub fn pointer_index(&self) -> usize

Returns the pointer index of an Up or Down event.

Pointer indices can change per motion event. For an identifier that stays the same, see Pointer::pointer_id().

This only has a meaning when the action is one of Up, Down, PointerUp, or PointerDown.

pub fn pointer_count(&self) -> usize

Returns the number of pointers in this event

See the NDK docs

pub fn pointers(&self) -> PointersIter<'_>

An iterator over the pointers in this motion event

pub fn pointer_at_index(&self, index: usize) -> Pointer<'_>

The pointer at a given pointer index. Panics if the pointer index is out of bounds.

If you need to loop over all the pointers, prefer the pointers() method.

pub fn history_size(&self) -> usize

Returns the size of the history contained in this event.

See the NDK docs

pub fn history(&self) -> HistoricalMotionEventsIter<'_>

An iterator over the historical events contained in this event.

pub fn meta_state(&self) -> MetaState

Returns the state of any modifier keys that were pressed during the event.

See the NDK docs

pub fn button_state(&self) -> ButtonState

Returns the button state during this event, as a bitfield.

See the NDK docs

pub fn down_time(&self) -> i64

Returns the time of the start of this gesture, in the java.lang.System.nanoTime() time base

See the NDK docs

pub fn edge_flags(&self) -> EdgeFlags

Returns a bitfield indicating which edges were touched by this event.

See the NDK docs

pub fn event_time(&self) -> i64

Returns the time of this event, in the java.lang.System.nanoTime() time base

See the NDK docs

pub fn flags(&self) -> MotionEventFlags

The flags associated with a motion event.

See the NDK docs

pub fn x_offset(&self) -> f32

Returns the offset in the x direction between the coordinates and the raw coordinates

See the NDK docs

pub fn y_offset(&self) -> f32

Returns the offset in the y direction between the coordinates and the raw coordinates

See the NDK docs

pub fn x_precision(&self) -> f32

Returns the precision of the x value of the coordinates

See the NDK docs

pub fn y_precision(&self) -> f32

Returns the precision of the y value of the coordinates

See the NDK docs

Trait Implementations

impl Clone for MotionEvent

fn clone(&self) -> MotionEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MotionEvent

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

Formats the value using the given formatter.