Reanimate.Svg

Documentation

lowerTransformations :: SVG -> SVG

Remove transformations (such as translations, rotations, scaling) and apply them directly to the SVG nodes. Note, this function may convert nodes (such as Circle or Rect) to paths. Also note that does change how the SVG is rendered. Particularly, stroke width is affected by directly applying scaling.

lowerTransformations (scale 2 (mkCircle 1)) = mkCircle 2

lowerIds :: SVG -> SVG

Remove all id attributes.

clearDrawAttributes :: SVG -> SVG

Remove all draw attributes such as stroke, fill and 'fill-opacity'.

simplify :: SVG -> SVG

Optimize SVG tree without affecting how it is rendered.

removeGroups :: SVG -> [SVG]

Separate grouped items. This is required by clip nodes.

removeGroups (withFillColor "blue" $ mkGroup [mkCircle 1, mkRect 1 1])
    = [ withFillColor "blue" $ mkCircle 1
      , withFillColor "blue" $ mkRect 1 1 ]

extractPath :: SVG -> [PathCommand]

Extract all path commands from a node (and its children) and concatenate them.

withSubglyphs :: [Int] -> (SVG -> SVG) -> SVG -> SVG

Map over indexed symbols.

withSubglyphs [0,2] (scale 2) (mkGroup [mkCircle 1, mkRect 2, mkEllipse 1 2])
      = mkGroup [scale 2 (mkCircle 1), mkRect 2, scale 2 (mkEllipse 1 2)]

splitGlyphs :: [Int] -> SVG -> (SVG, SVG)

Split symbols.

splitGlyphs [0,2] (mkGroup [mkCircle 1, mkRect 2, mkEllipse 1 2])
      = ([mkRect 2], [mkCircle 1, mkEllipse 1 2])

svgGlyphs :: SVG -> [(SVG -> SVG, DrawAttributes, SVG)]

Split symbols and include their context and drawing attributes.

pathify :: SVG -> SVG

Convert primitive SVG shapes (like those created by mkCircle, mkRect, mkLine or mkEllipse) into SVG path. This can be useful for creating animations of these shapes being drawn progressively with partialSvg.

Example:

pathifyExample :: Animation
pathifyExample = animate $ \t -> gridLayout
    [ [ partialSvg t $ pathify $ mkCircle 1
      , partialSvg t $ pathify $ mkRect 2 2
      ]
    , [ partialSvg t $ pathify $ mkEllipse 1 0.5
      , partialSvg t $ pathify $ mkLine (-1, -1) (1, 1)
      ]
    ]

mapSvgPaths :: ([PathCommand] -> [PathCommand]) -> SVG -> SVG

Map over all recursively-found path commands.

mapSvgLines :: ([LineCommand] -> [LineCommand]) -> SVG -> SVG

Map over all recursively-found line commands.

mapSvgPoints :: (RPoint -> RPoint) -> SVG -> SVG

Map over all line command control points.

svgPointsToRadians :: SVG -> SVG

Convert coordinate system from degrees to radians.

module Reanimate.Svg.Constructors

module Reanimate.Svg.LineCommand

boundingBox :: Tree -> (Double, Double, Double, Double)

Return bounding box of SVG tree. The four numbers returned are (minimal X-coordinate, minimal Y-coordinate, width, height)

Note: Bounding boxes are computed on a best-effort basis and will not work in all cases. The only supported SVG nodes are: path, circle, polyline, ellipse, line, rectangle, image. All other nodes return (0,0,0,0).

svgHeight :: Tree -> Double

Height of SVG node in local units (not pixels). Computed on best-effort basis and will not give accurate results for all SVG nodes.

svgWidth :: Tree -> Double

Width of SVG node in local units (not pixels). Computed on best-effort basis and will not give accurate results for all SVG nodes.

replaceUses :: Document -> Document

Replace all use nodes with their definition.

unbox :: Document -> Tree

Transform out viewbox. Definitions and CSS rules are discarded.

unboxFit :: Document -> Tree

Transform out viewbox and fit image to screen size.

embedDocument :: Document -> Tree

Embed Document. This keeps the entire document intact but makes it more difficult to use, say, pathify on it.