ux-dx 0.2.1

3D Graphics Primitives for Angular Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use crate::engine::d2::{
    input::{MouseButton, MouseCursor, MouseEvent},
    util::Signal1,
};

/// Functions related to the environment's mouse.
pub trait MouseSystem {
    /// True if the environment has a mouse.
    fn is_supported(&self) -> bool;

    /// Emitted when a mouse button is pressed down.
    fn down_signal(&self) -> &Signal1<MouseEvent>;

    /// Emitted when the mouse cursor is moved while over the stage.
    fn move_signal(&self) -> &Signal1<MouseEvent>;

    /// Emitted when a mouse button is released.
    fn up_signal(&self) -> &Signal1<MouseEvent>;

    /// A velocity emitted when the mouse wheel or trackpad is scrolled. A positive value is an
    /// upward scroll, negative is a downward scroll. Typically, each scroll wheel "click" equates to
    /// 1 velocity.
    fn scroll_signal(&self) -> &Signal1<f32>;

    /// The last recorded X coordinate of the mouse.
    fn x(&self) -> f32;

    /// The last recorded Y coordinate of the mouse.
    fn y(&self) -> f32;

    /// The style of the mouse cursor.
    fn cursor(&self) -> MouseCursor;

    /// @returns True if the given button is currently being held down.
    fn is_down(&self, button: MouseButton) -> bool;
}