Many Wumpus objects are usefully constructed in the do-notation, but because Wumpus has to expose the type of the unit to the type checker we must finish the do-block with:

 ureturn

or:

 return UNil

rather than:

 return ()

uvoid :: Monad m => m a -> m (UNil u)Source

uvoid runs a monadic computation and returns UNil.

Non-contextual unit conversion.

class ScalarUnit a whereSource

Methods

fromPsPoint :: Double -> aSource

toPsPoint :: a -> Double Source

Instances

ScalarUnit Double
ScalarUnit Pica
ScalarUnit Centimeter

Unit interpretation with respect to the current Point size

class (Eq u, Num u) => InterpretUnit u whereSource

Methods

normalize :: FontSize -> u -> Double Source

dinterp :: FontSize -> Double -> uSource

Instances

InterpretUnit Double
InterpretUnit AfmUnit
InterpretUnit En
InterpretUnit Em
InterpretUnit Pica
InterpretUnit Centimeter

dinterpF :: (Functor t, InterpretUnit u) => FontSize -> t Double -> t uSource

dinterp an object that gives access to its unit at the functor position.

normalizeF :: (Functor t, InterpretUnit u) => FontSize -> t u -> t Double Source

normalize an object that gives access to its unit at the functor position.

uconvert1 :: (InterpretUnit u, InterpretUnit u1) => FontSize -> u -> u1Source

Convert a scalar value from one unit to another.

uconvertF :: (Functor t, InterpretUnit u, InterpretUnit u1) => FontSize -> t u -> t u1Source

Unit convert an object that gives access to its unit at the Functor position.

In practive this will be *all* Image answers.

intraMapPoint :: InterpretUnit u => FontSize -> (DPoint2 -> DPoint2) -> Point2 u -> Point2 uSource

intraMapFunctor :: (Functor f, InterpretUnit u) => FontSize -> (f Double -> f Double) -> f u -> f uSource

KernChar

type KernChar u = (u, EscapedChar)Source

Unit parametric version of KerningChar from Wumpus-Core.

Drawing paths and shapes (closed paths)

data PathMode Source

Draw closed paths.

 OSTROKE - open and stroked

 CSTROKE - closed and stroke

 CFILL - closed and filled

 CFILL_STROKE - closed, the path is filled, its edge is stroked.

Constructors

OSTROKE
CSTROKE
CFILL
CFILL_STROKE

Instances

Bounded PathMode
Enum PathMode
Eq PathMode
Ord PathMode
Show PathMode

data DrawMode Source

Draw closed paths and shapes.

 DRAW_STROKE - closed and stroked

 DRAW_FILL - closed and filled

 DRAW_FILL_STROKE - the path is filled, its edge is stroked.

Constructors

DRAW_STROKE
DRAW_FILL
DRAW_FILL_STROKE

Instances

Bounded DrawMode
Enum DrawMode
Eq DrawMode
Ord DrawMode
Show DrawMode

closedMode :: DrawMode -> PathMode Source

Interpret a DrawMode for a closed path.

Drawing layers

data ZOrder Source

Enumerated type for drawing with respect to the z-order.

Constructors

ZBELOW
ZABOVE

Instances

Bounded ZOrder
Enum ZOrder
Eq ZOrder
Ord ZOrder
Show ZOrder

Alignment

data HAlign Source

Horizontal alignment - align to the top, center or bottom.

Constructors

HALIGN_TOP
HALIGN_CENTER
HALIGN_BASE

Instances

Enum HAlign
Eq HAlign
Ord HAlign
Show HAlign

data VAlign Source

Vertical alignment - align to the left, center or bottom.

Constructors

VALIGN_LEFT
VALIGN_CENTER
VALIGN_RIGHT

Instances

Enum VAlign
Eq VAlign
Ord VAlign
Show VAlign

Text height

data TextHeight Source

Wumpus distinguishes two use-cases for displaying vertically centered text.

Arbitrary text that is expected to contain lower case letters with descenders, show take the vertical center as the mid-point between the cap height and the descender depth.

Unfortunately, including the descender depth can produce unbalanced results for text which is not expected to have descenders (e.g. numbers within a bordered box), visually this makes the center too high.

Constructors

JUST_CAP_HEIGHT
CAP_HEIGHT_PLUS_DESCENDER

Instances

Enum TextHeight
Eq TextHeight
Ord TextHeight
Show TextHeight

Cardinal (compass) positions

data Cardinal Source

An enumeratied type representing the compass positions.

Constructors

NORTH
NORTH_EAST
EAST
SOUTH_EAST
SOUTH
SOUTH_WEST
WEST
NORTH_WEST

Instances

Enum Cardinal
Eq Cardinal
Ord Cardinal
Show Cardinal

Direction enumeration

data Direction Source

An enumerated type representing horizontal and vertical directions.

Constructors

UP
DOWN
LEFT
RIGHT

Instances

Enum Direction
Eq Direction
Ord Direction
Show Direction

data ClockDirection Source

An enumerated type representing clock directions.

Constructors

CW
CCW

Instances

Enum ClockDirection
Eq ClockDirection
Ord ClockDirection
Show ClockDirection

clockDirection :: (Real u, Floating u) => Vec2 u -> Vec2 u -> ClockDirection Source

Note - behaviour at the continuity (0 deg, 180 deg, ...) is unspecified.

data HDirection Source

An enumerated type representing horizontal direction.

Constructors

LEFTWARDS
RIGHTWARDS

Instances

Enum HDirection
Eq HDirection
Ord HDirection
Show HDirection

horizontalDirection :: Radian -> HDirection Source

data VDirection Source

An enumerated type representing vertical direction.

Constructors

UPWARDS
DOWNWARDS

Instances

Enum VDirection
Eq VDirection
Ord VDirection
Show VDirection

verticalDirection :: Radian -> VDirection Source

Quadrant enumeration

data Quadrant Source

An enumerated type representing quadrants.

Constructors

QUAD_NE
QUAD_NW
QUAD_SW
QUAD_SE

Instances

Enum Quadrant
Eq Quadrant
Ord Quadrant
Show Quadrant

quadrant :: Radian -> Quadrant Source

quadrant : ang -> Quadrant

Get the quadrant of an angle.

Beziers

bezierArcPoints :: Floating u => Radian -> u -> Radian -> Point2 u -> [Point2 u]Source

bezierArcPoints : apex_angle * radius * inclination * center -> [Point]

 ang should be in the range 0 < ang < 360deg.

 if   0 < ang <=  90 returns 4 points
 if  90 < ang <= 180 returns 7 points
 if 180 < ang <= 270 returns 10 points
 if 270 < ang <  360 returns 13 points

bezierMinorArc :: Floating u => Radian -> u -> Radian -> Point2 u -> (Point2 u, Point2 u, Point2 u, Point2 u)Source

bezierMinorArc : apex_angle * radius * rotation * center -> BezierCurve

 ang should be in the range 0 < ang <= 90deg.

Misc

both :: Applicative f => f a -> f b -> f (a, b)Source

Applicative both - run both computations return the pair of the the answers.

monPreRepeatPost :: Monoid a => a -> (Int, a) -> a -> aSource

Monodial scheme - prefix, repeat body n times, suffix.