| Copyright | (c) Pavel Krajcevski, 2014 |
|---|---|
| License | MIT |
| Maintainer | Krajcevski@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
FRP.Netwire.Input
Description
This module contains definitions for typeclasses and wires to be used in FRP
programs that use netwire. In order to use this module, an implementation that
provides an instance of one of the underlying typeclasses MonadMouse or
MonadKeyboard must be used. In order to not require the GLFW or SDL libraries
as dependencies, these instances are provided in separate libraries.
- class MouseButton a
- data CursorMode
- class (MouseButton mb, Monad m) => MonadMouse mb m | m -> mb where
- setCursorMode :: CursorMode -> m ()
- mbIsPressed :: mb -> m Bool
- releaseButton :: mb -> m ()
- cursor :: m (Float, Float)
- scroll :: m (Double, Double)
- mouseCursor :: MonadMouse mb m => Wire s e m a (Float, Float)
- mouseDelta :: (MonadFix m, MonadMouse mb m) => Wire s e m a (Float, Float)
- mouseMickies :: MonadMouse mb m => Wire s e m a (Float, Float)
- mousePressed :: (Monoid e, MonadMouse mb m) => mb -> Wire s e m a a
- mouseDebounced :: (Monoid e, MonadMouse mb m) => mb -> Wire s e m a a
- mouseScroll :: (Monoid e, MonadMouse mb m) => Wire s e m a (Double, Double)
- mouseScrolled :: (Monoid e, MonadMouse mb m) => Wire s e m a (Double, Double)
- cursorMode :: (MonadMouse mb m, Monoid e) => CursorMode -> Wire s e m a a
- class Key a
- class (Key k, Monad m) => MonadKeyboard k m | m -> k where
- keyIsPressed :: k -> m Bool
- releaseKey :: k -> m ()
- keyPressed :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a
- keyNotPressed :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a
- keyDebounced :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a
Mouse input
class MouseButton a Source
Mouse button typeclass. This is used to constrain the type of Monad used | to provide mouse input.
data CursorMode Source
The mouse cursor mode. This mode is usually dependent on whether or not the mouse is in the bounds of the application window.
Constructors
| CursorMode'Disabled | The mouse cursor is disabled |
| CursorMode'Reset | Reset the cursor to zero between computations |
| CursorMode'Hidden | The mouse cursor is hidden when over the application |
| CursorMode'Enabled | The mouse cursor is enabed and visible over the application |
Instances
Mouse input
class (MouseButton mb, Monad m) => MonadMouse mb m | m -> mb where Source
This monad describes computations that involve mouse input.
Methods
setCursorMode :: CursorMode -> m () Source
Sets the cursor mode for all subsequent computations. Note, that many | implementations require some sort of "poll" to read the IO
mbIsPressed :: mb -> m Bool Source
Returns true if the given mouse button is pressed
releaseButton :: mb -> m () Source
Resets the pressed state of the mouse button
cursor :: m (Float, Float) Source
Get the current cursor location
scroll :: m (Double, Double) Source
Get the amount of scrolling done in the x and y directions
Mouse input wires
mouseCursor :: MonadMouse mb m => Wire s e m a (Float, Float) Source
Ignores its input and returns
the current normalized mouse coordinates. Regardless of window size,
each of the returned coordinates will be in the range [-1, 1].
- Depends: now
- Inhibits: never
mouseDelta :: (MonadFix m, MonadMouse mb m) => Wire s e m a (Float, Float) Source
Returns the change in mouse coordinates between subsequent time instants
- Depends: before now
- Inhibits: never
mouseMickies :: MonadMouse mb m => Wire s e m a (Float, Float) Source
The mouse mickies are the offset from zero at each time instant. If this
wire is being used, then it is assuming that the cursor mode is set to
CursorMode'Reset
- Depends: now
- Inhibits: never
mousePressed :: (Monoid e, MonadMouse mb m) => mb -> Wire s e m a a Source
Behaves like the identity wire when the mouse button is pressed and inhibits otherwise
- Inhibits: when the mouse button is not pressed
mouseDebounced :: (Monoid e, MonadMouse mb m) => mb -> Wire s e m a a Source
Behaves like the identity wire for a signle instant when the mouse button is pressed and otherwise inhibits
- Depends: the instant at which the mouse button is pressed
- Inhibits: when the mouse button is not pressed or after it has been pressed
mouseScroll :: (Monoid e, MonadMouse mb m) => Wire s e m a (Double, Double) Source
The mouse scroll is the offset from zero at each time instant.
- Depends: now
- Inhibits: never
mouseScrolled :: (Monoid e, MonadMouse mb m) => Wire s e m a (Double, Double) Source
The amount that the mouse has scrolled over the course of the entire wire.
- Depends: now
- Inhibits: never
cursorMode :: (MonadMouse mb m, Monoid e) => CursorMode -> Wire s e m a a Source
Behaves like the identity wire, and inhibits immediately after
setting the cursor mode. Common uses of this wire are to switch it
to the identity wire:
cursorMode CursorMode'Disabled --> mkId
- Inhibits: after now
Keyboard input
Key typeclass. This is used to constrain the type of Monad used | to provide keyboard input.
class (Key k, Monad m) => MonadKeyboard k m | m -> k where Source
This monad describes computations that involve keyboard input.
Methods
keyIsPressed :: k -> m Bool Source
Returns true if the given key is currently pressed
releaseKey :: k -> m () Source
Resets the pressed state of the given key.
Keyboard input wires
keyPressed :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a Source
Behaves like the identity wire when the key is pressed and inhibits otherwise
- Inhibits: when the key is not pressed
keyNotPressed :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a Source
Behaves like the identity wire when the key is not pressed and inhibits otherwise
- Inhibits: when the key is pressed
keyDebounced :: (Monoid e, MonadKeyboard k m) => k -> Wire s e m a a Source
Behaves like the identity wire for a signle instant when the key is pressed and otherwise inhibits
- Inhibits: when the key is not pressed or after it has been pressed