[][src]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

Implementations

impl<S> ButtonMap<S> where
    S: BaseFloat
[src]

pub fn new() -> Self[src]

Returns a new button map with all states set to None

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

Returns a copy of the ButtonMap relative to the given Point

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

The state of the left mouse button.

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

The state of the middle mouse button.

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

The state of the right mouse button.

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

Sets the Button in the Down position.

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

Set's the Button in the Up position.

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

Notable traits for PressedButtons<'a, S>

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

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

Trait Implementations

impl<S: Clone> Clone for ButtonMap<S>[src]

impl<S: Copy> Copy for ButtonMap<S>[src]

impl<S: Debug> Debug for ButtonMap<S>[src]

impl<S> Index<MouseButton> for ButtonMap<S>[src]

type Output = ButtonPosition<S>

The returned type after indexing.

impl<S: PartialEq> PartialEq<ButtonMap<S>> for ButtonMap<S>[src]

impl<S> StructuralPartialEq for ButtonMap<S>[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for ButtonMap<S> where
    S: RefUnwindSafe

impl<S> Send for ButtonMap<S> where
    S: Send

impl<S> Sync for ButtonMap<S> where
    S: Sync

impl<S> Unpin for ButtonMap<S> where
    S: Unpin

impl<S> UnwindSafe for ButtonMap<S> where
    S: UnwindSafe

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, U> ConvertInto<U> for T where
    U: ConvertFrom<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> SetParameter for T

impl<T> Style for T where
    T: Any + Debug + PartialEq<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,