add 'crop' as a synonym for 'rectEnvelope'

diagrams · Jun 20, 2018 · 1f863bf · 1f863bf
1 parent b501c12
commit 1f863bf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/src/Diagrams/TwoD.hs b/src/Diagrams/TwoD.hs
@@ -240,7 +240,7 @@ module Diagrams.TwoD
 
        , extrudeLeft, extrudeRight, extrudeBottom, extrudeTop
 
-       , rectEnvelope
+       , rectEnvelope, crop
 
          -- ** Background
 

diff --git a/src/Diagrams/TwoD/Combinators.hs b/src/Diagrams/TwoD/Combinators.hs
@@ -1,4 +1,4 @@
-{-# LANGUAGE ConstraintKinds #-}
+{-# LANGUAGE ConstraintKinds       #-}
 {-# LANGUAGE FlexibleContexts      #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE ScopedTypeVariables   #-}
@@ -32,7 +32,7 @@ module Diagrams.TwoD.Combinators
 
     , extrudeLeft, extrudeRight, extrudeBottom, extrudeTop
 
-    , rectEnvelope
+    , rectEnvelope, crop
 
     , boundingRect, bg, bgFrame
 
@@ -245,6 +245,11 @@ rectEnvelope :: forall b n m. (OrderedField n, Monoid' m)
      => Point V2 n -> V2 n -> QDiagram b V2 n m -> QDiagram b V2 n m
 rectEnvelope p (V2 w h) = withEnvelope (rect w h # alignBL # moveTo p :: Path V2 n)
 
+-- | A synonym for 'rectEnvelope'.
+crop :: forall b n m. (OrderedField n, Monoid' m)
+     => Point V2 n -> V2 n -> QDiagram b V2 n m -> QDiagram b V2 n m
+crop = rectEnvelope
+
 -- | Construct a bounding rectangle for an enveloped object, that is,
 --   the smallest axis-aligned rectangle which encloses the object.
 boundingRect :: ( InSpace V2 n a, SameSpace a t