diff --git a/CHANGELOG.md b/CHANGELOG.md
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
# Change Log
+## 0.2.0.0 - 2015-06-01
+
+- Generalized numeric type `n` in `Diagrams.RubiksCube.Draw` (from `Double`)
+- Implemented arrows for moves of back side.
+
## 0.1.1.0 - 2015-05-01
- Added change log
diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
-# diagrams-rubiks-cube [![Hackage version][hackage-image]][hackage-url] [![Hackage dependencies][hackage-deps-image]][hackage-deps-url]
+# diagrams-rubiks-cube
+[![Hackage version][hackage-image]][hackage-url] [![Hackage dependencies][hackage-deps-image]][hackage-deps-url] [![Travis Status][travis-image]][travis-url]
+
Haskell library for drawing the Rubik's Cube.
![Move sequence][moves-image]
@@ -14,6 +16,8 @@
See the docs on [Hackage][hackage-url].
+[travis-image]: https://travis-ci.org/timjb/diagrams-rubiks-cube.svg?branch=master
+[travis-url]: https://travis-ci.org/timjb/diagrams-rubiks-cube
[moves-image]: https://cdn.rawgit.com/timjb/diagrams-rubiks-cube/master/diagrams/src_Diagrams_RubiksCube_Draw_drawMovesExample.svg
[hackage-image]: https://img.shields.io/hackage/v/diagrams-rubiks-cube.svg?style=flat
[hackage-url]: http://hackage.haskell.org/package/diagrams-rubiks-cube
diff --git a/diagrams-rubiks-cube.cabal b/diagrams-rubiks-cube.cabal
--- a/diagrams-rubiks-cube.cabal
+++ b/diagrams-rubiks-cube.cabal
@@ -1,5 +1,5 @@
name: diagrams-rubiks-cube
-version: 0.1.1.0
+version: 0.2.0.0
synopsis: Library for drawing the Rubik's Cube.
description: Includes a facets model of the Rubik's Cube and a 'diagrams'-based renderer.
homepage: https://github.com/timjb/rubiks-cube
diff --git a/diagrams/src_Diagrams_RubiksCube_Draw_drawCubeExample.svg b/diagrams/src_Diagrams_RubiksCube_Draw_drawCubeExample.svg
--- a/diagrams/src_Diagrams_RubiksCube_Draw_drawCubeExample.svg
+++ b/diagrams/src_Diagrams_RubiksCube_Draw_drawCubeExample.svg
@@ -1,4 +1,3 @@
-
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
diff --git a/diagrams/src_Diagrams_RubiksCube_Draw_drawMoveExample.svg b/diagrams/src_Diagrams_RubiksCube_Draw_drawMoveExample.svg
--- a/diagrams/src_Diagrams_RubiksCube_Draw_drawMoveExample.svg
+++ b/diagrams/src_Diagrams_RubiksCube_Draw_drawMoveExample.svg
@@ -1,4 +1,3 @@
-
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
diff --git a/diagrams/src_Diagrams_RubiksCube_Draw_drawMovesExample.svg b/diagrams/src_Diagrams_RubiksCube_Draw_drawMovesExample.svg
--- a/diagrams/src_Diagrams_RubiksCube_Draw_drawMovesExample.svg
+++ b/diagrams/src_Diagrams_RubiksCube_Draw_drawMovesExample.svg
@@ -1,4 +1,3 @@
-
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
diff --git a/diagrams/src_Diagrams_RubiksCube_Draw_drawSideDia.svg b/diagrams/src_Diagrams_RubiksCube_Draw_drawSideDia.svg
--- a/diagrams/src_Diagrams_RubiksCube_Draw_drawSideDia.svg
+++ b/diagrams/src_Diagrams_RubiksCube_Draw_drawSideDia.svg
@@ -1,4 +1,3 @@
-
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
diff --git a/diagrams/src_Diagrams_RubiksCube_Draw_offsetsDia.svg b/diagrams/src_Diagrams_RubiksCube_Draw_offsetsDia.svg
--- a/diagrams/src_Diagrams_RubiksCube_Draw_offsetsDia.svg
+++ b/diagrams/src_Diagrams_RubiksCube_Draw_offsetsDia.svg
@@ -1,4 +1,3 @@
-
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
diff --git a/diagrams/src_Diagrams_RubiksCube_Draw_solvedCube.svg b/diagrams/src_Diagrams_RubiksCube_Draw_solvedCube.svg
--- a/diagrams/src_Diagrams_RubiksCube_Draw_solvedCube.svg
+++ b/diagrams/src_Diagrams_RubiksCube_Draw_solvedCube.svg
@@ -1,4 +1,3 @@
-
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
diff --git a/src/Diagrams/RubiksCube/Draw.hs b/src/Diagrams/RubiksCube/Draw.hs
--- a/src/Diagrams/RubiksCube/Draw.hs
+++ b/src/Diagrams/RubiksCube/Draw.hs
@@ -3,6 +3,7 @@
{-# LANGUAGE Rank2Types #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE ConstraintKinds #-}
+{-# LANGUAGE ScopedTypeVariables #-}
module Diagrams.RubiksCube.Draw
( RubiksCubeBackend
@@ -21,12 +22,15 @@
import Control.Lens hiding ((#))
import Diagrams.Prelude hiding (center, cube)
+import Diagrams.TwoD.Arrow (arrowFromLocatedTrail')
+import Diagrams.Trail (trailPoints)
import Data.List (sortBy, mapAccumL)
import Data.Function (on)
import qualified Diagrams.Prelude as P
-type RubiksCubeBackend b = (Renderable (Path V2 Double) b, N b ~ Double, V b ~ V2)
+type RubiksCubeBackend n b = (Renderable (Path V2 n) b, TypeableFloat n, N b ~ n, V b ~ V2)
+-- > {-# LANGUAGE FlexibleContexts, TypeFamilies #-}
-- > import Diagrams.RubiksCube.Draw
-- > solvedCube = drawFoldingPattern solvedRubiksCube
@@ -43,6 +47,7 @@
u = pure green
d = pure blue
+-- > {-# LANGUAGE FlexibleContexts, TypeFamilies #-}
-- > import Diagrams.RubiksCube
-- > drawSideDia =
-- > let side = drawSide (r2 (1,0)) (r2 (0,1)) (pure yellow & topLeft .~ green)
@@ -56,22 +61,22 @@
--
-- <>
drawSide
- :: RubiksCubeBackend b
- => V2 Double -- ^ dx
- -> V2 Double -- ^ dy
+ :: RubiksCubeBackend n b
+ => V2 n -- ^ dx
+ -> V2 n -- ^ dy
-> Side (Colour Double)
-> Diagram b
-drawSide dx dy side = mconcat $ do
+drawSide (dx :: V2 n) dy side = mconcat $ do
(y, row) <- count rows
let Vec3 l c r = side ^. row
[drawField 0 y l, drawField 1 y c, drawField 2 y r]
where
count = zip [(0 :: Int)..]
rows = [bottomRow, middleRow, topRow]
- pos :: Int -> Int -> Point V2 Double
+ pos :: Int -> Int -> Point V2 n
pos x y = P $ fromIntegral x *^ dx ^+^ fromIntegral y *^ dy
drawField
- :: (Renderable (Path V2 Double) b, N b ~ Double, V b ~ V2)
+ :: (RealFloat n, Renderable (Path V2 n) b, N b ~ n, V b ~ V2)
=> Int -> Int -> Colour Double -> Diagram b
drawField x y color =
fromVertices [pos x y, pos (x+1) y, pos (x+1) (y+1), pos x (y+1), pos x y]
@@ -80,7 +85,7 @@
-- | Draw the folding pattern of the cube. The front side is at the center of
-- the pattern.
drawFoldingPattern
- :: RubiksCubeBackend b
+ :: RubiksCubeBackend n b
=> RubiksCube (Colour Double)
-> Diagram b
drawFoldingPattern c' =
@@ -95,6 +100,7 @@
, drawSide' (c ^. backSide)
]
+-- > {-# LANGUAGE FlexibleContexts, TypeFamilies #-}
-- > import Diagrams.RubiksCube
-- > offsetsDia =
-- > let off = Offsets 2 1
@@ -113,28 +119,29 @@
-- > in mconcat [c, oxArrow, oxLabel, oyArrow, oyLabel, lines] # pad 1.1
-- | <>
-data Offsets =
- Offsets { _offsetX :: Double
- , _offsetY :: Double
+data Offsets n =
+ Offsets { _offsetX :: n
+ , _offsetY :: n
} deriving (Show, Eq, Read)
makeLenses ''Offsets
-instance Default Offsets where
+instance Fractional n => Default (Offsets n) where
def = Offsets 0.3 0.35
-- | Draw the Rubik's cube in parallel perspective.
--
-- <>
--
+-- > {-# LANGUAGE FlexibleContexts, TypeFamilies #-}
-- > import Diagrams.RubiksCube
-- > import Control.Lens
-- > drawCubeExample =
-- > let c = solvedRubiksCube ^. undoMoves [R,U,R',U']
-- > in drawRubiksCube with c
drawRubiksCube
- :: RubiksCubeBackend b
- => Offsets
+ :: RubiksCubeBackend n b
+ => Offsets n
-> RubiksCube (Colour Double)
-> Diagram b
drawRubiksCube (Offsets dx dy) c' = position $
@@ -160,29 +167,33 @@
d = (p2 (3*dx, 3*dy), drawSide' dx' (-dz') downSide)
moveArrow
- :: RubiksCubeBackend b
- => Bool -> P2 Double -> P2 Double -> Diagram b
-moveArrow rev s e =
- (if rev then arrowBetween' opts e s else arrowBetween' opts s e) # lc red
- where opts = with & shaftStyle %~ lw ultraThick & headLength .~ veryLarge
+ :: RubiksCubeBackend n b
+ => Bool -> [P2 n] -> Diagram b
+moveArrow rev points =
+ lc red $ arrowFromLocatedTrail' opts $ fromVertices $
+ if rev then reverse points else points
+ where opts = with & shaftStyle %~ lw ultraThick
+ & headLength .~ veryLarge
+ & tailLength .~ veryLarge
+ & arrowTail .~ lineTail
-drawMoveU, drawMoveD, drawMoveL, drawMoveR, drawMoveF
- :: RubiksCubeBackend b
+drawMoveU, drawMoveD, drawMoveL, drawMoveR, drawMoveF, drawMoveB
+ :: RubiksCubeBackend n b
=> Bool -- ^ invert
- -> Offsets
+ -> Offsets n
-> RubiksCube (Colour Double)
-> Diagram b
drawMoveU rev off c =
- atop (moveArrow rev (p2 (2.8, 2.5)) (p2 (0.2, 2.5)))
+ atop (moveArrow rev [p2 (2.8, 2.5), p2 (0.2, 2.5)])
(drawRubiksCube off c)
drawMoveD rev (Offsets dx dy) c =
- atop (moveArrow rev (p2 (0.2, 0.5)) (p2 (2.8, 0.5)))
+ atop (moveArrow rev [p2 (0.2, 0.5), p2 (2.8, 0.5)])
(drawRubiksCube (Offsets dx (-dy)) c)
-drawMoveL rev (Offsets dx dy) c =
- atop (moveArrow rev (p2 (0.5, 2.8)) (p2 (0.5, 0.2)))
- (drawRubiksCube (Offsets dx dy) c)
+drawMoveL rev off c =
+ atop (moveArrow rev [p2 (0.5, 2.8), p2 (0.5, 0.2)])
+ (drawRubiksCube off c)
drawMoveR rev off c =
- atop (moveArrow rev (p2 (2.5, 0.2)) (p2 (2.5, 2.8)))
+ atop (moveArrow rev [p2 (2.5, 0.2), p2 (2.5, 2.8)])
(drawRubiksCube off c)
drawMoveF rev off c =
arr (opts & arrowShaft .~ quarterTurn') (p2 (1.5, 2.6)) (p2 (2.5, 1.3))
@@ -195,21 +206,29 @@
opts = with & shaftStyle %~ lw ultraThick & headLength .~ veryLarge
arr opts' s e = (if rev then arrowBetween' opts' e s else arrowBetween' opts' s e)
# lc red
+drawMoveB rev off@(Offsets dx dy) c =
+ moveArrow rev (trailPoints arrowTrail)
+ `atop`
+ drawRubiksCube off c
+ where backOff = p2 (3.3 + 3 * dx, 0.2 + 3 * dy)
+ arrowOffsets = [(0 ^& 3.1), ((-3.1) ^& 0)]
+ arrowTrail = P.at (fromOffsets arrowOffsets) backOff
-- | Draw the Rubik's cube in parallel perspective with an arrow indicating the
-- next move. If the the bottom layer is moved, the cube will be shown from below.
--
-- <>
--
+-- > {-# LANGUAGE FlexibleContexts, TypeFamilies #-}
-- > import Diagrams.RubiksCube
-- > import Control.Lens
-- > drawMoveExample =
-- > let c = solvedRubiksCube ^. undoMoves [L,U,L',U']
-- > in drawMove L with c
drawMove
- :: RubiksCubeBackend b
+ :: RubiksCubeBackend n b
=> Move
- -> Offsets
+ -> Offsets n
-> RubiksCube (Colour Double)
-> Diagram b
drawMove U = drawMoveU False
@@ -222,34 +241,36 @@
drawMove R' = drawMoveR True
drawMove F = drawMoveF False
drawMove F' = drawMoveF True
-drawMove _ = error "can't draw back moves!"
+drawMove B = drawMoveB False
+drawMove B' = drawMoveB True
-data MovesSettings =
- MovesSettings { _moveSep :: Double -- ^ space between cubes
+data MovesSettings n =
+ MovesSettings { _moveSep :: n -- ^ space between cubes
, _showStart :: Bool -- ^ show the start configuration?
, _showEnd :: Bool -- ^ show the end configuration?
- , _offsets :: Offsets
+ , _offsets :: Offsets n
} deriving (Eq, Show, Read)
makeLenses ''MovesSettings
-instance Default MovesSettings where
+instance Fractional n => Default (MovesSettings n) where
def = MovesSettings 1.75 False True def
-- | Draws a sequence of moves.
--
-- <>
--
+-- > {-# LANGUAGE FlexibleContexts, TypeFamilies #-}
-- > import Diagrams.RubiksCube
-- > import Control.Lens
-- > drawMovesExample =
--- > let moves = [R, F', R', D', F, F]
+-- > let moves = [B, R, F', R', D', F, F]
-- > startPos = solvedRubiksCube ^. undoMoves moves
-- > settings = with & showStart .~ True
-- > in drawMoves settings startPos moves
drawMoves
- :: RubiksCubeBackend b
- => MovesSettings
+ :: RubiksCubeBackend n b
+ => MovesSettings n
-> RubiksCube (Colour Double) -- ^ the start configuration
-> [Move]
-> Diagram b
@@ -271,13 +292,13 @@
-- > import Diagrams.RubiksCube
-- > import Control.Lens
-- > drawMovesExample' =
--- > let moves = [R, F', R', D', F, F]
+-- > let moves = [B, R, F', R', D', F, F]
-- > endPos = solvedRubiksCube
-- > settings = with & showStart .~ True
-- > in drawMovesBackward settings endPos moves
drawMovesBackward
- :: RubiksCubeBackend b
- => MovesSettings
+ :: RubiksCubeBackend n b
+ => MovesSettings n
-> RubiksCube (Colour Double) -- ^ the end configuration
-> [Move]
-> Diagram b