Struct ark_api::applet::input::PointerState

pub struct PointerState {
    pub pos: Option<Vec2>,
    pub ray: Option<Ray3>,
    pub primary: bool,
    pub secondary: bool,
    pub middle: bool,
    pub touch_id: Option<TouchId>,
}

The state of the pointer (mouse or touch).

Fields

pos: Option<Vec2>

Logical point position of the pointer (mouse or touch). Can be None if mouse is not on screen, or if there are no touches. In case of multiple simultaneous touches, this will correspond to the first touch.

ray: Option<Ray3>

World-space ray of the pointer (mouse or touch). Can be None if mouse is not on screen, or if there are no touches. In case of multiple simultaneous touches, this will correspond to the first touch.

primary: bool

True if the primary button is currently down. Left mouse button on most mice. This is also set to true for the primary touch.

secondary: bool

True if the secondary button is currently down. Left mouse button on most mice.

middle: bool

True if the middle mouse button is currently down.

touch_id: Option<TouchId>

The id of the first touch that went down (in case there are several touches). This is the touch that is being represented by PointerState.

Implementations

impl PointerState

pub fn any_button(&self) -> bool

Any mouse button is down (always true for primary touches).

Trait Implementations

impl Clone for PointerState

fn clone(&self) -> PointerState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PointerState

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

Formats the value using the given formatter.

impl Default for PointerState

fn default() -> PointerState

Returns the “default value” for a type.

impl PartialEq<PointerState> for PointerState

fn eq(&self, other: &PointerState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PointerState

impl StructuralPartialEq for PointerState