Struct nannou::state::mouse::ButtonMap

pub struct ButtonMap<S = DefaultScalar> { /* fields omitted */ }

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

Methods

impl<S> ButtonMap<S> where
    S: BaseFloat, 

pub fn new() -> Self

Returns a new button map with all states set to None

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

Returns a copy of the ButtonMap relative to the given Point

pub fn left(&self) -> &ButtonPosition<S>

The state of the left mouse button.

pub fn middle(&self) -> &ButtonPosition<S>

The state of the middle mouse button.

pub fn right(&self) -> &ButtonPosition<S>

The state of the right mouse button.

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

Sets the Button in the Down position.

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

Set's the Button in the Up position.

Important traits for PressedButtons<'a, S>

impl<'a, S> Iterator for PressedButtons<'a, S> where
    S: BaseFloat,  type Item = (Button, Point2<S>);

pub fn pressed(&self) -> PressedButtons<S>

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

Trait Implementations

impl<S: PartialEq> PartialEq<ButtonMap<S>> for ButtonMap<S>

fn eq(&self, other: &ButtonMap<S>) -> bool

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

fn ne(&self, other: &ButtonMap<S>) -> bool

This method tests for !=.

impl<S: Clone> Clone for ButtonMap<S>

fn clone(&self) -> ButtonMap<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for ButtonMap<S>

impl<S: Debug> Debug for ButtonMap<S>

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

Formats the value using the given formatter.

impl<S> Index<MouseButton> for ButtonMap<S>

type Output = ButtonPosition<S>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.