Data.Geometry.Ipe.Types

Documentation

newtype LayerName

Constructors

LayerName

Fields

_layerName :: Text

Instances

Eq LayerName

Ord LayerName

Read LayerName

Show LayerName

IsString LayerName

IpeWrite LayerName

IpeWriteText LayerName

IpeRead LayerName

IpeReadText LayerName

data Image r

Image Objects

Constructors

Image

Fields

_imageData :: ()

_rect :: Rectangle () r

Instances

ToObject Image

Eq r => Eq (Image r)

Ord r => Ord (Image r)

Show r => Show (Image r)

Num r => IsTransformable (Image r)

IpeWriteText r => IpeWrite (Image r)

Coordinate r => IpeRead (Image r)

type NumType (Image r) = r

type Dimension (Image r) = 2

rect :: forall r r. Lens (Image r) (Image r) (Rectangle () r) (Rectangle () r)

imageData :: forall r. Lens' (Image r) ()

data TextLabel r

Text Objects

Constructors

Label Text (Point 2 r)

Instances

ToObject TextLabel

Eq r => Eq (TextLabel r)

Ord r => Ord (TextLabel r)

Show r => Show (TextLabel r)

Num r => IsTransformable (TextLabel r)

IpeWriteText r => IpeWrite (TextLabel r)

Coordinate r => IpeRead (TextLabel r)

type NumType (TextLabel r) = r

type Dimension (TextLabel r) = 2

data MiniPage r

Constructors

MiniPage Text (Point 2 r) r

Instances

ToObject MiniPage

Eq r => Eq (MiniPage r)

Ord r => Ord (MiniPage r)

Show r => Show (MiniPage r)

Num r => IsTransformable (MiniPage r)

IpeWriteText r => IpeWrite (MiniPage r)

Coordinate r => IpeRead (MiniPage r)

type NumType (MiniPage r) = r

type Dimension (MiniPage r) = 2

width :: MiniPage t -> t

data IpeSymbol r

Ipe Symbols, i.e. Points

A symbol (point) in ipe

Constructors

Symbol

Fields

_symbolPoint :: Point 2 r

_symbolName :: Text

Instances

ToObject IpeSymbol

Eq r => Eq (IpeSymbol r)

Ord r => Ord (IpeSymbol r)

Show r => Show (IpeSymbol r)

Num r => IsTransformable (IpeSymbol r)

IpeWriteText r => IpeWrite (IpeSymbol r)

Coordinate r => IpeRead (IpeSymbol r)

Ipe read instances

type NumType (IpeSymbol r) = r

type Dimension (IpeSymbol r) = 2

symbolPoint :: forall r r. Lens (IpeSymbol r) (IpeSymbol r) (Point 2 r) (Point 2 r)

symbolName :: forall r. Lens' (IpeSymbol r) Text

data PathSegment r

Example of an IpeSymbol. I.e. A symbol that expresses that the size is large sizeSymbol :: Attributes (AttrMapSym1 r) (SymbolAttributes r) sizeSymbol = attr SSize (IpeSize $ Named "large")

Paths

Paths consist of Path Segments. PathSegments come in the following forms:

Constructors

PolyLineSegment (PolyLine 2 () r)

PolygonPath (SimplePolygon () r)

CubicBezierSegment

QuadraticBezierSegment

EllipseSegment (Matrix 3 3 r)

ArcSegment

SplineSegment

ClosedSplineSegment

Instances

Eq r => Eq (PathSegment r)

Show r => Show (PathSegment r)

Num r => IsTransformable (PathSegment r)

IpeWriteText r => IpeWriteText (PathSegment r)

Coordinate r => IpeRead (PathSegment r)

Coordinate r => IpeReadText (NonEmpty (PathSegment r))

type NumType (PathSegment r) = r

type Dimension (PathSegment r) = 2

_ClosedSplineSegment :: forall r. Prism' (PathSegment r) ()

_SplineSegment :: forall r. Prism' (PathSegment r) ()

_ArcSegment :: forall r. Prism' (PathSegment r) ()

_EllipseSegment :: forall r. Prism' (PathSegment r) (Matrix 3 3 r)

_QuadraticBezierSegment :: forall r. Prism' (PathSegment r) ()

_CubicBezierSegment :: forall r. Prism' (PathSegment r) ()

_PolygonPath :: forall r. Prism' (PathSegment r) (SimplePolygon () r)

_PolyLineSegment :: forall r. Prism' (PathSegment r) (PolyLine 2 () r)

newtype Path r

A path is a non-empty sequence of PathSegments.

Constructors

Path

Fields

_pathSegments :: ViewL1 (PathSegment r)

Instances

ToObject Path

Eq r => Eq (Path r)

Show r => Show (Path r)

Num r => IsTransformable (Path r)

IpeWriteText r => IpeWrite (Path r)

IpeWriteText r => IpeWriteText (Path r)

Coordinate r => IpeRead (Path r)

Coordinate r => IpeReadText (Path r)

type NumType (Path r) = r

type Dimension (Path r) = 2

pathSegments :: forall r r. Iso (Path r) (Path r) (ViewL1 (PathSegment r)) (ViewL1 (PathSegment r))

data Operation r

type that represents a path in ipe.

Constructors

MoveTo (Point 2 r)

LineTo (Point 2 r)

CurveTo (Point 2 r) (Point 2 r) (Point 2 r)

QCurveTo (Point 2 r) (Point 2 r)

Ellipse (Matrix 3 3 r)

ArcTo (Matrix 3 3 r) (Point 2 r)

Spline [Point 2 r]

ClosedSpline [Point 2 r]

ClosePath

Instances

Eq r => Eq (Operation r)

Show r => Show (Operation r)

IpeWriteText r => IpeWriteText (Operation r)

Coordinate r => IpeReadText [Operation r]

_ClosePath :: forall r. Prism' (Operation r) ()

_ClosedSpline :: forall r. Prism' (Operation r) [Point 2 r]

_Spline :: forall r. Prism' (Operation r) [Point 2 r]

_ArcTo :: forall r. Prism' (Operation r) (Matrix 3 3 r, Point 2 r)

_Ellipse :: forall r. Prism' (Operation r) (Matrix 3 3 r)

_QCurveTo :: forall r. Prism' (Operation r) (Point 2 r, Point 2 r)

_CurveTo :: forall r. Prism' (Operation r) (Point 2 r, Point 2 r, Point 2 r)

_LineTo :: forall r. Prism' (Operation r) (Point 2 r)

_MoveTo :: forall r. Prism' (Operation r) (Point 2 r)

Attribute Mapping

type family AttrMap r l :: *

The mapping between the labels of the the attributes and the types of the attributes with these labels. For example, the Matrix label/attribute should have a value of type 'Matrix 3 3 r'.

Equations

AttrMap r Layer = LayerName

AttrMap r Matrix = Matrix 3 3 r

AttrMap r Pin = PinType

AttrMap r Transformations = TransformationTypes

AttrMap r Stroke = IpeColor

AttrMap r Pen = IpePen r

AttrMap r Fill = IpeColor

AttrMap r Size = IpeSize r

AttrMap r Dash = IpeDash r

AttrMap r LineCap = Int

AttrMap r LineJoin = Int

AttrMap r FillRule = FillType

AttrMap r Arrow = IpeArrow r

AttrMap r RArrow = IpeArrow r

AttrMap r Opacity = IpeOpacity

AttrMap r Tiling = IpeTiling

AttrMap r Gradient = IpeGradient

AttrMap r Clip = Path r

type AttrMapSym2 t t = AttrMap t t

data AttrMapSym1 l l

Constructors

forall arg . (KindOf (Apply (AttrMapSym1 l) arg) ~ KindOf (AttrMapSym2 l arg)) => AttrMapSym1KindInference

Instances

SuppressUnusedWarnings (* -> TyFun AttributeUniverse * -> *) AttrMapSym1

type Apply * AttributeUniverse (AttrMapSym1 l1) l0 = AttrMapSym2 l1 l0

data AttrMapSym0 l

Constructors

forall arg . (KindOf (Apply AttrMapSym0 arg) ~ KindOf (AttrMapSym1 arg)) => AttrMapSym0KindInference

Instances

SuppressUnusedWarnings (TyFun * (TyFun AttributeUniverse * -> *) -> *) AttrMapSym0

type Apply (TyFun AttributeUniverse * -> *) * AttrMapSym0 l0 = AttrMapSym1 l0

newtype Group r

Groups and Objects

Group Attributes

A group is essentially a list of IpeObjects.

Constructors

Group

Fields

_groupItems :: [IpeObject r]

Instances

ToObject Group

Eq r => Eq (Group r)

Show r => Show (Group r)

Num r => IsTransformable (Group r)

IpeWriteText r => IpeWrite (Group r)

Coordinate r => IpeRead (Group r)

type NumType (Group r) = r

type Dimension (Group r) = 2

type family AttributesOf t :: [u]

Equations

AttributesOf Group = GroupAttributes

AttributesOf Image = CommonAttributes

AttributesOf TextLabel = CommonAttributes

AttributesOf MiniPage = CommonAttributes

AttributesOf IpeSymbol = SymbolAttributes

AttributesOf Path = PathAttributes

type Attributes' r = Attributes (AttrMapSym1 r)

Attributes' :: * -> [AttributeUniverse] -> *

type IpeAttributes g r = Attributes' r (AttributesOf g)

type IpeObject' g r = g r :+ IpeAttributes g r

An IpeObject' is essentially the oject ogether with its attributes

attributes :: Lens' (IpeObject' g r) (IpeAttributes g r)

data IpeObject r

Constructors

IpeGroup (IpeObject' Group r)

IpeImage (IpeObject' Image r)

IpeTextLabel (IpeObject' TextLabel r)

IpeMiniPage (IpeObject' MiniPage r)

IpeUse (IpeObject' IpeSymbol r)

IpePath (IpeObject' Path r)

Instances

Eq r => Eq (IpeObject r)

Show r => Show (IpeObject r)

Num r => IsTransformable (IpeObject r)

IpeWriteText r => IpeWrite (IpeObject r)

Coordinate r => IpeRead (IpeObject r)

type NumType (IpeObject r) = r

type Dimension (IpeObject r) = 2

_IpePath :: forall r. Prism' (IpeObject r) (IpeObject' Path r)

_IpeUse :: forall r. Prism' (IpeObject r) (IpeObject' IpeSymbol r)

_IpeMiniPage :: forall r. Prism' (IpeObject r) (IpeObject' MiniPage r)

_IpeTextLabel :: forall r. Prism' (IpeObject r) (IpeObject' TextLabel r)

_IpeImage :: forall r. Prism' (IpeObject r) (IpeObject' Image r)

_IpeGroup :: forall r. Prism' (IpeObject r) (IpeObject' Group r)

groupItems :: forall r r. Iso (Group r) (Group r) [IpeObject r] [IpeObject r]

class ToObject i where

Methods

ipeObject' :: i r -> IpeAttributes i r -> IpeObject r

Instances

ToObject Image

ToObject IpeSymbol

ToObject MiniPage

ToObject TextLabel

ToObject Path

ToObject Group

commonAttributes :: Lens' (IpeObject r) (Attributes (AttrMapSym1 r) CommonAttributes)

data View

The definition of a view make active layer into an index ?

Constructors

View

Fields

_layerNames :: [LayerName]

_activeLayer :: LayerName

Instances

Eq View

Ord View

Show View

IpeWrite View

IpeRead View

layerNames :: Lens' View [LayerName]

activeLayer :: Lens' View LayerName

data IpeStyle

for now we pretty much ignore these

Constructors

IpeStyle

Fields

_styleName :: Maybe Text

_styleData :: Node Text Text

Instances

Eq IpeStyle

Show IpeStyle

IpeWrite IpeStyle

styleName :: Lens' IpeStyle (Maybe Text)

styleData :: Lens' IpeStyle (Node Text Text)

basicIpeStyle :: IpeStyle

data IpePreamble

The maybe string is the encoding

Constructors

IpePreamble

Fields

_encoding :: Maybe Text

_preambleData :: Text

Instances

Eq IpePreamble

Ord IpePreamble

Read IpePreamble

Show IpePreamble

IpeWrite IpePreamble

preambleData :: Lens' IpePreamble Text

encoding :: Lens' IpePreamble (Maybe Text)

type IpeBitmap = Text

data IpePage r

An IpePage is essentially a Group, together with a list of layers and a list of views.

Constructors

IpePage

Fields

_layers :: [LayerName]

_views :: [View]

_content :: [IpeObject r]

Instances

Eq r => Eq (IpePage r)

Show r => Show (IpePage r)

IpeWriteText r => IpeWrite (IpePage r)

Coordinate r => IpeRead (IpePage r)

views :: forall r. Lens' (IpePage r) [View]

layers :: forall r. Lens' (IpePage r) [LayerName]

content :: forall r r. Lens (IpePage r) (IpePage r) [IpeObject r] [IpeObject r]

fromContent :: [IpeObject r] -> IpePage r

Creates a simple page with no views.

data IpeFile r

A complete ipe file

Constructors

IpeFile

Fields

_preamble :: Maybe IpePreamble

_styles :: [IpeStyle]

_pages :: NonEmpty (IpePage r)

Instances

Eq r => Eq (IpeFile r)

Show r => Show (IpeFile r)

IpeWriteText r => IpeWrite (IpeFile r)

Coordinate r => IpeRead (IpeFile r)

styles :: forall r. Lens' (IpeFile r) [IpeStyle]

preamble :: forall r. Lens' (IpeFile r) (Maybe IpePreamble)

pages :: forall r r. Lens (IpeFile r) (IpeFile r) (NonEmpty (IpePage r)) (NonEmpty (IpePage r))

singlePageFile :: IpePage r -> IpeFile r

Convenience function to construct an ipe file consisting of a single page.

singlePageFromContent :: [IpeObject r] -> IpeFile r

Create a single page ipe file from a list of IpeObjects

applyMatrix' :: (IsTransformable (i r), Matrix ∈ AttributesOf i, Dimension (i r) ~ 2, r ~ NumType (i r)) => IpeObject' i r -> IpeObject' i r

Takes and applies the ipe Matrix attribute of this item.

applyMatrix :: Num r => IpeObject r -> IpeObject r

Applies the matrix to an ipe object if it has one.

applyMatrices :: Num r => IpeFile r -> IpeFile r

applyMatricesPage :: Num r => IpePage r -> IpePage r