Struct nannou::state::mouse::ButtonMap

pub struct ButtonMap { /* private fields */ }

Stores the state of all mouse buttons.

If the mouse button is down, it stores the position of the mouse when the button was pressed

Implementations

impl ButtonMap

pub fn new() -> Self

Returns a new button map with all buttons unpressed

pub fn relative_to(self, xy: Point2) -> Self

Returns a copy of the ButtonMap relative to the given Point2

pub fn left(&self) -> &ButtonPosition

The state of the left mouse button.

pub fn middle(&self) -> &ButtonPosition

The state of the middle mouse button.

pub fn right(&self) -> &ButtonPosition

The state of the right mouse button.

pub fn press(&mut self, button: Button, xy: Point2)

Sets the Button in the Down position.

pub fn release(&mut self, button: Button)

Set’s the Button in the Up position.

pub fn pressed<'a>(&'a self) -> impl Iterator<Item = (Button, Point2)> + 'a

An iterator yielding all pressed mouse buttons along with the location at which they were originally pressed.

Trait Implementations

impl Clone for ButtonMap

fn clone(&self) -> ButtonMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonMap

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

Formats the value using the given formatter.

impl Index<MouseButton> for ButtonMap

type Output = ButtonPosition

The returned type after indexing.

fn index(&self, button: Button) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<MouseButton> for ButtonMap

fn index_mut(&mut self, button: Button) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq for ButtonMap

fn eq(&self, other: &ButtonMap) -> 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 StructuralPartialEq for ButtonMap