Scope.Types

Scope types and interfaces

The coordinate system:

           CanvasX 0.0                       CanvasX 1.0    DataX 1.0
              |                                 |              |
 DataX 0.0    V                                 V              V
    |
    V          ---------------------------------   <- CanvasY -1.0
              |                                 |
    +---------+---------------------------------+--------------+
    |         |                                 |              |
    |         |                                 |              |
    +---------+---------------------------------+--------------+
              |                                 |
               ---------------------------------   <- CanvasY -1.0

Coordinates

class Coordinate a where

Methods

fromDouble :: Double -> a

toDouble :: a -> Double

distance :: a -> a -> a

Distance from to

translate :: a -> a -> a

Translate x by

transform :: Transform a -> a -> a

Instances

Coordinate Double

Coordinate UTCTime

Coordinate TimeStamp

Coordinate DataX

Coordinate CanvasX

Coordinate ScreenX

newtype ScreenX

Constructors

ScreenX Double

Instances

Eq ScreenX

Ord ScreenX

Show ScreenX

Coordinate ScreenX

newtype ScreenY

Constructors

ScreenY Double

Instances

Eq ScreenY

Ord ScreenY

Show ScreenY

newtype CanvasX

Constructors

CanvasX Double

Instances

Eq CanvasX

Ord CanvasX

Show CanvasX

Coordinate CanvasX

newtype CanvasY

Constructors

CanvasY Double

Instances

Eq CanvasY

Ord CanvasY

Show CanvasY

newtype DataX

Constructors

DataX Double

Instances

Eq DataX

Ord DataX

Show DataX

Coordinate DataX

newtype DataY

Constructors

DataY Double

Instances

Eq DataY

Ord DataY

Show DataY

data Transform a

Constructors

Transform

Fields

m :: Double

b :: a

mkTransform :: Coordinate a => (a, a) -> (a, a) -> Transform a

mkTSDataTransform :: (TimeStamp, TimeStamp) -> (TimeStamp, TimeStamp) -> Transform DataX

unionBounds :: Ord a => Maybe (a, a) -> Maybe (a, a) -> Maybe (a, a)

translateRange :: Coordinate a => a -> (a, a) -> (a, a)

unionRange :: Ord a => (a, a) -> (a, a) -> (a, a)

restrictRange :: (Ord a, Coordinate a) => (a, a) -> (a, a) -> (a, a)

Restrict a window to within a given range

restrictRange01 :: (Ord a, Coordinate a) => (a, a) -> (a, a)

zoomRange :: Coordinate a => CanvasX -> Double -> (a, a) -> (a, a)

Drawing commands

type RGB = (Double, Double, Double)

data DrawCmd

Constructors

SetRGB Double Double Double

SetRGBA Double Double Double Double

MoveTo (Double, Double)

LineTo (Double, Double)

FillPoly [(Double, Double)]

type DrawLayer = [DrawCmd]

class (Functor m, MonadCatchIO m) => ScopeRender m where

Methods

renderCmds :: [DrawCmd] -> m ()

Instances

ScopeRender IO

ScopeRender Render

class ScopePlot a where

Methods

rawLayerPlot :: a -> RGB -> LayerPlot (TimeStamp, [a])

summaryLayerPlot :: a -> RGB -> LayerPlot [Summary a]

Instances

ScopePlot Double

Scope

data ScopeFile

Constructors

ScopeFile

Fields

filename :: FilePath

fd :: Fd

scopeCF :: CacheFile

data Scope ui

Constructors

Scope

Fields

view :: View ui

bounds :: Maybe (TimeStamp, TimeStamp)

utcBounds :: Maybe (UTCTime, UTCTime)

layers :: [ScopeLayer]

scopeNew :: ui -> Scope ui

scopeUpdate :: Maybe (TimeStamp, TimeStamp) -> Maybe (UTCTime, UTCTime) -> Scope ui -> Scope ui

scopeModifyView :: (View ui -> View ui) -> Scope ui -> Scope ui

Views

data View ui

Constructors

View

Fields

viewX1 :: DataX

viewY1 :: Double

viewX2 :: DataX

viewY2 :: Double

pointerX :: Maybe CanvasX

dragDX :: Maybe DataX

viewUI :: ui

Layers

data Layer a

Constructors

Layer

Fields

layerFile :: ScopeFile

layerTrackNo :: TrackNo

layerBaseUTC :: Maybe UTCTime

startTime :: TimeStamp

endTime :: TimeStamp

convEnee :: forall m. (Functor m, Monad m) => Enumeratee [Block] [a] m ()

plotter :: LayerPlot a

data LayerPlot a

Constructors

LayerMap (LayerMapFunc a) [DrawLayer]

forall b . LayerFold (LayerFoldFunc a b) [DrawLayer] b

type LayerMapFunc a = Double -> Double -> a -> [DrawLayer]

A layer plotting function which is just given the x position and x width to render the data value of type a into.

type LayerFoldFunc a b = Double -> Double -> b -> a -> ([DrawLayer], b)

A layer plotting function which is given the x position and x width, and a previously returned value of type b

data ScopeLayer

Constructors

forall a . Timestampable a => ScopeLayer (Layer a)