FRP.Rhine.Clock.Select

In the Rhine philosophy, _event sources are clocks_. Often, we want to extract certain subevents from event sources, e.g. single out only left mouse button clicks from all input device events. This module provides a general purpose selection clock that ticks only on certain subevents.

Documentation

data SelectClock cl a

A clock that selects certain subevents of type a, from the tag of a main clock.

If two SelectClocks would tick on the same type of subevents, but should not have the same type, one should newtype the subevent.

Constructors

SelectClock

Fields

• mainClock :: cl

  The main clock | Return Nothing if no tick of the subclock is required, or 'Just a' if the subclock should tick, with tag a.

• select :: Tag cl -> Maybe a

Instances

(Monad m, Clock m cl) => Clock m (SelectClock cl a)

Defined in FRP.Rhine.Clock.Select

Associated Types

type Time (SelectClock cl a)

type Tag (SelectClock cl a)

Methods

initClock :: SelectClock cl a -> RunningClockInit m (Time (SelectClock cl a)) (Tag (SelectClock cl a))

(Monoid cl, Semigroup a) => Monoid (SelectClock cl a)

Defined in FRP.Rhine.Clock.Select

Methods

mempty :: SelectClock cl a

mappend :: SelectClock cl a -> SelectClock cl a -> SelectClock cl a

mconcat :: [SelectClock cl a] -> SelectClock cl a

(Semigroup a, Semigroup cl) => Semigroup (SelectClock cl a)

Defined in FRP.Rhine.Clock.Select

Methods

(<>) :: SelectClock cl a -> SelectClock cl a -> SelectClock cl a

sconcat :: NonEmpty (SelectClock cl a) -> SelectClock cl a

stimes :: Integral b => b -> SelectClock cl a -> SelectClock cl a

GetClockProxy (SelectClock cl a)

Defined in FRP.Rhine.Clock.Select

Methods

getClockProxy :: ClockProxy (SelectClock cl a)

type Tag (SelectClock cl a)

Defined in FRP.Rhine.Clock.Select

type Tag (SelectClock cl a) = a

type Time (SelectClock cl a)

Defined in FRP.Rhine.Clock.Select

type Time (SelectClock cl a) = Time cl

schedSelectClocks :: (Monad m, Semigroup cl, Clock m cl) => Schedule m (SelectClock cl a) (SelectClock cl b)

A universal schedule for two subclocks of the same main clock. The main clock must be a Semigroup (e.g. a singleton).

schedSelectClockAndMain :: (Monad m, Semigroup cl, Clock m cl) => Schedule m cl (SelectClock cl a)

A universal schedule for a subclock and its main clock.

filterS :: Monad m => MSF m () (Maybe b) -> MSF m () b

Helper function that runs an MSF with Maybe output until it returns a value.