Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to user manual and arrow tutorial for new arrow color lenses and other changes #41

Merged
merged 2 commits into from
Nov 16, 2013
Merged

Updates to user manual and arrow tutorial for new arrow color lenses and other changes #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f97b1a7
update manual for new arrow color lenses
Nov 14, 2013
2cc4274
add lw to example, now that ambient line width affects the shaft
Nov 14, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 32 additions & 19 deletions doc/arrow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ options used to make arrows.
> example = d # connect' (with & arrowHead .~ dart & headSize .~ 1 & arrowTail .~ quill
> & tailSize .~ 1 & shaftStyle %~ lw 0.1 . lc black & arrowShaft .~ s
> & tailGap .~ 0.1 & headGap .~ 0.1
> & headStyle %~ fc blue & tailStyle %~ fc orange)
> & headColor .~ blue & tailColor .~ orange)
> "1" "2"
> # connect' (with & arrowHead .~ missile & headSize .~ 0.8 & arrowTail .~ missile'
> & tailSize .~ 0.8 & shaftStyle %~ lw 0.05 & arrowShaft .~ s1
Expand All @@ -41,12 +41,12 @@ options used to make arrows.
> "1" "6"
> # connect' (with & arrowHead .~ dart & tailSize .~ 1 & arrowTail .~ dart'
> & headSize .~ 1 & arrowShaft .~ s2
> & headStyle %~ fc green & tailStyle %~ fc green
> & headColor .~ green & tailColor .~ green
> & shaftStyle %~ lw 0.1 . lc green )
> "4" "7"
> # connect' (with & arrowTail .~ dart' & tailSize .~ 1 & arrowShaft .~ a
> & arrowHead .~ spike & headSize .~ 1 & headStyle %~ fc red
> & tailGap .~ 0.1 & tailStyle %~ fc red
> & arrowHead .~ spike & headSize .~ 1 & headColor .~ red
> & tailGap .~ 0.1 & tailColor .~ red
> & shaftStyle %~ lw 0.2 . lc blue )
> "9" "5"
> # connect' (with & arrowHead .~ tri & arrowTail .~ block
Expand Down Expand Up @@ -377,26 +377,32 @@ The style options
-----------------

By default, arrows are drawn using the current line color (including
the head and tail). For example:
the head and tail). In addition, the shaft styling is taken from the
current line styling attributes. For example:

.. class:: dia-lhs

::

> example = square 1 <> arrowAt origin unitX # lc blue # centerXY
> example = mconcat
> [ square 2
> , arrowAt origin unitX
> # lc blue
> ]
> # dashing [0.05, 0.05] 0
> # lw 0.03

The styles of the head, tail and shaft may be individually overridden
using `headStyle`, `tailStyle`, and `shaftStyle`. We change the
attributes of the arrow parts by setting one of these parameters equal
to a function that applies the attributes, *e.g.* `headStyle = fc
blue` or `tailStyle = fc orange . opacity 0.5`.
The colors of the head, tail, and shaft may be individually overridden
using `headColor`, `tailColor`, and `shaftColor`. More generally, the
styles are controlled using `headStyle`, `tailStyle`, and
`shaftStyle`. For example:

.. class:: lhs

::

> dashedArrow = arrowBetween' (with & arrowHead .~ dart & arrowTail .~ spike'
> & headStyle %~ fc blue & tailStyle %~ fc orange
> & headColor .~ blue & tailColor .~ orange
> & shaftStyle %~ dashing [0.04, 0.02] 0
> . lw 0.01) sPt ePt
>
Expand All @@ -413,17 +419,24 @@ blue` or `tailStyle = fc orange . opacity 0.5`.
> eDot = dot # fc red # moveTo ePt
>
> arrow1 = arrowBetween' (with & arrowHead .~ dart & arrowTail .~ spike'
> & headStyle %~ fc blue & tailStyle %~ fc orange
> & headColor .~ blue & tailColor .~ orange
> & shaftStyle %~ dashing [0.04, 0.02] 0 . lw 0.01
> ) sPt ePt
>
> example = (sDot <> eDot <> arrow1) # centerXY # pad 1.1

Note that when setting a style, one must generally use the `%~`
operator in order to apply something like `dashing [0.04, 0.02] 0`
which is a *function* that changes the style.

.. container:: warning

When setting the color of the head or tail use `fillColor`, `fc`, or
`fcA`.. When setting the color of the shaft use `lineColor`, `lc`,
or `lcA`.
By default, the ambient line color is used for the head, tail, and
shaft of an arrow. However, when setting the styles individually,
the fill color should be used for the head and tail, and line color
for the shaft. This issue can be avoided entirely by using, for
example, `headColor .~ blue` to set the color instead of `headStyle
%~ fc blue`.

Placing an arrow at a point
===========================
Expand Down Expand Up @@ -550,15 +563,15 @@ straightforward.
>
> arrowStyle1 = (with & arrowHead .~ noHead & tailSize .~ 0.3
> & arrowShaft .~ shaft & arrowTail .~ spike'
> & tailStyle %~ fc black . opacity 1)
> & tailColor .~ black)
>
> arrowStyle2 = (with & arrowHead .~ noHead & tailSize .~ 0.3
> & arrowShaft .~ shaft' & arrowTail .~ spike'
> & tailStyle %~ fc black . opacity 1)
> & tailColor .~ black)
>
> arrowStyle3 = (with & arrowHead .~ noHead & tailSize .~ 0.3
> & arrowShaft .~ line & arrowTail .~ spike'
> & tailStyle %~ fc black . opacity 1)
> & tailColor .~ black)
>
> example = states # connectPerim' arrowStyle1
> "2" "1" (5/12 :: Turn) (1/12 :: Turn)
Expand Down
12 changes: 7 additions & 5 deletions doc/manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2805,8 +2805,10 @@ to `connect` is `connect'`. These companion functions take an extra

* `headStyle`, `tailStyle` and `shaftStyle` are used to pass in style
functions like `fc blue . opacity 0.75` to customize parts of the
arrow. (By default, the entire arrow, including head and tail, is
drawn using the current line color.)
arrow. `headColor`, `tailColor` and `shaftColor` can be used for the
common case of setting just the color. (By default, the entire
arrow, including head and tail, is drawn using the current line
color.)

The following example demonstrates the use of various `ArrowOpts`.

Expand All @@ -2831,16 +2833,16 @@ The following example demonstrates the use of various `ArrowOpts`.
>
> example = d
> # connect' (with & arrowTail .~ quill& tailSize .~ 1.5
> & tailStyle %~ fc orange & headStyle %~ fc orange
> & arrowHead .~ spike& headSize .~ 1.5
> & tailColor .~ orange & headColor .~ orange
> & arrowHead .~ spike & headSize .~ 1.5
> & shaftStyle %~ lw 0.3 ) "1" "2"
> # connect' (with & arrowTail .~ thorn'& tailSize .~ 1.5
> & arrowHead .~ thorn & headSize .~ 1.5
> & arrowShaft .~ shaft1 & shaftStyle %~ lw 0.15 ) "3" "4"
> # connect' (with & arrowTail .~ block & tailSize .~ 1& tailGap .~ 0.4
> & arrowHead .~ missile & headSize .~ 1.5& headGap .~ 0.4
> & arrowShaft .~ shaft2
> & headStyle %~ fc blue & tailStyle %~ fc blue
> & headColor .~ blue & tailColor .~ blue
> & shaftStyle %~ lw 0.15 . lc blue ) "5" "6"
> # connect' (with & arrowShaft .~ shaft3
> & arrowHead .~ tri & headSize .~ 1.5
Expand Down