Safe Haskell | None |
---|---|
Language | Haskell2010 |
This module define all the types used in the definition of a svg scene.
Most of the types are lensified.
- type Coord = Double
- data Origin
- type Point = (Number, Number)
- type RPoint = V2 Coord
- data PathCommand
- = MoveTo !Origin ![RPoint]
- | LineTo !Origin ![RPoint]
- | HorizontalTo !Origin ![Coord]
- | VerticalTo !Origin ![Coord]
- | CurveTo !Origin ![(RPoint, RPoint, RPoint)]
- | SmoothCurveTo !Origin ![(RPoint, RPoint)]
- | QuadraticBezier !Origin ![(RPoint, RPoint)]
- | SmoothQuadraticBezierCurveTo !Origin ![RPoint]
- | EllipticalArc !Origin ![(Coord, Coord, Coord, Bool, Bool, RPoint)]
- | EndPath
- data Transformation
- data ElementRef
- data CoordinateUnits
- toPoint :: Number -> Number -> Point
- serializeNumber :: Number -> String
- serializeTransformation :: Transformation -> String
- serializeTransformations :: [Transformation] -> String
- data Cap
- data LineJoin
- data Tree
- = None
- | UseTree {
- useInformation :: !Use
- useSubTree :: !(Maybe Tree)
- | GroupTree !(Group Tree)
- | SymbolTree !(Symbol Tree)
- | PathTree !Path
- | CircleTree !Circle
- | PolyLineTree !PolyLine
- | PolygonTree !Polygon
- | EllipseTree !Ellipse
- | LineTree !Line
- | RectangleTree !Rectangle
- | TextTree !(Maybe TextPath) !Text
- | ImageTree !Image
- data Number
- data Spread
- data Texture
- data Element
- data FillRule
- data FontStyle
- type Dpi = Int
- class WithDefaultSvg a where
- data Document = Document {}
- class HasDocument c where
- documentSize :: Dpi -> Document -> (Int, Int)
- data DrawAttributes = DrawAttributes {
- _strokeWidth :: !(Last Number)
- _strokeColor :: !(Last Texture)
- _strokeOpacity :: !(Maybe Float)
- _strokeLineCap :: !(Last Cap)
- _strokeLineJoin :: !(Last LineJoin)
- _strokeMiterLimit :: !(Last Double)
- _fillColor :: !(Last Texture)
- _fillOpacity :: !(Maybe Float)
- _groupOpacity :: !(Maybe Float)
- _transform :: !(Maybe [Transformation])
- _fillRule :: !(Last FillRule)
- _maskRef :: !(Last ElementRef)
- _clipPathRef :: !(Last ElementRef)
- _clipRule :: !(Last FillRule)
- _attrClass :: ![Text]
- _attrId :: !(Maybe String)
- _strokeOffset :: !(Last Number)
- _strokeDashArray :: !(Last [Number])
- _fontSize :: !(Last Number)
- _fontFamily :: !(Last [String])
- _fontStyle :: !(Last FontStyle)
- _textAnchor :: !(Last TextAnchor)
- _markerStart :: !(Last ElementRef)
- _markerMid :: !(Last ElementRef)
- _markerEnd :: !(Last ElementRef)
- class HasDrawAttributes c where
- class WithDrawAttributes a where
- data Rectangle = Rectangle {}
- class HasRectangle c where
- data Line = Line {}
- class HasLine c where
- data Polygon = Polygon {}
- class HasPolygon c where
- data PolyLine = PolyLine {}
- class HasPolyLine c where
- data Path = Path {}
- class HasPath c where
- data Circle = Circle {}
- class HasCircle c where
- data Ellipse = Ellipse {}
- class HasEllipse c where
- data Image = Image {}
- class HasImage c where
- data Use = Use {}
- class HasUse c where
- data Group a = Group {
- _groupDrawAttributes :: !DrawAttributes
- _groupChildren :: ![a]
- _groupViewBox :: !(Maybe (Double, Double, Double, Double))
- _groupAspectRatio :: !PreserveAspectRatio
- class HasGroup c a | c -> a where
- newtype Symbol a = Symbol {
- _groupOfSymbol :: Group a
- groupOfSymbol :: forall a a. Iso (Symbol a) (Symbol a) (Group a) (Group a)
- data Text = Text {
- _textAdjust :: !TextAdjust
- _textRoot :: !TextSpan
- class HasText c where
- data TextAnchor
- textAt :: Point -> Text -> Text
- data TextPath = TextPath {}
- class HasTextPath c where
- data TextPathSpacing
- data TextPathMethod
- data TextSpanContent
- data TextSpan = TextSpan {}
- class HasTextSpan c where
- data TextInfo = TextInfo {
- _textInfoX :: ![Number]
- _textInfoY :: ![Number]
- _textInfoDX :: ![Number]
- _textInfoDY :: ![Number]
- _textInfoRotate :: ![Double]
- _textInfoLength :: !(Maybe Number)
- class HasTextInfo c where
- data TextAdjust
- data Marker = Marker {
- _markerDrawAttributes :: DrawAttributes
- _markerRefPoint :: !(Number, Number)
- _markerWidth :: !(Maybe Number)
- _markerHeight :: !(Maybe Number)
- _markerOrient :: !(Maybe MarkerOrientation)
- _markerUnits :: !(Maybe MarkerUnit)
- _markerViewBox :: !(Maybe (Double, Double, Double, Double))
- _markerOverflow :: !(Maybe Overflow)
- _markerAspectRatio :: !PreserveAspectRatio
- _markerElements :: [Tree]
- data Overflow
- data MarkerOrientation
- data MarkerUnit
- class HasMarker c where
- data GradientStop = GradientStop {}
- class HasGradientStop c where
- data LinearGradient = LinearGradient {}
- class HasLinearGradient c where
- data RadialGradient = RadialGradient {}
- class HasRadialGradient c where
- data Pattern = Pattern {}
- class HasPattern c where
- data Mask = Mask {}
- class HasMask c where
- data ClipPath = ClipPath {}
- class HasClipPath c where
- data PreserveAspectRatio = PreserveAspectRatio {}
- data Alignment
- data MeetSlice
- class HasPreserveAspectRatio c where
- isPathArc :: PathCommand -> Bool
- isPathWithArc :: Foldable f => f PathCommand -> Bool
- nameOfTree :: Tree -> Text
- zipTree :: ([[Tree]] -> Tree) -> Tree -> Tree
- mapTree :: (Tree -> Tree) -> Tree -> Tree
- foldTree :: (a -> Tree -> a) -> a -> Tree -> a
- toUserUnit :: Dpi -> Number -> Number
- mapNumber :: (Double -> Double) -> Number -> Number
Basic building types
Tell if a path command is absolute (in the current user coordiante) or relative to the previous poitn.
OriginAbsolute | Next point in absolute coordinate |
OriginRelative | Next point relative to the previous |
type RPoint = V2 Coord Source #
Real Point, fully determined and not dependant of the rendering context.
data PathCommand Source #
Path command definition.
MoveTo !Origin ![RPoint] |
|
LineTo !Origin ![RPoint] | Line to, |
HorizontalTo !Origin ![Coord] | Equivalent to the |
VerticalTo !Origin ![Coord] | Equivalent to the |
CurveTo !Origin ![(RPoint, RPoint, RPoint)] | Cubic bezier, |
SmoothCurveTo !Origin ![(RPoint, RPoint)] | Smooth cubic bezier, equivalent to |
QuadraticBezier !Origin ![(RPoint, RPoint)] | Quadratic bezier, |
SmoothQuadraticBezierCurveTo !Origin ![RPoint] | Quadratic bezier, |
EllipticalArc !Origin ![(Coord, Coord, Coord, Bool, Bool, RPoint)] | Eliptical arc, |
EndPath | Close the path, |
data Transformation Source #
Describe the content of the transformation
attribute.
see _transform
and transform
.
TransformMatrix !Coord !Coord !Coord !Coord !Coord !Coord | Directly encode the translation matrix. |
Translate !Double !Double | Translation along a vector |
Scale !Double !(Maybe Double) | Scaling on both axis or on X axis and Y axis. |
Rotate !Double !(Maybe (Double, Double)) | Rotation around `(0, 0)` or around an optional point. |
SkewX !Double | Skew transformation along the X axis. |
SkewY !Double | Skew transformation along the Y axis. |
TransformUnknown | Unkown transformation, like identity. |
data ElementRef Source #
Correspond to the possible values of the
the attributes which are either none
or
`url(#elem)`
data CoordinateUnits Source #
Define the possible values of various *units attributes used in the definition of the gradients and masks.
CoordUserSpace |
|
CoordBoundingBox |
|
Building helpers
serializeNumber :: Number -> String Source #
Encode the number to string which can be used in a CSS or a svg attributes.
serializeTransformation :: Transformation -> String Source #
Convert the Transformation to a string which can be directly used in a svg attributes.
serializeTransformations :: [Transformation] -> String Source #
Transform a list of transformations to a string for svg
transform
attributes.
Drawing control types
Describe how the line should be terminated
when stroking them. Describe the values of the
`stroke-linecap` attribute.
See _strokeLineCap
Define the possible values of the `stroke-linejoin`
attribute.
see _strokeLineJoin
Main type for the scene description, reorient to specific type describing each tag.
Encode complex number possibly dependant to the current render size.
Num Double | Simple coordinate in current user coordinate. |
Px Double | With suffix "px" |
Em Double | Number relative to the current font size. |
Percent Double | Number relative to the current viewport size. |
Pc Double | |
Mm Double | Number in millimeters, relative to DPI. |
Cm Double | Number in centimeters, relative to DPI. |
Point Double | Number in points, relative to DPI. |
Inches Double | Number in inches, relative to DPI. |
Define the possible values for the spreadMethod
values used for the gradient definitions.
SpreadRepeat |
|
SpreadPad |
|
SpreadReflect | `reflect value` |
Describe the different value which can be used
in the fill
or stroke
attributes.
ColorRef PixelRGBA8 | |
TextureRef String | Link to a complex texture (url(#name)) |
FillNone | Equivalent to the |
Sum types helping keeping track of all the namable elemens in a SVG document.
Describe the possile filling algorithms. Map the values of the `fill-rule` attributes.
FillEvenOdd | Correspond to the |
FillNonZero | Correspond to the |
Classify the font style, used to search a matching font in the FontCache.
Alias describing a "dot per inch" information used for size calculation (see toUserUnit).
class WithDefaultSvg a where Source #
Define an empty 'default' element for the SVG tree. It is used as base when parsing the element from XML.
defaultSvg :: a Source #
The default element.
Main type
Represent a full svg document with style, geometry and named elements.
class HasDocument c where Source #
Lenses associated to a SVG document.
document :: Lens' c Document Source #
definitions :: Lens' c (Map String Element) Source #
description :: Lens' c String Source #
documentLocation :: Lens' c FilePath Source #
elements :: Lens' c [Tree] Source #
height :: Lens' c (Maybe Number) Source #
styleRules :: Lens' c [CssRule] Source #
viewBox :: Lens' c (Maybe (Double, Double, Double, Double)) Source #
documentSize :: Dpi -> Document -> (Int, Int) Source #
Calculate the document size in function of the different available attributes in the document.
Drawing attributes
data DrawAttributes Source #
This type define how to draw any primitives, which color to use, how to stroke the primitives and the potential transformations to use.
All these attributes are propagated to the children.
DrawAttributes | |
|
class HasDrawAttributes c where Source #
Lenses for the DrawAttributes type.
drawAttributes :: Lens' c DrawAttributes Source #
attrClass :: Lens' c [Text] Source #
attrId :: Lens' c (Maybe String) Source #
clipPathRef :: Lens' c (Last ElementRef) Source #
clipRule :: Lens' c (Last FillRule) Source #
fillColor :: Lens' c (Last Texture) Source #
fillOpacity :: Lens' c (Maybe Float) Source #
fillRule :: Lens' c (Last FillRule) Source #
fontFamily :: Lens' c (Last [String]) Source #
fontSize :: Lens' c (Last Number) Source #
fontStyle :: Lens' c (Last FontStyle) Source #
groupOpacity :: Lens' c (Maybe Float) Source #
markerEnd :: Lens' c (Last ElementRef) Source #
markerMid :: Lens' c (Last ElementRef) Source #
markerStart :: Lens' c (Last ElementRef) Source #
maskRef :: Lens' c (Last ElementRef) Source #
strokeColor :: Lens' c (Last Texture) Source #
strokeDashArray :: Lens' c (Last [Number]) Source #
strokeLineCap :: Lens' c (Last Cap) Source #
strokeLineJoin :: Lens' c (Last LineJoin) Source #
strokeMiterLimit :: Lens' c (Last Double) Source #
strokeOffset :: Lens' c (Last Number) Source #
strokeOpacity :: Lens' c (Maybe Float) Source #
strokeWidth :: Lens' c (Last Number) Source #
textAnchor :: Lens' c (Last TextAnchor) Source #
class WithDrawAttributes a where Source #
Class helping find the drawing attributes for all the SVG attributes.
drawAttr :: Lens' a DrawAttributes Source #
Lens which can be used to read/write primitives.
SVG drawing primitives
Rectangle
Define a rectangle. Correspond to `<rectangle>` svg tag.
Rectangle | |
|
class HasRectangle c where Source #
Lenses for the Rectangle type.
Line
Define a simple line. Correspond to the `<line>` tag.
Line | |
|
class HasLine c where Source #
Lenses for the Line type.
lineDrawAttributes :: Lens' c DrawAttributes Source #
linePoint1 :: Lens' c Point Source #
linePoint2 :: Lens' c Point Source #
Polygon
Primitive decriving polygon composed of segements. Correspond to the `<polygon>` tag
Polygon | |
|
class HasPolygon c where Source #
Lenses for the Polygon type
polygon :: Lens' c Polygon Source #
polygonDrawAttributes :: Lens' c DrawAttributes Source #
polygonPoints :: Lens' c [RPoint] Source #
Polyline
This primitive describe an unclosed suite of segments. Correspond to the `<polyline>` tag.
PolyLine | |
|
class HasPolyLine c where Source #
Lenses for the PolyLine type.
polyLine :: Lens' c PolyLine Source #
polyLineDrawAttributes :: Lens' c DrawAttributes Source #
polyLinePoints :: Lens' c [RPoint] Source #
Path
Type mapping the `<path>` svg tag.
Path | |
|
class HasPath c where Source #
Lenses for the Path type
pathDefinition :: Lens' c [PathCommand] Source #
Circle
Define a `<circle>`.
Circle | |
|
class HasCircle c where Source #
Lenses for the Circle type.
circle :: Lens' c Circle Source #
circleCenter :: Lens' c Point Source #
circleDrawAttributes :: Lens' c DrawAttributes Source #
circleRadius :: Lens' c Number Source #
Ellipse
Define an `<ellipse>`
Ellipse | |
|
class HasEllipse c where Source #
Lenses for the ellipse type.
ellipse :: Lens' c Ellipse Source #
ellipseCenter :: Lens' c Point Source #
ellipseDrawAttributes :: Lens' c DrawAttributes Source #
ellipseXRadius :: Lens' c Number Source #
ellipseYRadius :: Lens' c Number Source #
Image
Define an `<image>` tag.
Image | |
|
class HasImage c where Source #
Lenses for the Image type.
image :: Lens' c Image Source #
imageAspectRatio :: Lens' c PreserveAspectRatio Source #
imageCornerUpperLeft :: Lens' c Point Source #
imageDrawAttributes :: Lens' c DrawAttributes Source #
imageHeight :: Lens' c Number Source #
imageHref :: Lens' c String Source #
imageWidth :: Lens' c Number Source #
Use
Define an `<use>` for a named content. Every named content can be reused in the document using this element.
Use | |
|
Lenses for the Use type.
Grouping primitives
Group
Define a SVG group, corresponding `<g>` tag.
Group | |
|
class HasGroup c a | c -> a where Source #
Lenses associated to the Group type.
group :: Lens' c (Group a) Source #
groupAspectRatio :: Lens' c PreserveAspectRatio Source #
groupChildren :: Lens' c [a] Source #
groupDrawAttributes :: Lens' c DrawAttributes Source #
groupViewBox :: Lens' c (Maybe (Double, Double, Double, Double)) Source #
Symbol
Define the `<symbol>` tag, equivalent to a named group.
Symbol | |
|
groupOfSymbol :: forall a a. Iso (Symbol a) (Symbol a) (Group a) (Group a) Source #
Lenses associated with the Symbol type.
Text related types
Text
Define the global `<tag>` SVG tag.
Text | |
|
data TextAnchor Source #
Tell where to anchor the text, where the position given is realative to the text.
TextAnchorStart | The text with left aligned, or start at the postion
If the point is the *THE_TEXT_TO_PRINT Equivalent to the |
TextAnchorMiddle | The text is middle aligned, so the text will be at the left and right of the position: THE_TEXT*TO_PRINT Equivalent to the |
TextAnchorEnd | The text is right aligned. THE_TEXT_TO_PRINT* Equivalent to the |
textAt :: Point -> Text -> Text Source #
Little helper to create a SVG text at a given baseline position.
Text path
Describe the `<textpath>` SVG tag.
TextPath | |
|
class HasTextPath c where Source #
Lenses for the TextPath type.
textPath :: Lens' c TextPath Source #
textPathData :: Lens' c [PathCommand] Source #
textPathMethod :: Lens' c TextPathMethod Source #
textPathName :: Lens' c String Source #
data TextPathSpacing Source #
Describe the content of the spacing
text path
attribute.
TextPathSpacingExact | Map to the |
TextPathSpacingAuto | Map to the |
data TextPathMethod Source #
Describe the content of the method
attribute on
text path.
TextPathAlign | Map to the |
TextPathStretch | Map to the |
Text span.
data TextSpanContent Source #
Define the content of a `<tspan>` tag.
Define a `<tspan>` tag.
TextSpan | |
|
class HasTextSpan c where Source #
Lenses for the TextSpan type.
textSpan :: Lens' c TextSpan Source #
spanContent :: Lens' c [TextSpanContent] Source #
Define position information associated to `<text>` or `<tspan>` svg tag.
TextInfo | |
|
class HasTextInfo c where Source #
Lenses for the TextInfo type.
data TextAdjust Source #
Define the possible values of the lengthAdjust
attribute.
TextAdjustSpacing | Value |
TextAdjustSpacingAndGlyphs | Value |
Marker definition
Define the `<marker>` tag.
Marker | |
|
Define the content of the markerUnits
attribute
on the Marker.
OverflowVisible | Value |
OverflowHidden | Value |
data MarkerOrientation Source #
Define the orientation, associated to the
orient
attribute on the Marker
OrientationAuto | Auto value |
OrientationAngle Coord | Specific angle. |
data MarkerUnit Source #
Define the content of the markerUnits
attribute
on the Marker.
MarkerUnitStrokeWidth | Value |
MarkerUnitUserSpaceOnUse | Value |
class HasMarker c where Source #
Lenses for the Marker type.
marker :: Lens' c Marker Source #
markerAspectRatio :: Lens' c PreserveAspectRatio Source #
markerDrawAttributes :: Lens' c DrawAttributes Source #
markerElements :: Lens' c [Tree] Source #
markerHeight :: Lens' c (Maybe Number) Source #
markerOrient :: Lens' c (Maybe MarkerOrientation) Source #
markerOverflow :: Lens' c (Maybe Overflow) Source #
markerRefPoint :: Lens' c (Number, Number) Source #
markerUnits :: Lens' c (Maybe MarkerUnit) Source #
markerViewBox :: Lens' c (Maybe (Double, Double, Double, Double)) Source #
Gradient definition
data GradientStop Source #
Define a color stop for the gradients. Represent the `<stop>` SVG tag.
GradientStop | |
|
class HasGradientStop c where Source #
Lenses for the GradientStop type.
gradientStop :: Lens' c GradientStop Source #
gradientColor :: Lens' c PixelRGBA8 Source #
gradientOffset :: Lens' c Float Source #
Linear Gradient
data LinearGradient Source #
Define a `<linearGradient>` tag.
LinearGradient | |
|
class HasLinearGradient c where Source #
Lenses for the LinearGradient type.
Radial Gradient
data RadialGradient Source #
Define a `<radialGradient>` tag.
RadialGradient | |
|
class HasRadialGradient c where Source #
Lenses for the RadialGradient type.
radialGradient :: Lens' c RadialGradient Source #
radialGradientCenter :: Lens' c Point Source #
radialGradientFocusX :: Lens' c (Maybe Number) Source #
radialGradientFocusY :: Lens' c (Maybe Number) Source #
radialGradientRadius :: Lens' c Number Source #
radialGradientSpread :: Lens' c Spread Source #
radialGradientStops :: Lens' c [GradientStop] Source #
radialGradientTransform :: Lens' c [Transformation] Source #
Pattern definition
Define a `<pattern>` tag.
Pattern | |
|
class HasPattern c where Source #
Lenses for the Patter type.
pattern :: Lens' c Pattern Source #
patternAspectRatio :: Lens' c PreserveAspectRatio Source #
patternDrawAttributes :: Lens' c DrawAttributes Source #
patternElements :: Lens' c [Tree] Source #
patternHeight :: Lens' c Number Source #
patternPos :: Lens' c Point Source #
patternUnit :: Lens' c CoordinateUnits Source #
patternViewBox :: Lens' c (Maybe (Double, Double, Double, Double)) Source #
patternWidth :: Lens' c Number Source #
Mask definition
Define a SVG `<mask>` tag.
Mask | |
|
class HasMask c where Source #
Lenses for the Mask type.
maskContent :: Lens' c [Tree] Source #
maskContentUnits :: Lens' c CoordinateUnits Source #
maskDrawAttributes :: Lens' c DrawAttributes Source #
maskHeight :: Lens' c Number Source #
maskPosition :: Lens' c Point Source #
maskUnits :: Lens' c CoordinateUnits Source #
Clip path definition
Define a `<clipPath>` tag.
ClipPath | |
|
class HasClipPath c where Source #
Lenses for the ClipPath type.
clipPath :: Lens' c ClipPath Source #
clipPathContent :: Lens' c [Tree] Source #
Aspect Ratio description
data PreserveAspectRatio Source #
Describe the content of the preserveAspectRatio attribute.
This type represent the align information of the preserveAspectRatio SVGattribute
AlignNone | "none" value |
AlignxMinYMin | |
AlignxMidYMin | "xMidYMin" value |
AlignxMaxYMin | "xMaxYMin" value |
AlignxMinYMid | "xMinYMid" value |
AlignxMidYMid | "xMidYMid" value |
AlignxMaxYMid | "xMaxYMid" value |
AlignxMinYMax | "xMinYMax" value |
AlignxMidYMax | "xMidYMax" value |
AlignxMaxYMax | "xMaxYMax" value |
This type represent the "meet or slice" information of the preserveAspectRatio SVGattribute
class HasPreserveAspectRatio c where Source #
Lenses for the PreserveAspectRatio type
MISC functions
isPathArc :: PathCommand -> Bool Source #
Tell if the path command is an EllipticalArc.
isPathWithArc :: Foldable f => f PathCommand -> Bool Source #
Tell if a full path contain an EllipticalArc.
nameOfTree :: Tree -> Text Source #
For every element of a svg tree, associate it's SVG tag name.
zipTree :: ([[Tree]] -> Tree) -> Tree -> Tree Source #
Map a tree while propagating context information. The function passed in parameter receive a list representing the the path used to go arrive to the current node.