Portability	GHC with TypeFamilies and more
Stability	unstable
Maintainer	Stephen Tetley <stephen.tetley@gmail.com>

Wumpus.Core

Description

Common interface to Wumpus.Core.

This module re-exports types and functions from:

Named colours ( black, white etc.) are hidden from Wumpus.Core.Colour to avoid collisions with modules that define colour sets (e.g. all the SVG colours).

Some data types are exported from Wumpus.Core.PictureInternal but are made opaque.

Synopsis

Documentation

module Wumpus.Core.AffineTrans

module Wumpus.Core.BoundingBox

module Wumpus.Core.Colour

module Wumpus.Core.FontSize

module Wumpus.Core.Geometry

module Wumpus.Core.GraphicsState

module Wumpus.Core.OutputPostScript

module Wumpus.Core.OutputSVG

module Wumpus.Core.Picture

module Wumpus.Core.PictureLanguage

module Wumpus.Core.TextEncoder

wumpus_core_version :: (Int, Int, Int)Source

data Picture u Source

Picture is a leaf attributed tree - where atttibutes are colour, line-width etc. It is parametric on the unit type of points (typically Double).

Wumpus's leaf attributed tree, is not directly matched to PostScript's picture representation, which might be considered a node attributed tree (if you consider graphics state changes less imperatively - setting attributes rather than global state change).

Considered as a node-attributed tree PostScript precolates graphics state updates downwards in the tree (vis-a-vis inherited attributes in an attibute grammar), where a graphics state change deeper in the tree overrides a higher one.

Wumpus on the other hand, simply labels each leaf with its drawing attributes - there is no attribute inheritance. When it draws the PostScript picture it does some optimization to avoid generating excessive graphics state changes in the PostScript code.

Apropos the constructors, Picture is a simple non-empty leaf-labelled rose tree via:

 Single (aka leaf) | Picture (OneList tree)

Where OneList is a variant of the standard list type that disallows empty lists.

The additional constructors are convenience:

PickBlank has a bounding box but no content and is useful for some picture language operations (e.g. hsep).

Clip nests a picture (tree) inside a clipping path.

Instances

Eq u => Eq (Picture u)
Show u => Show (Picture u)
(Num u, Pretty u) => Pretty (Picture u)
(Num u, Ord u, Horizontal (Picture u), Vertical (Picture u)) => Move (Picture u)
(Num u, Ord u) => Vertical (Picture u)
(Num u, Ord u) => Horizontal (Picture u)
(Num u, Ord u) => Blank (Picture u)
(Num u, Ord u) => Composite (Picture u)
(Num u, Ord u) => Translate (Picture u)
(Num u, Ord u) => Scale (Picture u)
(Floating u, Real u) => RotateAbout (Picture u)
(Floating u, Real u) => Rotate (Picture u)
Boundary (Picture u)

type DPicture = Picture Double Source

data Primitive u Source

Wumpus's drawings are built from two fundamental primitives: paths (line segments and Bezier curves) and labels (single lines of text).

Ellipses are a included as a primitive only for optimization - drawing a reasonable circle with Bezier curves needs at least eight curves. This is inconvenient for drawing dots which can otherwise be drawn with a single arc command.

Wumpus does not follow PostScript and employ arcs as general path primitives - they are used only to draw ellipses. This is because arcs do not enjoy the nice properties of Bezier curves, whereby the affine transformation of a Bezier curve can simply be achieved by the affine transformation of it's control points.

Ellipses are represented by their center, half-width and half-height. Half-width and half-height are used so the bounding box can be calculated using only multiplication, and thus initially only obliging a Num constraint on the unit. Though typically for affine transformations a Fractional constraint is also obliged.

Instances

Eq u => Eq (Primitive u)
Show u => Show (Primitive u)
Pretty u => Pretty (Primitive u)
(Fractional u, Ord u) => Boundary (Primitive u)

type DPrimitive = Primitive Double Source

data Path u Source

Instances

Eq u => Eq (Path u)
Show u => Show (Path u)
Semigroup (Path u)	Paths are sensibly a Semigroup - there is no notion of empty path.
Pretty u => Pretty (Path u)
Pointwise (Path u)
(Num u, Ord u) => Boundary (Path u)

type DPath = Path Double Source

data PathSegment u Source

Instances

Eq u => Eq (PathSegment u)
Show u => Show (PathSegment u)
Pretty u => Pretty (PathSegment u)
Pointwise (PathSegment u)

type DPathSegment = PathSegment Double Source

data Label u Source

Instances

Eq u => Eq (Label u)
Show u => Show (Label u)
Pretty u => Pretty (Label u)

type DLabel = Label Double Source

type PathProps = (PSRgb, DrawPath)Source

type LabelProps = (PSRgb, FontAttr)Source

type EllipseProps = (PSRgb, DrawEllipse)Source

data DrawPath Source

Note when drawn filled and drawn stroked the same polygon will have (slightly) different size:

A filled shape fills within the boundary of the shape
A stroked shape draws a pen line around the boundary of the shape. The actual size depends on the thickness of the line (stroke width).

Instances

Eq DrawPath
Show DrawPath

data DrawEllipse Source

Ellipses and circles are always closed.

Instances

Eq DrawEllipse
Show DrawEllipse
Ellipse DrawEllipse
Ellipse (Gray Double, DrawEllipse)
Ellipse (HSB3 Double, DrawEllipse)
Ellipse (RGB3 Double, DrawEllipse)