racket/collects/plot/plot2d/decoration.rkt
Neil Toronto e90ec4b69f Added unstable/latent-contract
Reorganized contracts
Started exposing customization API in plot/utils
Now dog-fooding customization API in earnest
2011-11-10 12:59:41 -07:00

303 lines
13 KiB
Racket

#lang racket/base
;; Renderers for plot decorations: axes, grids, labeled points, etc.
(require racket/contract racket/class racket/match racket/math racket/list
plot/utils
"../common/contract-doc.rkt"
"area.rkt"
"line.rkt"
"interval.rkt"
"point.rkt"
"contour.rkt"
"clip.rkt")
(provide (all-defined-out))
;; ===================================================================================================
;; X and Y axes
(define ((x-axis-render-proc y ticks? labels? far? alpha) area)
(define x-min (send area get-x-min))
(define x-max (send area get-x-max))
(define x-ticks (if far? (send area get-x-far-ticks) (send area get-x-ticks)))
(define radius (if ticks? (* 1/2 (plot-tick-size)) 0))
(send area set-alpha alpha)
(send area set-minor-pen)
(send area put-line (vector x-min y) (vector x-max y))
(when ticks?
(for ([t (in-list x-ticks)])
(match-define (tick x major? _) t)
(if major? (send area set-major-pen) (send area set-minor-pen))
(send area put-tick (vector x y) (if major? radius (* 1/2 radius)) (* 1/2 pi))))
(when labels?
(define offset (vector 0 (+ radius (pen-gap))))
(for ([t (in-list x-ticks)] #:when (pre-tick-major? t))
(match-define (tick x _ label) t)
(send area draw-text label
((if far? v- v+) (send area plot->dc (vector x y)) offset)
(if far? 'bottom 'top) 0)))
empty)
(defproc (x-axis [y real? 0]
[#:ticks? ticks? boolean? (x-axis-ticks?)]
[#:labels? labels? boolean? (x-axis-labels?)]
[#:far? far? boolean? (x-axis-far?)]
[#:alpha alpha (real-in 0 1) (x-axis-alpha)]) renderer2d?
(renderer2d #f #f #f (x-axis-render-proc y ticks? labels? far? alpha)))
(define ((y-axis-render-proc x ticks? labels? far? alpha) area)
(define y-min (send area get-y-min))
(define y-max (send area get-y-max))
(define y-ticks (if far? (send area get-y-far-ticks) (send area get-y-ticks)))
(define radius (if ticks? (* 1/2 (plot-tick-size)) 0))
(send area set-alpha alpha)
(send area set-minor-pen)
(send area put-line (vector x y-min) (vector x y-max))
(when ticks?
(for ([t (in-list y-ticks)])
(match-define (tick y major? _) t)
(if major? (send area set-major-pen) (send area set-minor-pen))
(send area put-tick (vector x y) (if major? radius (* 1/2 radius)) 0)))
(when labels?
(define offset (vector (+ radius (pen-gap)) 0))
(for ([t (in-list y-ticks)] #:when (pre-tick-major? t))
(match-define (tick y _ label) t)
(send area draw-text label
((if far? v+ v-) (send area plot->dc (vector x y)) offset)
(if far? 'left 'right) 0)))
empty)
(defproc (y-axis [x real? 0]
[#:ticks? ticks? boolean? (y-axis-ticks?)]
[#:labels? labels? boolean? (y-axis-labels?)]
[#:far? far? boolean? (y-axis-far?)]
[#:alpha alpha (real-in 0 1) (y-axis-alpha)]) renderer2d?
(renderer2d #f #f #f (y-axis-render-proc x ticks? labels? far? alpha)))
(defproc (axes [x real? 0] [y real? 0]
[#:x-ticks? x-ticks? boolean? (x-axis-ticks?)]
[#:y-ticks? y-ticks? boolean? (y-axis-ticks?)]
[#:x-labels? x-labels? boolean? (x-axis-labels?)]
[#:y-labels? y-labels? boolean? (y-axis-labels?)]
[#:x-alpha x-alpha (real-in 0 1) (x-axis-alpha)]
[#:y-alpha y-alpha (real-in 0 1) (y-axis-alpha)]) (listof renderer2d?)
(list (x-axis y #:ticks? x-ticks? #:labels? x-labels? #:alpha x-alpha)
(y-axis x #:ticks? y-ticks? #:labels? y-labels? #:alpha y-alpha)))
;; ===================================================================================================
;; Polar axes
(define (build-polar-axes num x-min x-max y-min y-max [start-θ 0])
(define step (/ (* 2 pi) num))
(define θs (build-list num (λ (n) (+ start-θ (* n step)))))
(define max-r (max (vmag (vector x-min y-min)) (vmag (vector x-min y-max))
(vmag (vector x-max y-max)) (vmag (vector x-max y-min))))
(define-values (r-mins r-maxs)
(for/lists (r-mins r-maxs) ([θ (in-list θs)])
(define-values (v1 v2)
(clip-line (vector 0 0) (vector (* max-r (cos θ)) (* max-r (sin θ)))
x-min x-max y-min y-max))
(values (if v1 (vmag v1) #f)
(if v2 (vmag v2) #f))))
(for/lists (θs r-mins r-maxs) ([θ (in-list θs)] [r-min (in-list r-mins)] [r-max (in-list r-maxs)]
#:when (and r-min r-max (not (= r-min r-max))))
(values θ r-min r-max)))
(define (draw-polar-axis-ticks num labels? area)
(define-values (x-min x-max y-min y-max) (send area get-bounds))
(define-values (θs r-mins r-maxs) (build-polar-axes num x-min x-max y-min y-max
(* 1/2 (/ (* 2 pi) num))))
(define corner-rs
(list (vmag (vector x-min y-min)) (vmag (vector x-min y-max))
(vmag (vector x-max y-max)) (vmag (vector x-max y-min))))
(define r-min (if (and (<= x-min 0 x-max) (<= y-min 0 y-max)) 0 (apply min corner-rs)))
(define r-max (apply max corner-rs))
(define ts (filter (λ (t) (not (zero? (pre-tick-value t))))
(default-r-ticks r-min r-max)))
;; Draw the tick lines
(for ([t (in-list ts)])
(match-define (tick r major? label) t)
(if major? (send area set-major-pen) (send area set-minor-pen 'long-dash))
(define pts (for/list ([θ (in-list (linear-seq 0 (* 2 pi) 500))])
(vector (* r (cos θ)) (* r (sin θ)))))
(send area put-lines pts))
;; Draw the labels
(when (and labels? (not (empty? θs)))
;; Find the longest half-axis, rounded to drown out floating-point error
(define mag (expt 10 (- (digits-for-range r-min r-max))))
(match-define (list mr-min mr-max)
(argmax (λ (lst) (* (round (/ (- (third lst) (second lst)) mag)) mag))
(map list θs r-mins r-maxs)))
;; Actually draw the labels
(for ([t (in-list ts)])
(match-define (tick r major? label) t)
(when (and major? (<= mr-min r mr-max))
(send area put-text label (vector (* r (cos )) (* r (sin )))
'center 0 #:outline? #t)))))
(define ((polar-axes-render-proc num ticks? labels? alpha) area)
(define-values (x-min x-max y-min y-max) (send area get-bounds))
(define-values (θs r-mins r-maxs) (build-polar-axes num x-min x-max y-min y-max))
;; Draw the axes
(send area set-alpha alpha)
(send area set-major-pen)
(for ([θ (in-list θs)] [r-min (in-list r-mins)] [r-max (in-list r-maxs)])
(send area put-line
(vector (* r-min (cos θ)) (* r-min (sin θ)))
(vector (* r-max (cos θ)) (* r-max (sin θ)))))
;; Draw the ticks
(when ticks? (draw-polar-axis-ticks num labels? area))
;; No legend
empty)
(defproc (polar-axes [#:number num exact-positive-integer? (polar-axes-number)]
[#:ticks? ticks? boolean? (polar-axes-ticks?)]
[#:labels? labels? boolean? (polar-axes-labels?)]
[#:alpha alpha (real-in 0 1) (polar-axes-alpha)]) renderer2d?
(renderer2d #f #f #f (polar-axes-render-proc num ticks? labels? alpha)))
;; ===================================================================================================
;; Grid
(define ((x-tick-lines-render-proc) area)
(define y-min (send area get-y-min))
(define y-max (send area get-y-max))
(define x-ticks (send area get-x-ticks))
(send area set-alpha 1/2)
(for ([t (in-list x-ticks)])
(match-define (tick x major? _) t)
(if major? (send area set-major-pen) (send area set-minor-pen 'long-dash))
(send area put-line (vector x y-min) (vector x y-max)))
empty)
(define ((y-tick-lines-render-proc) area)
(define x-min (send area get-x-min))
(define x-max (send area get-x-max))
(define y-ticks (send area get-y-ticks))
(send area set-alpha 1/2)
(for ([t (in-list y-ticks)])
(match-define (tick y major? _) t)
(if major? (send area set-major-pen) (send area set-minor-pen 'long-dash))
(send area put-line (vector x-min y) (vector x-max y)))
empty)
(defproc (x-tick-lines) renderer2d?
(renderer2d #f #f #f (x-tick-lines-render-proc)))
(defproc (y-tick-lines) renderer2d?
(renderer2d #f #f #f (y-tick-lines-render-proc)))
(defproc (tick-grid) (listof renderer2d?)
(list (x-tick-lines) (y-tick-lines)))
;; ===================================================================================================
;; Labeled points
(define (format-x-coordinate x area)
(define x-min (send area get-x-min))
(define x-max (send area get-x-max))
(format "~a" (real->plot-label x (digits-for-range x-min x-max))))
(define (format-y-coordinate y area)
(define y-min (send area get-y-min))
(define y-max (send area get-y-max))
(format "~a" (real->plot-label y (digits-for-range y-min y-max))))
(define (format-coordinate v area)
(match-define (vector x y) v)
(format "(~a,~a)" (format-x-coordinate x area) (format-y-coordinate y area)))
(define ((label-render-proc label v color size anchor angle point-size alpha) area)
(let ([label (if label label (format-coordinate v area))])
(send area set-alpha alpha)
; label
(send area set-text-foreground color)
(send area set-font-size size)
(send area put-text (string-append " " label " ") v anchor angle #:outline? #t)
; point
(send area set-pen color 1 'solid)
(send area put-glyphs (list v) 'fullcircle point-size))
empty)
(defproc (point-label
[v (vector/c real? real?)] [label (or/c string? #f) #f]
[#:color color plot-color/c (plot-foreground)]
[#:size size (>=/c 0) (plot-font-size)]
[#:anchor anchor anchor/c (label-anchor)]
[#:angle angle real? (label-angle)]
[#:point-size point-size (>=/c 0) (label-point-size)]
[#:alpha alpha (real-in 0 1) (label-alpha)]
) renderer2d?
(match-define (vector x y) v)
(renderer2d (vector (ivl x x) (ivl y y)) #f #f
(label-render-proc label v color size anchor angle point-size alpha)))
(defproc (parametric-label
[f (real? . -> . (vector/c real? real?))]
[t real?] [label (or/c string? #f) #f]
[#:color color plot-color/c (plot-foreground)]
[#:size size (>=/c 0) (plot-font-size)]
[#:anchor anchor anchor/c (label-anchor)]
[#:angle angle real? (label-angle)]
[#:point-size point-size (>=/c 0) (label-point-size)]
[#:alpha alpha (real-in 0 1) (label-alpha)]
) renderer2d?
(point-label (match f
[(vector fx fy) (vector (fx t) (fy t))]
[(? procedure?) (f t)])
label #:color color #:size size #:anchor anchor #:angle angle
#:point-size point-size #:alpha alpha))
(defproc (polar-label
[f (real? . -> . real?)] [θ real?] [label (or/c string? #f) #f]
[#:color color plot-color/c (plot-foreground)]
[#:size size (>=/c 0) (plot-font-size)]
[#:anchor anchor anchor/c (label-anchor)]
[#:angle angle real? (label-angle)]
[#:point-size point-size (>=/c 0) (label-point-size)]
[#:alpha alpha (real-in 0 1) (label-alpha)]
) renderer2d?
(point-label (polar->cartesian θ (f θ)) label
#:color color #:size size #:anchor anchor #:angle angle
#:point-size point-size #:alpha alpha))
(defproc (function-label
[f (real? . -> . real?)] [x real?] [label (or/c string? #f) #f]
[#:color color plot-color/c (plot-foreground)]
[#:size size (>=/c 0) (plot-font-size)]
[#:anchor anchor anchor/c (label-anchor)]
[#:angle angle real? (label-angle)]
[#:point-size point-size (>=/c 0) (label-point-size)]
[#:alpha alpha (real-in 0 1) (label-alpha)]
) renderer2d?
(point-label (vector x (f x)) label
#:color color #:size size #:anchor anchor #:angle angle
#:point-size point-size #:alpha alpha))
(defproc (inverse-label
[f (real? . -> . real?)] [y real?] [label (or/c string? #f) #f]
[#:color color plot-color/c (plot-foreground)]
[#:size size (>=/c 0) (plot-font-size)]
[#:anchor anchor anchor/c (label-anchor)]
[#:angle angle real? (label-angle)]
[#:point-size point-size (>=/c 0) (label-point-size)]
[#:alpha alpha (real-in 0 1) (label-alpha)]
) renderer2d?
(point-label (vector (f y) y) label
#:color color #:size size #:anchor anchor #:angle angle
#:point-size point-size #:alpha alpha))