{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE FlexibleContexts     #-}
{-# LANGUAGE GADTs                #-}
{-# LANGUAGE StandaloneDeriving   #-}
{-# LANGUAGE TemplateHaskell      #-}
{-# LANGUAGE TypeFamilies         #-}
{-# LANGUAGE UndecidableInstances #-}
{-# LANGUAGE ViewPatterns         #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}
  -- for Data.Semigroup

-----------------------------------------------------------------------------
-- |
-- Module      :  Diagrams.TwoD.Offset
-- Copyright   :  (c) 2013 diagrams-lib team (see LICENSE)
-- License     :  BSD-style (see LICENSE)
-- Maintainer  :  diagrams-discuss@googlegroups.com
--
-- Compute offsets to segments in two dimensions.  More details can be
-- found in the manual at
-- <http://projects.haskell.org/diagrams/doc/manual.html#offsets-of-segments-trails-and-paths>.
--
-----------------------------------------------------------------------------
module Diagrams.TwoD.Offset
    (
      -- * Offsets

      offsetSegment

    , OffsetOpts(..), offsetJoin, offsetMiterLimit, offsetEpsilon
    , offsetTrail
    , offsetTrail'
    , offsetPath
    , offsetPath'

      -- * Expansions

    , ExpandOpts(..), expandJoin, expandMiterLimit, expandCap, expandEpsilon
    , expandTrail
    , expandTrail'
    , expandPath
    , expandPath'

    ) where

import           Control.Applicative
import           Control.Lens            hiding (at)
import           Prelude

import           Data.Maybe              (catMaybes)
import           Data.Monoid
import           Data.Monoid.Inf

import           Data.Default.Class

import           Diagrams.Core

import           Diagrams.Attributes
import           Diagrams.Direction
import           Diagrams.Located
import           Diagrams.Parametric
import           Diagrams.Path
import           Diagrams.Segment
import           Diagrams.Trail          hiding (isLoop, offset)
import           Diagrams.TrailLike
import           Diagrams.TwoD.Arc
import           Diagrams.TwoD.Curvature
import           Diagrams.TwoD.Path      ()
import           Diagrams.TwoD.Types
import           Diagrams.TwoD.Vector    hiding (e)

import           Linear.Affine
import           Linear.Metric
import           Linear.Vector

unitPerp :: OrderedField n => V2 n -> V2 n
unitPerp :: V2 n -> V2 n
unitPerp = V2 n -> V2 n
forall (f :: * -> *) a. (Metric f, Floating a) => f a -> f a
signorm (V2 n -> V2 n) -> (V2 n -> V2 n) -> V2 n -> V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. V2 n -> V2 n
forall a. Num a => V2 a -> V2 a
perp

perpAtParam :: OrderedField n => Segment Closed V2 n -> n -> V2 n
perpAtParam :: Segment Closed V2 n -> n -> V2 n
perpAtParam (Linear (OffsetClosed V2 n
a)) n
_ = V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => f a -> f a
negated (V2 n -> V2 n) -> V2 n -> V2 n
forall a b. (a -> b) -> a -> b
$ V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp V2 n
a
perpAtParam Segment Closed V2 n
cubic n
t                     = V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => f a -> f a
negated (V2 n -> V2 n) -> V2 n -> V2 n
forall a b. (a -> b) -> a -> b
$ V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp V2 n
a
  where
    (Cubic V2 n
a V2 n
_ Offset Closed V2 n
_) = (Segment Closed V2 n, Segment Closed V2 n) -> Segment Closed V2 n
forall a b. (a, b) -> b
snd ((Segment Closed V2 n, Segment Closed V2 n) -> Segment Closed V2 n)
-> (Segment Closed V2 n, Segment Closed V2 n)
-> Segment Closed V2 n
forall a b. (a -> b) -> a -> b
$ Segment Closed V2 n
-> N (Segment Closed V2 n)
-> (Segment Closed V2 n, Segment Closed V2 n)
forall p. Sectionable p => p -> N p -> (p, p)
splitAtParam Segment Closed V2 n
cubic n
N (Segment Closed V2 n)
t

-- | Compute the offset of a segment.  Given a segment compute the offset
--   curve that is a fixed distance from the original curve.  For linear
--   segments nothing special happens, the same linear segment is returned
--   with a point that is offset by a perpendicular vector of the given offset
--   length.
--
--   Cubic segments require a search for a subdivision of cubic segments that
--   gives an approximation of the offset within the given epsilon factor
--   (the given epsilon factor is applied to the radius giving a concrete epsilon
--   value).
--   We must do this because the offset of a cubic is not a cubic itself (the
--   degree of the curve increases).  Cubics do, however, approach constant
--   curvature as we subdivide.  In light of this we scale the handles of
--   the offset cubic segment in proportion to the radius of curvature difference
--   between the original subsegment and the offset which will have a radius
--   increased by the offset parameter.
--
--   In the following example the blue lines are the original segments and
--   the alternating green and red lines are the resulting offset trail segments.
--
--   <<diagrams/src_Diagrams_TwoD_Offset_cubicOffsetExample.svg#diagram=cubicOffsetExample&width=600>>
--
--   Note that when the original curve has a cusp, the offset curve forms a
--   radius around the cusp, and when there is a loop in the original curve,
--   there can be two cusps in the offset curve.
--

-- | Options for specifying line join and segment epsilon for an offset
--   involving multiple segments.
data OffsetOpts d = OffsetOpts
    { OffsetOpts d -> LineJoin
_offsetJoin       :: LineJoin
    , OffsetOpts d -> d
_offsetMiterLimit :: d
    , OffsetOpts d -> d
_offsetEpsilon    :: d
    }

deriving instance Eq d => Eq (OffsetOpts d)
deriving instance Show d => Show (OffsetOpts d)

makeLensesWith (lensRules & generateSignatures .~ False) ''OffsetOpts

-- | Specifies the style of join for between adjacent offset segments.
offsetJoin :: Lens' (OffsetOpts d) LineJoin

-- | Specifies the miter limit for the join.
offsetMiterLimit :: Lens' (OffsetOpts d) d

-- | Epsilon perimeter for 'offsetSegment'.
offsetEpsilon :: Lens' (OffsetOpts d) d

-- | The default offset options use the default 'LineJoin' ('LineJoinMiter'), a
--   miter limit of 10, and epsilon factor of 0.01.
instance Fractional d => Default (OffsetOpts d) where
    def :: OffsetOpts d
def = LineJoin -> d -> d -> OffsetOpts d
forall d. LineJoin -> d -> d -> OffsetOpts d
OffsetOpts LineJoin
forall a. Default a => a
def d
10 d
0.01

-- | Options for specifying how a 'Trail' should be expanded.
data ExpandOpts d = ExpandOpts
    { ExpandOpts d -> LineJoin
_expandJoin       :: LineJoin
    , ExpandOpts d -> d
_expandMiterLimit :: d
    , ExpandOpts d -> LineCap
_expandCap        :: LineCap
    , ExpandOpts d -> d
_expandEpsilon    :: d
    } deriving (ExpandOpts d -> ExpandOpts d -> Bool
(ExpandOpts d -> ExpandOpts d -> Bool)
-> (ExpandOpts d -> ExpandOpts d -> Bool) -> Eq (ExpandOpts d)
forall d. Eq d => ExpandOpts d -> ExpandOpts d -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ExpandOpts d -> ExpandOpts d -> Bool
$c/= :: forall d. Eq d => ExpandOpts d -> ExpandOpts d -> Bool
== :: ExpandOpts d -> ExpandOpts d -> Bool
$c== :: forall d. Eq d => ExpandOpts d -> ExpandOpts d -> Bool
Eq, Int -> ExpandOpts d -> ShowS
[ExpandOpts d] -> ShowS
ExpandOpts d -> String
(Int -> ExpandOpts d -> ShowS)
-> (ExpandOpts d -> String)
-> ([ExpandOpts d] -> ShowS)
-> Show (ExpandOpts d)
forall d. Show d => Int -> ExpandOpts d -> ShowS
forall d. Show d => [ExpandOpts d] -> ShowS
forall d. Show d => ExpandOpts d -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ExpandOpts d] -> ShowS
$cshowList :: forall d. Show d => [ExpandOpts d] -> ShowS
show :: ExpandOpts d -> String
$cshow :: forall d. Show d => ExpandOpts d -> String
showsPrec :: Int -> ExpandOpts d -> ShowS
$cshowsPrec :: forall d. Show d => Int -> ExpandOpts d -> ShowS
Show)

makeLensesWith (lensRules & generateSignatures .~ False) ''ExpandOpts

-- | Specifies the style of join for between adjacent offset segments.
expandJoin :: Lens' (ExpandOpts d) LineJoin

-- | Specifies the miter limit for the join.
expandMiterLimit :: Lens' (ExpandOpts d) d

-- | Specifies how the ends are handled.
expandCap :: Lens' (ExpandOpts d) LineCap

-- | Epsilon perimeter for 'offsetSegment'.
expandEpsilon :: Lens' (ExpandOpts d) d



-- | The default 'ExpandOpts' is the default 'LineJoin' ('LineJoinMiter'),
--   miter limit of 10, default 'LineCap' ('LineCapButt'), and epsilon factor
--   of 0.01.
instance (Fractional d) => Default (ExpandOpts d) where
    def :: ExpandOpts d
def = LineJoin -> d -> LineCap -> d -> ExpandOpts d
forall d. LineJoin -> d -> LineCap -> d -> ExpandOpts d
ExpandOpts LineJoin
forall a. Default a => a
def d
10 LineCap
forall a. Default a => a
def d
0.01

offsetSegment :: RealFloat n
              => n   -- ^ Epsilon factor that when multiplied to the
                            --   absolute value of the radius gives a
                            --   value that represents the maximum
                            --   allowed deviation from the true offset.  In
                            --   the current implementation each result segment
                            --   should be bounded by arcs that are plus or
                            --   minus epsilon factor from the radius of curvature of
                            --   the offset.
              -> n   -- ^ Offset from the original segment, positive is
                            --   on the right of the curve, negative is on the
                            --   left.
              -> Segment Closed V2 n  -- ^ Original segment
              -> Located (Trail V2 n) -- ^ Resulting located (at the offset) trail.
offsetSegment :: n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
offsetSegment n
_       n
r s :: Segment Closed V2 n
s@(Linear (OffsetClosed V2 n
a))    = [Segment Closed V2 n] -> Trail V2 n
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
[Segment Closed v n] -> Trail v n
trailFromSegments [Segment Closed V2 n
s] Trail V2 n
-> Point (V (Trail V2 n)) (N (Trail V2 n)) -> Located (Trail V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point V2 n
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin Point V2 n -> Diff (Point V2) n -> Point V2 n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> Diff p a -> p a
.+^ Diff (Point V2) n
V2 n
va
  where va :: V2 n
va = (-n
r) n -> V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => a -> f a -> f a
*^ V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp V2 n
a

offsetSegment n
epsilon n
r s :: Segment Closed V2 n
s@(Cubic V2 n
a V2 n
b (OffsetClosed V2 n
c)) = Trail V2 n
t Trail V2 n
-> Point (V (Trail V2 n)) (N (Trail V2 n)) -> Located (Trail V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point V2 n
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin Point V2 n -> Diff (Point V2) n -> Point V2 n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> Diff p a -> p a
.+^ Diff (Point V2) n
V2 n
va
  where
    t :: Trail V2 n
t = [Segment Closed V2 n] -> Trail V2 n
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
[Segment Closed v n] -> Trail v n
trailFromSegments (Inf Pos n -> [Segment Closed V2 n]
go (Segment Closed V2 n -> n -> Inf Pos n
forall n. RealFloat n => Segment Closed V2 n -> n -> PosInf n
radiusOfCurvature Segment Closed V2 n
s n
0.5))
    -- Perpendiculars to handles.
    va :: V2 n
va = (-n
r) n -> V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => a -> f a -> f a
*^ V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp V2 n
a
    vc :: V2 n
vc = (-n
r) n -> V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => a -> f a -> f a
*^ V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp (V2 n
c V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^-^ V2 n
b)
    -- Split segments.
    ss :: [Segment Closed V2 n]
ss = (\(Segment Closed V2 n
x,Segment Closed V2 n
y) -> [Segment Closed V2 n
x,Segment Closed V2 n
y]) ((Segment Closed V2 n, Segment Closed V2 n)
 -> [Segment Closed V2 n])
-> (Segment Closed V2 n, Segment Closed V2 n)
-> [Segment Closed V2 n]
forall a b. (a -> b) -> a -> b
$ Segment Closed V2 n
-> N (Segment Closed V2 n)
-> (Segment Closed V2 n, Segment Closed V2 n)
forall p. Sectionable p => p -> N p -> (p, p)
splitAtParam Segment Closed V2 n
s N (Segment Closed V2 n)
0.5
    subdivided :: [Segment Closed V2 n]
subdivided = (Segment Closed V2 n -> [Segment Closed V2 n])
-> [Segment Closed V2 n] -> [Segment Closed V2 n]
forall (t :: * -> *) a b. Foldable t => (a -> [b]) -> t a -> [b]
concatMap (Trail V2 n -> [Segment Closed V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Trail v n -> [Segment Closed v n]
trailSegments (Trail V2 n -> [Segment Closed V2 n])
-> (Segment Closed V2 n -> Trail V2 n)
-> Segment Closed V2 n
-> [Segment Closed V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc (Located (Trail V2 n) -> Trail V2 n)
-> (Segment Closed V2 n -> Located (Trail V2 n))
-> Segment Closed V2 n
-> Trail V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
forall n.
RealFloat n =>
n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
offsetSegment n
epsilon n
r) [Segment Closed V2 n]
ss

    -- Offset with handles scaled based on curvature.
    offset :: n -> Segment Closed V2 n
offset n
factor = V2 n -> V2 n -> V2 n -> Segment Closed V2 n
forall (v :: * -> *) n. v n -> v n -> v n -> Segment Closed v n
bezier3 (V2 n
aV2 n -> n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => f a -> a -> f a
^*n
factor) ((V2 n
b V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^-^ V2 n
c)V2 n -> n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => f a -> a -> f a
^*n
factor V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^+^ V2 n
c V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^+^ V2 n
vc V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^-^ V2 n
va) (V2 n
c V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^+^ V2 n
vc V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^-^ V2 n
va)

    -- We observe a corner.  Subdivide right away.
    go :: Inf Pos n -> [Segment Closed V2 n]
go (Finite n
0) = [Segment Closed V2 n]
subdivided
    -- We have some curvature
    go Inf Pos n
roc
      | Bool
close     = [Segment Closed V2 n
o]
      | Bool
otherwise = [Segment Closed V2 n]
subdivided
      where
        -- We want the multiplicative factor that takes us from the original
        -- segment's radius of curvature roc, to roc + r.
        --
        -- r + sr = x * sr
        --
        o :: Segment Closed V2 n
o = n -> Segment Closed V2 n
offset (n -> Segment Closed V2 n) -> n -> Segment Closed V2 n
forall a b. (a -> b) -> a -> b
$ case Inf Pos n
roc of
              Inf Pos n
Infinity  -> n
1          -- Do the right thing.
              Finite n
sr -> n
1 n -> n -> n
forall a. Num a => a -> a -> a
+ n
r n -> n -> n
forall a. Fractional a => a -> a -> a
/ n
sr

        close :: Bool
close = [Bool] -> Bool
forall (t :: * -> *). Foldable t => t Bool -> Bool
and [n
epsilon n -> n -> n
forall a. Num a => a -> a -> a
* n -> n
forall a. Num a => a -> a
abs n
r n -> n -> Bool
forall a. Ord a => a -> a -> Bool
> V2 n -> n
forall (f :: * -> *) a. (Metric f, Floating a) => f a -> a
norm (Segment Closed V2 n
-> Codomain (Segment Closed V2 n) (N (Segment Closed V2 n))
p Segment Closed V2 n
o V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^+^ V2 n
va V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^-^ Segment Closed V2 n
-> Codomain (Segment Closed V2 n) (N (Segment Closed V2 n))
p Segment Closed V2 n
s V2 n -> V2 n -> V2 n
forall (f :: * -> *) a. (Additive f, Num a) => f a -> f a -> f a
^-^ Segment Closed V2 n -> V2 n
pp Segment Closed V2 n
s)
                    | n
t' <- [n
0.25, n
0.5, n
0.75]
                    , let p :: Segment Closed V2 n
-> Codomain (Segment Closed V2 n) (N (Segment Closed V2 n))
p = (Segment Closed V2 n
-> N (Segment Closed V2 n)
-> Codomain (Segment Closed V2 n) (N (Segment Closed V2 n))
forall p. Parametric p => p -> N p -> Codomain p (N p)
`atParam` n
N (Segment Closed V2 n)
t')
                    , let pp :: Segment Closed V2 n -> V2 n
pp = (n
r n -> V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => a -> f a -> f a
*^) (V2 n -> V2 n)
-> (Segment Closed V2 n -> V2 n) -> Segment Closed V2 n -> V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Segment Closed V2 n -> n -> V2 n
forall n. OrderedField n => Segment Closed V2 n -> n -> V2 n
`perpAtParam` n
t')
                    ]


-- > import Diagrams.TwoD.Offset
-- >
-- > showExample :: Segment Closed V2 Double -> Diagram SVG
-- > showExample s = pad 1.1 . centerXY $ d # lc blue # lw thick <> d' # lw thick
-- >   where
-- >       d  = strokeP . fromSegments $ [s]
-- >       d' = mconcat . zipWith lc colors . map strokeP . explodeTrail
-- >          $ offsetSegment 0.1 (-1) s
-- >
-- >       colors = cycle [green, red]
-- >
-- > cubicOffsetExample :: Diagram SVG
-- > cubicOffsetExample = hcat . map showExample $
-- >         [ bezier3 (10 ^&  0) (  5  ^& 18) (10 ^& 20)
-- >         , bezier3 ( 0 ^& 20) ( 10  ^& 10) ( 5 ^& 10)
-- >         , bezier3 (10 ^& 20) (  0  ^& 10) (10 ^&  0)
-- >         , bezier3 (10 ^& 20) ((-5) ^& 10) (10 ^&  0)
-- >         ]

-- Similar to (=<<).  This is when we want to map a function across something
-- located, but the result of the mapping will be transformable so we can
-- collapse the Located into the result.  This assumes that Located has the
-- meaning of merely taking something that cannot be translated and lifting
-- it into a space with translation.
bindLoc :: (Transformable b, V a ~ V b, N a ~ N b, V a ~ V2, N a ~ n, Num n) => (a -> b) -> Located a -> b
bindLoc :: (a -> b) -> Located a -> b
bindLoc a -> b
f = Located b -> b
forall t.
(Transformable t, Additive (V t), Num (N t)) =>
Located t -> t
join' (Located b -> b) -> (Located a -> Located b) -> Located a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (a -> b) -> Located a -> Located b
forall a b. SameSpace a b => (a -> b) -> Located a -> Located b
mapLoc a -> b
f
  where
    join' :: Located t -> t
join' (Located t -> (Point (V t) (N t), t)
forall a. Located a -> (Point (V a) (N a), a)
viewLoc -> (Point (V t) (N t)
p,t
a)) = Vn t -> t -> t
forall t. Transformable t => Vn t -> t -> t
translate (Point (V t) (N t)
p Point (V t) (N t) -> Point (V t) (N t) -> Diff (Point (V t)) (N t)
forall (p :: * -> *) a. (Affine p, Num a) => p a -> p a -> Diff p a
.-. Point (V t) (N t)
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin) t
a

-- While we build offsets and expansions we will use the [Located (Segment Closed v)]
-- and [Located (Trail V2 n)] intermediate representations.
locatedTrailSegments :: OrderedField n
                     => Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
locatedTrailSegments :: Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
locatedTrailSegments Located (Trail V2 n)
t = (Segment Closed V2 n
 -> Point V2 n -> Located (Segment Closed V2 n))
-> [Segment Closed V2 n]
-> [Point V2 n]
-> [Located (Segment Closed V2 n)]
forall a b c. (a -> b -> c) -> [a] -> [b] -> [c]
zipWith Segment Closed V2 n -> Point V2 n -> Located (Segment Closed V2 n)
forall a. a -> Point (V a) (N a) -> Located a
at (Trail V2 n -> [Segment Closed V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Trail v n -> [Segment Closed v n]
trailSegments (Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc Located (Trail V2 n)
t)) (Located (Trail V2 n) -> [Point V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Located (Trail v n) -> [Point v n]
trailPoints Located (Trail V2 n)
t)

-- | Offset a 'Trail' with options and by a given radius.  This generates a new
--   trail that is always radius 'r' away from the given 'Trail' (depending on
--   the line join option) on the right.
--
--   The styles applied to an outside corner can be seen here (with the original
--   trail in blue and the result of 'offsetTrail'' in green):
--
--   <<diagrams/src_Diagrams_TwoD_Offset_offsetTrailExample.svg#diagram=offsetTrailExample&width=600>>
--
--   When a negative radius is given, the offset trail will be on the left:
--
--   <<diagrams/src_Diagrams_TwoD_Offset_offsetTrailLeftExample.svg#diagram=offsetTrailLeftExample&width=200>>
--
--   When offseting a counter-clockwise loop a positive radius gives an outer loop
--   while a negative radius gives an inner loop (both counter-clockwise).
--
--   <<diagrams/src_Diagrams_TwoD_Offset_offsetTrailOuterExample.svg#diagram=offsetTrailOuterExample&width=300>>
--
offsetTrail' :: RealFloat n
             => OffsetOpts n
             -> n -- ^ Radius of offset.  A negative value gives an offset on
                         --   the left for a line and on the inside for a counter-clockwise
                         --   loop.
             -> Located (Trail V2 n)
             -> Located (Trail V2 n)
offsetTrail' :: OffsetOpts n -> n -> Located (Trail V2 n) -> Located (Trail V2 n)
offsetTrail' OffsetOpts n
opts n
r Located (Trail V2 n)
t = n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
forall n.
RealFloat n =>
n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
joinSegments n
eps n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
j Bool
isLoop (OffsetOpts n
optsOffsetOpts n -> Getting n (OffsetOpts n) n -> n
forall s a. s -> Getting a s a -> a
^.Getting n (OffsetOpts n) n
forall d. Lens' (OffsetOpts d) d
offsetMiterLimit) n
r [Point V2 n]
ends ([Located (Trail V2 n)] -> Located (Trail V2 n))
-> (Located (Trail V2 n) -> [Located (Trail V2 n)])
-> Located (Trail V2 n)
-> Located (Trail V2 n)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Located (Trail V2 n)]
offset (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t
    where
      eps :: n
eps = OffsetOpts n
optsOffsetOpts n -> Getting n (OffsetOpts n) n -> n
forall s a. s -> Getting a s a -> a
^.Getting n (OffsetOpts n) n
forall d. Lens' (OffsetOpts d) d
offsetEpsilon
      offset :: Located (Trail V2 n) -> [Located (Trail V2 n)]
offset = (Located (Segment Closed V2 n) -> Located (Trail V2 n))
-> [Located (Segment Closed V2 n)] -> [Located (Trail V2 n)]
forall a b. (a -> b) -> [a] -> [b]
map ((Segment Closed V2 n -> Located (Trail V2 n))
-> Located (Segment Closed V2 n) -> Located (Trail V2 n)
forall b a n.
(Transformable b, V a ~ V b, N a ~ N b, V a ~ V2, N a ~ n,
 Num n) =>
(a -> b) -> Located a -> b
bindLoc (n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
forall n.
RealFloat n =>
n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
offsetSegment n
eps n
r)) ([Located (Segment Closed V2 n)] -> [Located (Trail V2 n)])
-> (Located (Trail V2 n) -> [Located (Segment Closed V2 n)])
-> Located (Trail V2 n)
-> [Located (Trail V2 n)]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
forall n.
OrderedField n =>
Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
locatedTrailSegments
      ends :: [Point V2 n]
ends | Bool
isLoop    = (\(Point V2 n
a:[Point V2 n]
as) -> [Point V2 n]
as [Point V2 n] -> [Point V2 n] -> [Point V2 n]
forall a. [a] -> [a] -> [a]
++ [Point V2 n
a]) ([Point V2 n] -> [Point V2 n])
-> (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n)
-> [Point V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Point V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Located (Trail v n) -> [Point v n]
trailPoints (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n) -> [Point V2 n]
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t
           | Bool
otherwise = [Point V2 n] -> [Point V2 n]
forall a. [a] -> [a]
tail ([Point V2 n] -> [Point V2 n])
-> (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n)
-> [Point V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Point V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Located (Trail v n) -> [Point v n]
trailPoints (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n) -> [Point V2 n]
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t
      j :: n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
j = LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
fromLineJoin (OffsetOpts n
optsOffsetOpts n
-> Getting LineJoin (OffsetOpts n) LineJoin -> LineJoin
forall s a. s -> Getting a s a -> a
^.Getting LineJoin (OffsetOpts n) LineJoin
forall d. Lens' (OffsetOpts d) LineJoin
offsetJoin)

      isLoop :: Bool
isLoop = (Trail' Line V2 n -> Bool)
-> (Trail' Loop V2 n -> Bool) -> Trail V2 n -> Bool
forall (v :: * -> *) n r.
(Trail' Line v n -> r) -> (Trail' Loop v n -> r) -> Trail v n -> r
withTrail (Bool -> Trail' Line V2 n -> Bool
forall a b. a -> b -> a
const Bool
False) (Bool -> Trail' Loop V2 n -> Bool
forall a b. a -> b -> a
const Bool
True) (Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc Located (Trail V2 n)
t)

-- | Offset a 'Trail' with the default options and a given radius.  See 'offsetTrail''.
offsetTrail :: RealFloat n => n -> Located (Trail V2 n) -> Located (Trail V2 n)
offsetTrail :: n -> Located (Trail V2 n) -> Located (Trail V2 n)
offsetTrail = OffsetOpts n -> n -> Located (Trail V2 n) -> Located (Trail V2 n)
forall n.
RealFloat n =>
OffsetOpts n -> n -> Located (Trail V2 n) -> Located (Trail V2 n)
offsetTrail' OffsetOpts n
forall a. Default a => a
def

-- | Offset a 'Path' by applying 'offsetTrail'' to each trail in the path.
offsetPath' :: RealFloat n => OffsetOpts n -> n -> Path V2 n -> Path V2 n
offsetPath' :: OffsetOpts n -> n -> Path V2 n -> Path V2 n
offsetPath' OffsetOpts n
opts n
r = [Path V2 n] -> Path V2 n
forall a. Monoid a => [a] -> a
mconcat
                   ([Path V2 n] -> Path V2 n)
-> (Path V2 n -> [Path V2 n]) -> Path V2 n -> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Located (Trail V2 n) -> Path V2 n)
-> [Located (Trail V2 n)] -> [Path V2 n]
forall a b. (a -> b) -> [a] -> [b]
map ((Located (Trail V2 n) -> Path V2 n)
-> Located (Located (Trail V2 n)) -> Path V2 n
forall b a n.
(Transformable b, V a ~ V b, N a ~ N b, V a ~ V2, N a ~ n,
 Num n) =>
(a -> b) -> Located a -> b
bindLoc (Located (Trail V2 n) -> Path V2 n
forall t. TrailLike t => Located (Trail (V t) (N t)) -> t
trailLike (Located (Trail V2 n) -> Path V2 n)
-> (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n)
-> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OffsetOpts n -> n -> Located (Trail V2 n) -> Located (Trail V2 n)
forall n.
RealFloat n =>
OffsetOpts n -> n -> Located (Trail V2 n) -> Located (Trail V2 n)
offsetTrail' OffsetOpts n
opts n
r) (Located (Located (Trail V2 n)) -> Path V2 n)
-> (Located (Trail V2 n) -> Located (Located (Trail V2 n)))
-> Located (Trail V2 n)
-> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Located (Trail V2 n)
-> Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
-> Located (Located (Trail V2 n))
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin))
                   ([Located (Trail V2 n)] -> [Path V2 n])
-> (Path V2 n -> [Located (Trail V2 n)])
-> Path V2 n
-> [Path V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Unwrapped (Path V2 n) -> Path V2 n)
-> Path V2 n -> Unwrapped (Path V2 n)
forall s. Wrapped s => (Unwrapped s -> s) -> s -> Unwrapped s
op Unwrapped (Path V2 n) -> Path V2 n
forall (v :: * -> *) n. [Located (Trail v n)] -> Path v n
Path

-- | Offset a 'Path' with the default options and given radius.  See 'offsetPath''.
offsetPath :: RealFloat n => n -> Path V2 n -> Path V2 n
offsetPath :: n -> Path V2 n -> Path V2 n
offsetPath = OffsetOpts n -> n -> Path V2 n -> Path V2 n
forall n.
RealFloat n =>
OffsetOpts n -> n -> Path V2 n -> Path V2 n
offsetPath' OffsetOpts n
forall a. Default a => a
def

-- TODO: Include arrowheads on examples to indicate direction so the "left" and
-- "right" make sense.
--
-- > import Diagrams.TwoD.Offset
-- > import Data.Default.Class
-- >
-- > corner :: (OrderedField n) => Located (Trail V2 n)
-- > corner = fromVertices (map p2 [(0, 0), (10, 0), (5, 6)]) `at` origin
-- >
-- > offsetTrailExample :: Diagram SVG
-- > offsetTrailExample = pad 1.1 . centerXY . lwO 3 . hcat' (def & sep .~ 1 )
-- >                    . map (uncurry showStyle)
-- >                    $ [ (LineJoinMiter, "LineJoinMiter")
-- >                      , (LineJoinRound, "LineJoinRound")
-- >                      , (LineJoinBevel, "LineJoinBevel")
-- >                      ]
-- >  where
-- >    showStyle j s = centerXY (trailLike corner # lc blue
-- >               <> trailLike (offsetTrail' (def & offsetJoin .~ j) 2 corner) # lc green)
-- >            === (strutY 3 <> text s # font "Helvetica" # bold)
-- >
-- > offsetTrailLeftExample :: Diagram SVG
-- > offsetTrailLeftExample = pad 1.1 . centerXY . lwO 3
-- >                        $ (trailLike c # lc blue)
-- >                        <> (lc green . trailLike
-- >                         . offsetTrail' (def & offsetJoin .~ LineJoinRound) (-2) $ c)
-- >   where
-- >     c = reflectY corner
-- >
-- > offsetTrailOuterExample :: Diagram SVG
-- > offsetTrailOuterExample = pad 1.1 . centerXY . lwO 3
-- >                         $ (trailLike c # lc blue)
-- >                         <> (lc green . trailLike
-- >                          . offsetTrail' (def & offsetJoin .~ LineJoinRound) 2 $ c)
-- >   where
-- >     c = hexagon 5

withTrailL :: (Located (Trail' Line V2 n) -> r) -> (Located (Trail' Loop V2 n) -> r) -> Located (Trail V2 n) -> r
withTrailL :: (Located (Trail' Line V2 n) -> r)
-> (Located (Trail' Loop V2 n) -> r) -> Located (Trail V2 n) -> r
withTrailL Located (Trail' Line V2 n) -> r
f Located (Trail' Loop V2 n) -> r
g Located (Trail V2 n)
l = (Trail' Line V2 n -> r)
-> (Trail' Loop V2 n -> r) -> Trail V2 n -> r
forall (v :: * -> *) n r.
(Trail' Line v n -> r) -> (Trail' Loop v n -> r) -> Trail v n -> r
withTrail (Located (Trail' Line V2 n) -> r
f (Located (Trail' Line V2 n) -> r)
-> (Trail' Line V2 n -> Located (Trail' Line V2 n))
-> Trail' Line V2 n
-> r
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Trail' Line V2 n
-> Point (V (Trail' Line V2 n)) (N (Trail' Line V2 n))
-> Located (Trail' Line V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Trail V2 n)) (N (Trail V2 n))
Point (V (Trail' Line V2 n)) (N (Trail' Line V2 n))
p)) (Located (Trail' Loop V2 n) -> r
g (Located (Trail' Loop V2 n) -> r)
-> (Trail' Loop V2 n -> Located (Trail' Loop V2 n))
-> Trail' Loop V2 n
-> r
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Trail' Loop V2 n
-> Point (V (Trail' Loop V2 n)) (N (Trail' Loop V2 n))
-> Located (Trail' Loop V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Trail V2 n)) (N (Trail V2 n))
Point (V (Trail' Loop V2 n)) (N (Trail' Loop V2 n))
p)) (Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc Located (Trail V2 n)
l)
  where
    p :: Point (V (Trail V2 n)) (N (Trail V2 n))
p = Located (Trail V2 n) -> Point (V (Trail V2 n)) (N (Trail V2 n))
forall a. Located a -> Point (V a) (N a)
loc Located (Trail V2 n)
l

-- | Expand a 'Trail' with the given options and radius 'r' around a given 'Trail'.
--   Expanding can be thought of as generating the loop that, when filled, represents
--   stroking the trail with a radius 'r' brush.
--
--   The cap styles applied to an outside corner can be seen here (with the original
--   trail in white and the result of 'expandTrail'' filled in green):
--
--   <<diagrams/src_Diagrams_TwoD_Offset_expandTrailExample.svg#diagram=expandTrailExample&width=600>>
--
--   Loops result in a path with an inner and outer loop:
--
--   <<diagrams/src_Diagrams_TwoD_Offset_expandLoopExample.svg#diagram=expandLoopExample&width=300>>
--
expandTrail' :: (OrderedField n, RealFloat n, RealFrac n)
             => ExpandOpts n
             -> n  -- ^ Radius of offset.  Only non-negative values allowed.
                        --   For a line this gives a loop of the offset.  For a
                        --   loop this gives two loops, the outer counter-clockwise
                        --   and the inner clockwise.
             -> Located (Trail V2 n)
             -> Path V2 n
expandTrail' :: ExpandOpts n -> n -> Located (Trail V2 n) -> Path V2 n
expandTrail' ExpandOpts n
o n
r Located (Trail V2 n)
t
  | n
r n -> n -> Bool
forall a. Ord a => a -> a -> Bool
< n
0     = String -> Path V2 n
forall a. HasCallStack => String -> a
error String
"expandTrail' with negative radius"
                -- TODO: consider just reversing the path instead of this error.
  | Bool
otherwise = (Located (Trail' Line V2 n) -> Path V2 n)
-> (Located (Trail' Loop V2 n) -> Path V2 n)
-> Located (Trail V2 n)
-> Path V2 n
forall n r.
(Located (Trail' Line V2 n) -> r)
-> (Located (Trail' Loop V2 n) -> r) -> Located (Trail V2 n) -> r
withTrailL (Located (Trail V2 n) -> Path V2 n
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Located (Trail v n) -> Path v n
pathFromLocTrail (Located (Trail V2 n) -> Path V2 n)
-> (Located (Trail' Line V2 n) -> Located (Trail V2 n))
-> Located (Trail' Line V2 n)
-> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ExpandOpts n
-> n -> Located (Trail' Line V2 n) -> Located (Trail V2 n)
forall n.
RealFloat n =>
ExpandOpts n
-> n -> Located (Trail' Line V2 n) -> Located (Trail V2 n)
expandLine ExpandOpts n
o n
r) (ExpandOpts n -> n -> Located (Trail' Loop V2 n) -> Path V2 n
forall n.
RealFloat n =>
ExpandOpts n -> n -> Located (Trail' Loop V2 n) -> Path V2 n
expandLoop ExpandOpts n
o n
r) Located (Trail V2 n)
t

expandLine :: RealFloat n => ExpandOpts n -> n -> Located (Trail' Line V2 n) -> Located (Trail V2 n)
expandLine :: ExpandOpts n
-> n -> Located (Trail' Line V2 n) -> Located (Trail V2 n)
expandLine ExpandOpts n
opts n
r ((Trail' Line V2 n -> Trail V2 n)
-> Located (Trail' Line V2 n) -> Located (Trail V2 n)
forall a b. SameSpace a b => (a -> b) -> Located a -> Located b
mapLoc Trail' Line V2 n -> Trail V2 n
forall (v :: * -> *) n. Trail' Line v n -> Trail v n
wrapLine -> Located (Trail V2 n)
t) = (n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n)
-> n
-> Point V2 n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Located (Trail V2 n)
forall n.
RealFloat n =>
(n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n)
-> n
-> Point V2 n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Located (Trail V2 n)
caps n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
cap n
r Point V2 n
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
s Point V2 n
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
e (n -> Located (Trail V2 n)
f n
r) (n -> Located (Trail V2 n)
f (n -> Located (Trail V2 n)) -> n -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ -n
r)
    where
      eps :: n
eps = ExpandOpts n
optsExpandOpts n -> Getting n (ExpandOpts n) n -> n
forall s a. s -> Getting a s a -> a
^.Getting n (ExpandOpts n) n
forall d. Lens' (ExpandOpts d) d
expandEpsilon
      offset :: n -> Located (Trail V2 n) -> [Located (Trail V2 n)]
offset n
r' = (Located (Segment Closed V2 n) -> Located (Trail V2 n))
-> [Located (Segment Closed V2 n)] -> [Located (Trail V2 n)]
forall a b. (a -> b) -> [a] -> [b]
map ((Segment Closed V2 n -> Located (Trail V2 n))
-> Located (Segment Closed V2 n) -> Located (Trail V2 n)
forall b a n.
(Transformable b, V a ~ V b, N a ~ N b, V a ~ V2, N a ~ n,
 Num n) =>
(a -> b) -> Located a -> b
bindLoc (n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
forall n.
RealFloat n =>
n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
offsetSegment n
eps n
r')) ([Located (Segment Closed V2 n)] -> [Located (Trail V2 n)])
-> (Located (Trail V2 n) -> [Located (Segment Closed V2 n)])
-> Located (Trail V2 n)
-> [Located (Trail V2 n)]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
forall n.
OrderedField n =>
Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
locatedTrailSegments
      f :: n -> Located (Trail V2 n)
f n
r' = n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
forall n.
RealFloat n =>
n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
joinSegments n
eps (LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
fromLineJoin (ExpandOpts n
optsExpandOpts n
-> Getting LineJoin (ExpandOpts n) LineJoin -> LineJoin
forall s a. s -> Getting a s a -> a
^.Getting LineJoin (ExpandOpts n) LineJoin
forall d. Lens' (ExpandOpts d) LineJoin
expandJoin)) Bool
False (ExpandOpts n
optsExpandOpts n -> Getting n (ExpandOpts n) n -> n
forall s a. s -> Getting a s a -> a
^.Getting n (ExpandOpts n) n
forall d. Lens' (ExpandOpts d) d
expandMiterLimit) n
r' [Point V2 n]
ends
           ([Located (Trail V2 n)] -> Located (Trail V2 n))
-> (Located (Trail V2 n) -> [Located (Trail V2 n)])
-> Located (Trail V2 n)
-> Located (Trail V2 n)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. n -> Located (Trail V2 n) -> [Located (Trail V2 n)]
offset n
r' (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t
      ends :: [Point V2 n]
ends = [Point V2 n] -> [Point V2 n]
forall a. [a] -> [a]
tail ([Point V2 n] -> [Point V2 n])
-> (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n)
-> [Point V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Point V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Located (Trail v n) -> [Point v n]
trailPoints (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n) -> [Point V2 n]
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t
      s :: Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
s = Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
t
      e :: Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
e = Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
t
      cap :: n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
cap = LineCap
-> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
forall n.
RealFloat n =>
LineCap
-> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
fromLineCap (ExpandOpts n
optsExpandOpts n -> Getting LineCap (ExpandOpts n) LineCap -> LineCap
forall s a. s -> Getting a s a -> a
^.Getting LineCap (ExpandOpts n) LineCap
forall d. Lens' (ExpandOpts d) LineCap
expandCap)

expandLoop :: RealFloat n => ExpandOpts n -> n -> Located (Trail' Loop V2 n) -> Path V2 n
expandLoop :: ExpandOpts n -> n -> Located (Trail' Loop V2 n) -> Path V2 n
expandLoop ExpandOpts n
opts n
r ((Trail' Loop V2 n -> Trail V2 n)
-> Located (Trail' Loop V2 n) -> Located (Trail V2 n)
forall a b. SameSpace a b => (a -> b) -> Located a -> Located b
mapLoc Trail' Loop V2 n -> Trail V2 n
forall (v :: * -> *) n. Trail' Loop v n -> Trail v n
wrapLoop -> Located (Trail V2 n)
t) = Located (Trail (V (Path V2 n)) (N (Path V2 n))) -> Path V2 n
forall t. TrailLike t => Located (Trail (V t) (N t)) -> t
trailLike (n -> Located (Trail V2 n)
f n
r) Path V2 n -> Path V2 n -> Path V2 n
forall a. Semigroup a => a -> a -> a
<> (Located (Trail V2 n) -> Path V2 n
forall t. TrailLike t => Located (Trail (V t) (N t)) -> t
trailLike (Located (Trail V2 n) -> Path V2 n)
-> (n -> Located (Trail V2 n)) -> n -> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> Located (Trail V2 n)
forall p. Sectionable p => p -> p
reverseDomain (Located (Trail V2 n) -> Located (Trail V2 n))
-> (n -> Located (Trail V2 n)) -> n -> Located (Trail V2 n)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. n -> Located (Trail V2 n)
f (n -> Path V2 n) -> n -> Path V2 n
forall a b. (a -> b) -> a -> b
$ -n
r)
    where
      eps :: n
eps = ExpandOpts n
optsExpandOpts n -> Getting n (ExpandOpts n) n -> n
forall s a. s -> Getting a s a -> a
^.Getting n (ExpandOpts n) n
forall d. Lens' (ExpandOpts d) d
expandEpsilon
      offset :: n -> Located (Trail V2 n) -> [Located (Trail V2 n)]
offset n
r' = (Located (Segment Closed V2 n) -> Located (Trail V2 n))
-> [Located (Segment Closed V2 n)] -> [Located (Trail V2 n)]
forall a b. (a -> b) -> [a] -> [b]
map ((Segment Closed V2 n -> Located (Trail V2 n))
-> Located (Segment Closed V2 n) -> Located (Trail V2 n)
forall b a n.
(Transformable b, V a ~ V b, N a ~ N b, V a ~ V2, N a ~ n,
 Num n) =>
(a -> b) -> Located a -> b
bindLoc (n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
forall n.
RealFloat n =>
n -> n -> Segment Closed V2 n -> Located (Trail V2 n)
offsetSegment n
eps n
r')) ([Located (Segment Closed V2 n)] -> [Located (Trail V2 n)])
-> (Located (Trail V2 n) -> [Located (Segment Closed V2 n)])
-> Located (Trail V2 n)
-> [Located (Trail V2 n)]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
forall n.
OrderedField n =>
Located (Trail V2 n) -> [Located (Segment Closed V2 n)]
locatedTrailSegments
      f :: n -> Located (Trail V2 n)
f n
r' = n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
forall n.
RealFloat n =>
n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
joinSegments n
eps (LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
fromLineJoin (ExpandOpts n
optsExpandOpts n
-> Getting LineJoin (ExpandOpts n) LineJoin -> LineJoin
forall s a. s -> Getting a s a -> a
^.Getting LineJoin (ExpandOpts n) LineJoin
forall d. Lens' (ExpandOpts d) LineJoin
expandJoin)) Bool
True (ExpandOpts n
optsExpandOpts n -> Getting n (ExpandOpts n) n -> n
forall s a. s -> Getting a s a -> a
^.Getting n (ExpandOpts n) n
forall d. Lens' (ExpandOpts d) d
expandMiterLimit) n
r' [Point V2 n]
ends
           ([Located (Trail V2 n)] -> Located (Trail V2 n))
-> (Located (Trail V2 n) -> [Located (Trail V2 n)])
-> Located (Trail V2 n)
-> Located (Trail V2 n)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. n -> Located (Trail V2 n) -> [Located (Trail V2 n)]
offset n
r' (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t
      ends :: [Point V2 n]
ends = (\(Point V2 n
a:[Point V2 n]
as) -> [Point V2 n]
as [Point V2 n] -> [Point V2 n] -> [Point V2 n]
forall a. [a] -> [a] -> [a]
++ [Point V2 n
a]) ([Point V2 n] -> [Point V2 n])
-> (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n)
-> [Point V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Located (Trail V2 n) -> [Point V2 n]
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Located (Trail v n) -> [Point v n]
trailPoints (Located (Trail V2 n) -> [Point V2 n])
-> Located (Trail V2 n) -> [Point V2 n]
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
t

-- | Expand a 'Trail' with the given radius and default options.  See 'expandTrail''.
expandTrail :: RealFloat n => n -> Located (Trail V2 n) -> Path V2 n
expandTrail :: n -> Located (Trail V2 n) -> Path V2 n
expandTrail = ExpandOpts n -> n -> Located (Trail V2 n) -> Path V2 n
forall n.
(OrderedField n, RealFloat n, RealFrac n) =>
ExpandOpts n -> n -> Located (Trail V2 n) -> Path V2 n
expandTrail' ExpandOpts n
forall a. Default a => a
def

-- | Expand a 'Path' using 'expandTrail'' on each trail in the path.
expandPath' :: RealFloat n => ExpandOpts n -> n -> Path V2 n -> Path V2 n
expandPath' :: ExpandOpts n -> n -> Path V2 n -> Path V2 n
expandPath' ExpandOpts n
opts n
r = [Path V2 n] -> Path V2 n
forall a. Monoid a => [a] -> a
mconcat
                   ([Path V2 n] -> Path V2 n)
-> (Path V2 n -> [Path V2 n]) -> Path V2 n -> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Located (Trail V2 n) -> Path V2 n)
-> [Located (Trail V2 n)] -> [Path V2 n]
forall a b. (a -> b) -> [a] -> [b]
map ((Located (Trail V2 n) -> Path V2 n)
-> Located (Located (Trail V2 n)) -> Path V2 n
forall b a n.
(Transformable b, V a ~ V b, N a ~ N b, V a ~ V2, N a ~ n,
 Num n) =>
(a -> b) -> Located a -> b
bindLoc (ExpandOpts n -> n -> Located (Trail V2 n) -> Path V2 n
forall n.
(OrderedField n, RealFloat n, RealFrac n) =>
ExpandOpts n -> n -> Located (Trail V2 n) -> Path V2 n
expandTrail' ExpandOpts n
opts n
r) (Located (Located (Trail V2 n)) -> Path V2 n)
-> (Located (Trail V2 n) -> Located (Located (Trail V2 n)))
-> Located (Trail V2 n)
-> Path V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Located (Trail V2 n)
-> Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
-> Located (Located (Trail V2 n))
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin))
                   ([Located (Trail V2 n)] -> [Path V2 n])
-> (Path V2 n -> [Located (Trail V2 n)])
-> Path V2 n
-> [Path V2 n]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Unwrapped (Path V2 n) -> Path V2 n)
-> Path V2 n -> Unwrapped (Path V2 n)
forall s. Wrapped s => (Unwrapped s -> s) -> s -> Unwrapped s
op Unwrapped (Path V2 n) -> Path V2 n
forall (v :: * -> *) n. [Located (Trail v n)] -> Path v n
Path

-- | Expand a 'Path' with the given radius and default options.  See 'expandPath''.
expandPath :: RealFloat n => n -> Path V2 n -> Path V2 n
expandPath :: n -> Path V2 n -> Path V2 n
expandPath = ExpandOpts n -> n -> Path V2 n -> Path V2 n
forall n.
RealFloat n =>
ExpandOpts n -> n -> Path V2 n -> Path V2 n
expandPath' ExpandOpts n
forall a. Default a => a
def

-- > import Diagrams.TwoD.Offset
-- > import Data.Default.Class
-- >
-- > expandTrailExample :: Diagram SVG
-- > expandTrailExample = pad 1.1 . centerXY . hcat' (def & sep .~ 1)
-- >                    . map (uncurry showStyle)
-- >                    $ [ (LineCapButt,   "LineCapButt")
-- >                      , (LineCapRound,  "LineCapRound")
-- >                      , (LineCapSquare, "LineCapSquare")
-- >                      ]
-- >  where
-- >    showStyle c s = centerXY (trailLike corner # lc white # lw veryThick
-- >                               <> stroke (expandTrail'
-- >                                              (def & expandJoin .~ LineJoinRound
-- >                                                   & expandCap .~ c
-- >                                                   ) 2 corner)
-- >                                      # lw none # fc green)
-- >               === (strutY 3 <> text s # font "Helvetica" # bold)
-- >
-- > expandLoopExample :: Diagram SVG
-- > expandLoopExample = pad 1.1 . centerXY $ ((strokeLocT t # lw veryThick # lc white)
-- >                                        <> (stroke t' # lw none # fc green))
-- >   where
-- >     t  = mapLoc glueTrail $ fromVertices (map p2 [(0, 0), (5, 0), (10, 5), (10, 10), (0, 0)])
-- >     t' = expandTrail' (def & expandJoin .~ LineJoinRound) 1 t


-- | When we expand a line (the original line runs through the center of offset
--   lines at  r  and  -r) there is some choice in what the ends will look like.
--   If we are using a circle brush we should see a half circle at each end.
--   Similar caps could be made for square brushes or simply stopping exactly at
--   the end with a straight line (a perpendicular line brush).
--
--   caps  takes the radius and the start and end points of the original line and
--   the offset trails going out and coming back.  The result is a new list of
--   trails with the caps included.
caps :: RealFloat n => (n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n)
     -> n -> Point V2 n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Located (Trail V2 n)
caps :: (n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n)
-> n
-> Point V2 n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Located (Trail V2 n)
caps n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
cap n
r Point V2 n
s Point V2 n
e Located (Trail V2 n)
fs Located (Trail V2 n)
bs = (Trail V2 n -> Trail V2 n)
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. SameSpace a b => (a -> b) -> Located a -> Located b
mapLoc Trail V2 n -> Trail V2 n
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Trail v n -> Trail v n
glueTrail (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ [Trail V2 n] -> Trail V2 n
forall a. Monoid a => [a] -> a
mconcat
    [ n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
cap n
r Point V2 n
s (Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
bs) (Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
fs)
    , Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc Located (Trail V2 n)
fs
    , n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
cap n
r Point V2 n
e (Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
fs) (Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
bs)
    , Trail V2 n -> Trail V2 n
forall p. Sectionable p => p -> p
reverseDomain (Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc Located (Trail V2 n)
bs)
    ] Trail V2 n
-> Point (V (Trail V2 n)) (N (Trail V2 n)) -> Located (Trail V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
bs

-- | Take a LineCap style and give a function for building the cap from
fromLineCap :: RealFloat n => LineCap -> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
fromLineCap :: LineCap
-> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
fromLineCap LineCap
c = case LineCap
c of
    LineCap
LineCapButt   -> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
forall n.
RealFloat n =>
n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capCut
    LineCap
LineCapRound  -> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
forall n.
RealFloat n =>
n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capArc
    LineCap
LineCapSquare -> n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
forall n.
RealFloat n =>
n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capSquare

-- | Builds a cap that directly connects the ends.
capCut :: RealFloat n => n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capCut :: n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capCut n
_r Point V2 n
_c Point V2 n
a Point V2 n
b = [Segment Closed (V (Trail V2 n)) (N (Trail V2 n))] -> Trail V2 n
forall t. TrailLike t => [Segment Closed (V t) (N t)] -> t
fromSegments [V2 n -> Segment Closed V2 n
forall (v :: * -> *) n. v n -> Segment Closed v n
straight (Point V2 n
b Point V2 n -> Point V2 n -> Diff (Point V2) n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> p a -> Diff p a
.-. Point V2 n
a)]

-- | Builds a cap with a square centered on the end.
capSquare :: RealFloat n => n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capSquare :: n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capSquare n
_r Point V2 n
c Point V2 n
a Point V2 n
b = Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc (Located (Trail V2 n) -> Trail V2 n)
-> Located (Trail V2 n) -> Trail V2 n
forall a b. (a -> b) -> a -> b
$ [Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))]
-> Located (Trail V2 n)
forall t. TrailLike t => [Point (V t) (N t)] -> t
fromVertices [ Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
Point V2 n
a, Point V2 n
a Point V2 n -> Diff (Point V2) n -> Point V2 n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> Diff p a -> p a
.+^ Diff (Point V2) n
V2 n
v, Point V2 n
b Point V2 n -> Diff (Point V2) n -> Point V2 n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> Diff p a -> p a
.+^ Diff (Point V2) n
V2 n
v, Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
Point V2 n
b ]
  where
    v :: V2 n
v = V2 n -> V2 n
forall a. Num a => V2 a -> V2 a
perp (Point V2 n
a Point V2 n -> Point V2 n -> Diff (Point V2) n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> p a -> Diff p a
.-. Point V2 n
c)

-- | Builds an arc to fit with a given radius, center, start, and end points.
--   A Negative r means a counter-clockwise arc
capArc :: RealFloat n => n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capArc :: n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capArc n
r Point V2 n
c Point V2 n
a Point V2 n
b = Located (Trail V2 n) -> Trail V2 n
forall t. TrailLike t => Located (Trail (V t) (N t)) -> t
trailLike (Located (Trail V2 n) -> Trail V2 n)
-> (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n)
-> Trail V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n)
forall (v :: * -> *) n t.
(InSpace v n t, HasOrigin t) =>
Point v n -> t -> t
moveTo Point V2 n
c (Located (Trail V2 n) -> Trail V2 n)
-> Located (Trail V2 n) -> Trail V2 n
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
fs
  where
    fs :: Located (Trail V2 n)
fs | n
r n -> n -> Bool
forall a. Ord a => a -> a -> Bool
< n
0     = n -> Located (Trail V2 n) -> Located (Trail V2 n)
forall (v :: * -> *) n a.
(InSpace v n a, Eq n, Fractional n, Transformable a) =>
n -> a -> a
scale (-n
r) (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ Direction V2 n -> Direction V2 n -> Located (Trail V2 n)
forall n t.
(InSpace V2 n t, RealFloat n, TrailLike t) =>
Direction V2 n -> Direction V2 n -> t
arcCW  (Point V2 n -> Point V2 n -> Direction V2 n
forall (v :: * -> *) n.
(Additive v, Num n) =>
Point v n -> Point v n -> Direction v n
dirBetween Point V2 n
c Point V2 n
a) (Point V2 n -> Point V2 n -> Direction V2 n
forall (v :: * -> *) n.
(Additive v, Num n) =>
Point v n -> Point v n -> Direction v n
dirBetween Point V2 n
c Point V2 n
b)
       | Bool
otherwise = n -> Located (Trail V2 n) -> Located (Trail V2 n)
forall (v :: * -> *) n a.
(InSpace v n a, Eq n, Fractional n, Transformable a) =>
n -> a -> a
scale n
r    (Located (Trail V2 n) -> Located (Trail V2 n))
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ Direction V2 n -> Direction V2 n -> Located (Trail V2 n)
forall n t.
(InSpace V2 n t, RealFloat n, TrailLike t) =>
Direction V2 n -> Direction V2 n -> t
arcCCW (Point V2 n -> Point V2 n -> Direction V2 n
forall (v :: * -> *) n.
(Additive v, Num n) =>
Point v n -> Point v n -> Direction v n
dirBetween Point V2 n
c Point V2 n
a) (Point V2 n -> Point V2 n -> Direction V2 n
forall (v :: * -> *) n.
(Additive v, Num n) =>
Point v n -> Point v n -> Direction v n
dirBetween Point V2 n
c Point V2 n
b)

-- | Join together a list of located trails with the given join style.  The
--   style is given as a function to compute the join given the local information
--   of the original vertex, the previous trail, and the next trail.  The result
--   is a single located trail.  A join radius is also given to aid in arc joins.
--
--   Note: this is not a general purpose join and assumes that we are joining an
--   offset trail.  For instance, a fixed radius arc will not fit between arbitrary
--   trails without trimming or extending.
joinSegments :: RealFloat n
             => n
             -> (n -> n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Trail V2 n)
             -> Bool
             -> n
             -> n
             -> [Point V2 n]
             -> [Located (Trail V2 n)]
             -> Located (Trail V2 n)
joinSegments :: n
-> (n
    -> n
    -> Point V2 n
    -> Located (Trail V2 n)
    -> Located (Trail V2 n)
    -> Trail V2 n)
-> Bool
-> n
-> n
-> [Point V2 n]
-> [Located (Trail V2 n)]
-> Located (Trail V2 n)
joinSegments n
_ n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
_ Bool
_ n
_ n
_ [Point V2 n]
_ [] = Trail V2 n
forall a. Monoid a => a
mempty Trail V2 n
-> Point (V (Trail V2 n)) (N (Trail V2 n)) -> Located (Trail V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Trail V2 n)) (N (Trail V2 n))
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin
joinSegments n
_ n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
_ Bool
_ n
_ n
_ [] [Located (Trail V2 n)]
_ = Trail V2 n
forall a. Monoid a => a
mempty Trail V2 n
-> Point (V (Trail V2 n)) (N (Trail V2 n)) -> Located (Trail V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Trail V2 n)) (N (Trail V2 n))
forall (f :: * -> *) a. (Additive f, Num a) => Point f a
origin
joinSegments n
epsilon n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
j Bool
isLoop n
ml n
r [Point V2 n]
es ts :: [Located (Trail V2 n)]
ts@(Located (Trail V2 n)
t:[Located (Trail V2 n)]
_) = Located (Trail V2 n)
t'
  where
    t' :: Located (Trail V2 n)
t' | Bool
isLoop    = (Trail V2 n -> Trail V2 n)
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. SameSpace a b => (a -> b) -> Located a -> Located b
mapLoc (Trail V2 n -> Trail V2 n
forall (v :: * -> *) n.
(Metric v, OrderedField n) =>
Trail v n -> Trail v n
glueTrail (Trail V2 n -> Trail V2 n)
-> (Trail V2 n -> Trail V2 n) -> Trail V2 n -> Trail V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Trail V2 n -> Trail V2 n -> Trail V2 n
forall a. Semigroup a => a -> a -> a
<> [Maybe (Trail V2 n)] -> Trail V2 n
f (Int -> [Maybe (Trail V2 n)] -> [Maybe (Trail V2 n)]
forall a. Int -> [a] -> [a]
take ([Located (Trail V2 n)] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length [Located (Trail V2 n)]
ts Int -> Int -> Int
forall a. Num a => a -> a -> a
* Int
2 Int -> Int -> Int
forall a. Num a => a -> a -> a
- Int
1) ([Maybe (Trail V2 n)] -> [Maybe (Trail V2 n)])
-> [Maybe (Trail V2 n)] -> [Maybe (Trail V2 n)]
forall a b. (a -> b) -> a -> b
$ [Point V2 n] -> [Located (Trail V2 n)] -> [Maybe (Trail V2 n)]
ss [Point V2 n]
es ([Located (Trail V2 n)]
ts [Located (Trail V2 n)]
-> [Located (Trail V2 n)] -> [Located (Trail V2 n)]
forall a. [a] -> [a] -> [a]
++ [Located (Trail V2 n)
t])))) Located (Trail V2 n)
t
       | Bool
otherwise = (Trail V2 n -> Trail V2 n)
-> Located (Trail V2 n) -> Located (Trail V2 n)
forall a b. SameSpace a b => (a -> b) -> Located a -> Located b
mapLoc (Trail V2 n -> Trail V2 n -> Trail V2 n
forall a. Semigroup a => a -> a -> a
<> [Maybe (Trail V2 n)] -> Trail V2 n
f ([Point V2 n] -> [Located (Trail V2 n)] -> [Maybe (Trail V2 n)]
ss [Point V2 n]
es [Located (Trail V2 n)]
ts)) Located (Trail V2 n)
t
    ss :: [Point V2 n] -> [Located (Trail V2 n)] -> [Maybe (Trail V2 n)]
ss [Point V2 n]
es' [Located (Trail V2 n)]
ts' = [[Maybe (Trail V2 n)]] -> [Maybe (Trail V2 n)]
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [[Located (Trail V2 n)
-> Located (Trail V2 n) -> Trail V2 n -> Maybe (Trail V2 n)
test Located (Trail V2 n)
a Located (Trail V2 n)
b (Trail V2 n -> Maybe (Trail V2 n))
-> Trail V2 n -> Maybe (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
j n
ml n
r Point V2 n
e Located (Trail V2 n)
a Located (Trail V2 n)
b, Trail V2 n -> Maybe (Trail V2 n)
forall a. a -> Maybe a
Just (Trail V2 n -> Maybe (Trail V2 n))
-> Trail V2 n -> Maybe (Trail V2 n)
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc Located (Trail V2 n)
b] | (Point V2 n
e,(Located (Trail V2 n)
a,Located (Trail V2 n)
b)) <- [Point V2 n]
-> [(Located (Trail V2 n), Located (Trail V2 n))]
-> [(Point V2 n, (Located (Trail V2 n), Located (Trail V2 n)))]
forall a b. [a] -> [b] -> [(a, b)]
zip [Point V2 n]
es' ([(Located (Trail V2 n), Located (Trail V2 n))]
 -> [(Point V2 n, (Located (Trail V2 n), Located (Trail V2 n)))])
-> ([Located (Trail V2 n)]
    -> [(Located (Trail V2 n), Located (Trail V2 n))])
-> [Located (Trail V2 n)]
-> [(Point V2 n, (Located (Trail V2 n), Located (Trail V2 n)))]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ([Located (Trail V2 n)]
-> [Located (Trail V2 n)]
-> [(Located (Trail V2 n), Located (Trail V2 n))]
forall a b. [a] -> [b] -> [(a, b)]
zip ([Located (Trail V2 n)]
 -> [Located (Trail V2 n)]
 -> [(Located (Trail V2 n), Located (Trail V2 n))])
-> ([Located (Trail V2 n)] -> [Located (Trail V2 n)])
-> [Located (Trail V2 n)]
-> [(Located (Trail V2 n), Located (Trail V2 n))]
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> [Located (Trail V2 n)] -> [Located (Trail V2 n)]
forall a. [a] -> [a]
tail) ([Located (Trail V2 n)]
 -> [(Point V2 n, (Located (Trail V2 n), Located (Trail V2 n)))])
-> [Located (Trail V2 n)]
-> [(Point V2 n, (Located (Trail V2 n), Located (Trail V2 n)))]
forall a b. (a -> b) -> a -> b
$ [Located (Trail V2 n)]
ts']
    test :: Located (Trail V2 n)
-> Located (Trail V2 n) -> Trail V2 n -> Maybe (Trail V2 n)
test Located (Trail V2 n)
a Located (Trail V2 n)
b Trail V2 n
tj
        | Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
b Point V2 n -> Point V2 n -> n
forall (f :: * -> *) a. (Metric f, Floating a) => f a -> f a -> a
`distance` Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
a n -> n -> Bool
forall a. Ord a => a -> a -> Bool
> n
epsilon = Trail V2 n -> Maybe (Trail V2 n)
forall a. a -> Maybe a
Just Trail V2 n
tj
        | Bool
otherwise                              = Maybe (Trail V2 n)
forall a. Maybe a
Nothing
    f :: [Maybe (Trail V2 n)] -> Trail V2 n
f = [Trail V2 n] -> Trail V2 n
forall a. Monoid a => [a] -> a
mconcat ([Trail V2 n] -> Trail V2 n)
-> ([Maybe (Trail V2 n)] -> [Trail V2 n])
-> [Maybe (Trail V2 n)]
-> Trail V2 n
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [Maybe (Trail V2 n)] -> [Trail V2 n]
forall a. [Maybe a] -> [a]
catMaybes

-- | Take a join style and give the join function to be used by joinSegments.
fromLineJoin
  :: RealFloat n => LineJoin -> n -> n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Trail V2 n
fromLineJoin :: LineJoin
-> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
fromLineJoin LineJoin
j = case LineJoin
j of
    LineJoin
LineJoinMiter -> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentIntersect
    LineJoin
LineJoinRound -> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentArc
    LineJoin
LineJoinBevel -> n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentClip

-- TODO: The joinSegmentCut option is not in our standard line joins.  I don't know
-- how useful it is graphically, I mostly had it as it was useful for debugging
{-
-- | Join with segments going back to the original corner.
joinSegmentCut :: (OrderedField n) => n -> n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Trail V2 n
joinSegmentCut _ _ e a b = fromSegments
    [ straight (e .-. atEnd a)
    , straight (atStart b .-. e)
    ]
-}

-- | Join by directly connecting the end points.  On an inside corner this
--   creates negative space for even-odd fill.  Here is where we would want to
--   use an arc or something else in the future.
joinSegmentClip :: RealFloat n
  => n -> n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Trail V2 n
joinSegmentClip :: n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentClip n
_ n
_ Point V2 n
_ Located (Trail V2 n)
a Located (Trail V2 n)
b = [Segment Closed (V (Trail V2 n)) (N (Trail V2 n))] -> Trail V2 n
forall t. TrailLike t => [Segment Closed (V t) (N t)] -> t
fromSegments [V2 n -> Segment Closed V2 n
forall (v :: * -> *) n. v n -> Segment Closed v n
straight (V2 n -> Segment Closed V2 n) -> V2 n -> Segment Closed V2 n
forall a b. (a -> b) -> a -> b
$ Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
b Point V2 n -> Point V2 n -> Diff (Point V2) n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> p a -> Diff p a
.-. Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
a]

-- | Join with a radius arc.  On an inside corner this will loop around the interior
--   of the offset trail.  With a winding fill this will not be visible.
joinSegmentArc :: RealFloat n
  => n -> n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Trail V2 n
joinSegmentArc :: n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentArc n
_ n
r Point V2 n
e Located (Trail V2 n)
a Located (Trail V2 n)
b = n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
forall n.
RealFloat n =>
n -> Point V2 n -> Point V2 n -> Point V2 n -> Trail V2 n
capArc n
r Point V2 n
e (Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
a) (Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
b)

-- | Join to the intersection of the incoming trails projected tangent to their ends.
--   If the intersection is beyond the miter limit times the radius, stop at the limit.
joinSegmentIntersect
    :: RealFloat n => n -> n -> Point V2 n -> Located (Trail V2 n) -> Located (Trail V2 n) -> Trail V2 n
joinSegmentIntersect :: n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentIntersect n
miterLimit n
r Point V2 n
e Located (Trail V2 n)
a Located (Trail V2 n)
b =
    if n
cross n -> n -> Bool
forall a. Ord a => a -> a -> Bool
< n
0.000001
      then Trail V2 n
clip
      else case Point (V (Located (Segment Closed V2 n))) n
-> V (Located (Segment Closed V2 n)) n
-> Located (Segment Closed V2 n)
-> Maybe (Point (V (Located (Segment Closed V2 n))) n)
forall n a.
(n ~ N a, Traced a, Num n) =>
Point (V a) n -> V a n -> a -> Maybe (Point (V a) n)
traceP Point (V (Located (Segment Closed V2 n))) n
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pa V (Located (Segment Closed V2 n)) n
V2 n
va Located (Segment Closed V2 n)
t of
          -- clip join when we excede the miter limit.  We could instead
          -- Join at exactly the miter limit, but standard behavior seems
          -- to be clipping.
          Maybe (Point (V (Located (Segment Closed V2 n))) n)
Nothing -> Trail V2 n
clip
          Just Point (V (Located (Segment Closed V2 n))) n
p
            -- If trace gave us garbage...
            | Point (V (Located (Segment Closed V2 n))) n
Point V2 n
p Point V2 n -> Point V2 n -> n
forall (f :: * -> *) a. (Metric f, Floating a) => f a -> f a -> a
`distance` Point V2 n
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pb n -> n -> Bool
forall a. Ord a => a -> a -> Bool
> n -> n
forall a. Num a => a -> a
abs (n
miterLimit n -> n -> n
forall a. Num a => a -> a -> a
* n
r) -> Trail V2 n
clip
            | Bool
otherwise                              -> Located (Trail V2 n) -> Trail V2 n
forall a. Located a -> a
unLoc (Located (Trail V2 n) -> Trail V2 n)
-> Located (Trail V2 n) -> Trail V2 n
forall a b. (a -> b) -> a -> b
$ [Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))]
-> Located (Trail V2 n)
forall t. TrailLike t => [Point (V t) (N t)] -> t
fromVertices [ Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pa, Point (V (Located (Segment Closed V2 n))) n
Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
p, Point (V (Located (Trail V2 n))) (N (Located (Trail V2 n)))
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pb ]
  where
    t :: Located (Segment Closed V2 n)
t = V2 n -> Segment Closed V2 n
forall (v :: * -> *) n. v n -> Segment Closed v n
straight (V2 n -> V2 n
miter V2 n
vb) Segment Closed V2 n
-> Point (V (Segment Closed V2 n)) (N (Segment Closed V2 n))
-> Located (Segment Closed V2 n)
forall a. a -> Point (V a) (N a) -> Located a
`at` Point (V (Segment Closed V2 n)) (N (Segment Closed V2 n))
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pb
    va :: V2 n
va = V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp (Point V2 n
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pa Point V2 n -> Point V2 n -> Diff (Point V2) n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> p a -> Diff p a
.-. Point V2 n
e)
    vb :: V2 n
vb = V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => f a -> f a
negated (V2 n -> V2 n) -> V2 n -> V2 n
forall a b. (a -> b) -> a -> b
$ V2 n -> V2 n
forall n. OrderedField n => V2 n -> V2 n
unitPerp (Point V2 n
Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pb Point V2 n -> Point V2 n -> Diff (Point V2) n
forall (p :: * -> *) a. (Affine p, Num a) => p a -> p a -> Diff p a
.-. Point V2 n
e)
    pa :: Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pa = Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atEnd Located (Trail V2 n)
a
    pb :: Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
pb = Located (Trail V2 n)
-> Codomain (Located (Trail V2 n)) (N (Located (Trail V2 n)))
forall p. EndValues p => p -> Codomain p (N p)
atStart Located (Trail V2 n)
b
    miter :: V2 n -> V2 n
miter V2 n
v = n -> n
forall a. Num a => a -> a
abs (n
miterLimit n -> n -> n
forall a. Num a => a -> a -> a
* n
r) n -> V2 n -> V2 n
forall (f :: * -> *) a. (Functor f, Num a) => a -> f a -> f a
*^ V2 n
v
    clip :: Trail V2 n
clip = n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
forall n.
RealFloat n =>
n
-> n
-> Point V2 n
-> Located (Trail V2 n)
-> Located (Trail V2 n)
-> Trail V2 n
joinSegmentClip n
miterLimit n
r Point V2 n
e Located (Trail V2 n)
a Located (Trail V2 n)
b
    cross :: n
cross = let (n
xa,n
ya) = V2 n -> (n, n)
forall n. V2 n -> (n, n)
unr2 V2 n
va; (n
xb,n
yb) = V2 n -> (n, n)
forall n. V2 n -> (n, n)
unr2 V2 n
vb in n -> n
forall a. Num a => a -> a
abs (n
xa n -> n -> n
forall a. Num a => a -> a -> a
* n
yb n -> n -> n
forall a. Num a => a -> a -> a
- n
xb n -> n -> n
forall a. Num a => a -> a -> a
* n
ya)