Wumpus.Basic.Graphic.GraphicTypes

Refined instances of of the Drawing type modelling specific graphic types.

** WARNING ** - some names are expected to change.

Function from Point to Point

type PointDisplace u = Point2 u -> Point2 u

Advance vector

type AdvanceVec u = Vec2 u

Drawing info

type DrawingInfo a = CF a

A query on the DrawingContext.

Alias for CF.

type LocDrawingInfo u a = LocCF u a

A query on the DrawingContext respective to the supplied point.

Alias for LocCF.

type LocThetaDrawingInfo u a = LocThetaCF u a

A query on the DrawingContext respective to the supplied point and angle.

Alias for LocCF.

Graphic

type Graphic u = CF (PrimGraphic u)

Simple drawing - produce a primitive, access the DrawingContext if required.

type LocGraphic u = LocCF u (PrimGraphic u)

Commonly graphics take a start point as well as a drawing context.

Here they are called a LocGraphic - graphic with a (starting) location.

type LocThetaGraphic u = LocThetaCF u (PrimGraphic u)

A function from point * angle -> graphic

type ConnectorGraphic u = ConnectorCF u (PrimGraphic u)

ConnectorGraphic is a connector drawn between two points contructing a Graphic.

type DGraphic = Graphic Double

type DLocGraphic = LocGraphic Double

type DLocThetaGraphic = LocThetaGraphic Double

type DConnectorGraphic = ConnectorGraphic Double

Image

type Image u a = CF (a, PrimGraphic u)

Images return a value as well as drawing. A node is a typical example - nodes are drawing but the also support taking anchor points.

type LocImage u a = LocCF u (a, PrimGraphic u)

type LocThetaImage u a = LocThetaCF u (a, PrimGraphic u)

type ConnectorImage u a = ConnectorCF u (a, PrimGraphic u)

ConnectorImage is a connector drawn between two points constructing an Image.

Usually the answer type of a ConnectorImage will be a Path so the Points ar midway, atstart etc. can be taken on it.

type DImage a = Image Double a

type DLocImage a = LocImage Double a

type DLocThetaImage a = LocThetaImage Double a

type DConnectorImage a = ConnectorImage Double a

Advance vector graphic

type AdvGraphic u = LocImage u (Point2 u)

Advance vector graphic - this partially models the PostScript show command which moves the current point by the width (advance) vector as each character is drawn.

type DAdvGraphic = AdvGraphic Double

Bounded graphic / loc graphic

type BoundedGraphic u = Image u (BoundingBox u)

Graphic with a bounding box.

type DBoundedGraphic = BoundedGraphic Double

type BoundedLocGraphic u = LocImage u (BoundingBox u)

LocGraphic with a bounding box.

type DBoundedLocGraphic = BoundedLocGraphic Double

Extract from an Advance vector

advanceH :: Num u => AdvanceVec u -> u

Extract the horizontal component of an advance vector.

For left-to-right latin text, the vertical component of an advance vector is expected to be 0. Ingoring it seems permissible, e.g. when calculating bounding boxes for left-to-right text.

advanceV :: Num u => AdvanceVec u -> u

Extract the verticaltal component of an advance vector.

For left-to-right latin text, the vertical component of an advance vector is expected to be 0.

Run functions

runGraphic :: DrawingContext -> Graphic u -> PrimGraphic u

runLocGraphic :: DrawingContext -> Point2 u -> LocGraphic u -> PrimGraphic u

runImage :: DrawingContext -> Image u a -> (a, PrimGraphic u)

runLocImage :: DrawingContext -> Point2 u -> LocImage u a -> (a, PrimGraphic u)

Combinators

moveLoc :: (Point2 u -> Point2 u) -> LocCF u a -> LocCF u a

at :: CF (Point2 u -> b) -> Point2 u -> CF b

Dropping answers

extrGraphic :: Image u a -> Graphic u

extrLocGraphic :: LocImage u a -> LocGraphic u

fontDeltaGraphic :: Graphic u -> Graphic u

fontDeltaImage :: Image u a -> Image u a

xlinkGraphic :: XLink -> Graphic u -> Graphic u

xlinkImage :: XLink -> Image u a -> Image u a

intoImage :: CF a -> Graphic u -> Image u a

intoLocImage :: LocCF u a -> LocGraphic u -> LocImage u a

intoConnectorImage :: ConnectorCF u a -> ConnectorGraphic u -> ConnectorImage u a

intoLocThetaImage :: LocThetaCF u a -> LocThetaGraphic u -> LocThetaImage u a

makeAdvGraphic :: PointDisplace u -> LocGraphic u -> AdvGraphic u

Construction is different to intoZZ functions hence the different name.