suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix docs for methods that accept a list of pairs as points

Browse Source
This commit is contained in:
Matthew Flatt 2011-02-09 14:21:04 -07:00
parent 4b1960e1f0
commit 2d7dfab9b9
3 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
collects/scribblings/draw/dc-intf.scrbl
View File

@ -214,13 +214,16 @@ See also @method[dc<%> set-smoothing] for information on the
} }
@defmethod[(draw-lines [points (listof (is-a?/c point%))] @defmethod[(draw-lines [points (or/c (listof (is-a?/c point%))
(listof (cons/c real? real?)))]
[xoffset real? 0] [xoffset real? 0]
[yoffset real? 0]) [yoffset real? 0])
void?]{ void?]{
Draws lines using a list of @scheme[points], adding @scheme[xoffset] Draws lines using a list @scheme[points] of points, adding @scheme[xoffset]
and @scheme[yoffset] to each point. The current pen is used for and @scheme[yoffset] to each point. A pair is treated as a point where the
@racket[car] of the pair is the x-value and the @racket[cdr] is the y-value.
The current pen is used for
drawing the lines. drawing the lines.
See also @method[dc<%> set-smoothing] for information on the See also @method[dc<%> set-smoothing] for information on the
@ -274,14 +277,18 @@ Plots a single point using the current pen.
} }
@defmethod[(draw-polygon [points (listof (is-a?/c point%))] @defmethod[(draw-polygon [points (or/c (listof (is-a?/c point%))
(listof (cons/c real? real?)))]
[xoffset real? 0] [xoffset real? 0]
[yoffset real? 0] [yoffset real? 0]
[fill-style (one-of/c 'odd-even 'winding) 'odd-even]) [fill-style (one-of/c 'odd-even 'winding) 'odd-even])
void?]{ void?]{
Draw a filled polygon using a list of @scheme[points], adding Draw a filled polygon using a list @scheme[points] of points, adding
@scheme[xoffset] and @scheme[yoffset] to each point. The polygon is @scheme[xoffset] and @scheme[yoffset] to each point.
A pair is treated as a point where the
@racket[car] of the pair is the x-value and the @racket[cdr] is the y-value.
The polygon is
automatically closed, so the first and last point can be automatically closed, so the first and last point can be
different. The current pen is used for drawing the outline, and the different. The current pen is used for drawing the outline, and the
current brush for filling the shape. current brush for filling the shape.

7
collects/scribblings/draw/dc-path-class.scrbl
View File

@ -142,13 +142,16 @@ Extends the path's @tech{open sub-path} with a line to the given
} }
@defmethod[(lines [points (listof (is-a?/c point%))] @defmethod[(lines [points (or/c (listof (is-a?/c point%))
(listof (cons/c real? real?)))]
[xoffset real? 0] [xoffset real? 0]
[yoffset real? 0]) [yoffset real? 0])
void?]{ void?]{
Extends the path's @tech{open sub-path} with a sequences of lines to Extends the path's @tech{open sub-path} with a sequences of lines to
the given points. If the path has no @tech{open sub-path}, the given points. A pair is treated as a point where the @racket[car]
of the pair is the x-value and the @racket[cdr] is the y-value.
If the path has no @tech{open sub-path},
@|MismatchExn|. (This convenience method is implemented in terms of @|MismatchExn|. (This convenience method is implemented in terms of
@method[dc-path% line-to].) @method[dc-path% line-to].)

8
collects/scribblings/draw/region-class.scrbl
View File

@ -150,12 +150,16 @@ The fill style affects how well the region reliably combines with
} }
@defmethod[(set-polygon [points (listof (is-a?/c point%))] @defmethod[(set-polygon [points (or/c (listof (is-a?/c point%))
(listof (cons/c real? real?)))]
[xoffset real? 0] [xoffset real? 0]
[yoffset real? 0] [yoffset real? 0]
[fill-style (one-of/c 'odd-even 'winding) 'odd-even]) [fill-style (one-of/c 'odd-even 'winding) 'odd-even])
void?]{ void?]{
Sets the region to the interior of the specified polygon.
Sets the region to the interior of the polygon specified by
@racket[points]. A pair is treated as a point where the @racket[car]
of the pair is the x-value and the @racket[cdr] is the y-value.
See also @xmethod[dc<%> draw-polygon], since the region content is See also @xmethod[dc<%> draw-polygon], since the region content is
determined the same way as brush-based filling in a @scheme[dc<%>]. determined the same way as brush-based filling in a @scheme[dc<%>].