-
-
Notifications
You must be signed in to change notification settings - Fork 303
/
helpers.jl
466 lines (373 loc) · 14.5 KB
/
helpers.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
"""
Shorthand for `isnothing(optional) ? fallback : optional`
"""
@inline ifnothing(optional, fallback) = isnothing(optional) ? fallback : optional
function round_to_IRect2D(r::Rect{2})
newori = round.(Int, minimum(r))
othercorner = round.(Int, maximum(r))
newwidth = othercorner .- newori
Rect{2, Int}(newori, newwidth)
end
function sceneareanode!(finalbbox, limits, aspect)
scenearea = Node(IRect(0, 0, 100, 100))
onany(finalbbox, limits, aspect) do bbox, limits, aspect
w = width(bbox)
h = height(bbox)
# as = mw / mh
as = w / h
mw, mh = w, h
if aspect isa AxisAspect
aspect = aspect.aspect
elseif aspect isa DataAspect
aspect = limits.widths[1] / limits.widths[2]
end
if !isnothing(aspect)
if as >= aspect
# too wide
mw *= aspect / as
else
# too high
mh *= as / aspect
end
end
restw = w - mw
resth = h - mh
# l = left(bbox) + alignment[1] * restw
# b = bottom(bbox) + alignment[2] * resth
l = left(bbox) + 0.5f0 * restw
b = bottom(bbox) + 0.5f0 * resth
newbbox = BBox(l, l + mw, b, b + mh)
# only update scene if pixel positions change
new_scenearea = round_to_IRect2D(newbbox)
if new_scenearea != scenearea[]
scenearea[] = new_scenearea
end
end
scenearea
end
function roundedrectvertices(rect, cornerradius, cornersegments)
cr = cornerradius
csegs = cornersegments
cr = min(width(rect) / 2, height(rect) / 2, cr)
# inner corners
ictl = topleft(rect) .+ Point2(cr, -cr)
ictr = topright(rect) .+ Point2(-cr, -cr)
icbl = bottomleft(rect) .+ Point2(cr, cr)
icbr = bottomright(rect) .+ Point2(-cr, cr)
# check if corners touch so we can remove one vertex that is doubled
wtouching = width(rect) / 2 == cr
htouching = height(rect) / 2 == cr
cstr = if wtouching
anglepoint.(Ref(ictr), LinRange(0, pi/2, csegs), cr)
else
anglepoint.(Ref(ictr), LinRange(0, pi/2, csegs)[1:end-1], cr)
end
cstl = if htouching
anglepoint.(Ref(ictl), LinRange(pi/2, pi, csegs), cr)
else
anglepoint.(Ref(ictl), LinRange(pi/2, pi, csegs)[1:end-1], cr)
end
csbl = if wtouching
anglepoint.(Ref(icbl), LinRange(pi, 3pi/2, csegs), cr)
else
anglepoint.(Ref(icbl), LinRange(pi, 3pi/2, csegs)[1:end-1], cr)
end
csbr = if htouching
anglepoint.(Ref(icbr), LinRange(3pi/2, 2pi, csegs), cr)
else
anglepoint.(Ref(icbr), LinRange(3pi/2, 2pi, csegs)[1:end-1], cr)
end
arr = [cstr; cstl; csbl; csbr]
end
"""
tightlimits!(la::Axis)
Sets the autolimit margins to zero on all sides.
"""
function tightlimits!(la::Axis)
la.xautolimitmargin = (0, 0)
la.yautolimitmargin = (0, 0)
autolimits!(la)
end
"""
tightlimits!(la::Axis, sides::Union{Left, Right, Bottom, Top}...)
Sets the autolimit margins to zero on all given sides.
Example:
```
tightlimits!(laxis, Bottom())
```
"""
function tightlimits!(la::Axis, sides::Union{Left, Right, Bottom, Top}...)
for s in sides
tightlimits!(la, s)
end
end
function tightlimits!(la::Axis, ::Left)
la.xautolimitmargin = Base.setindex(la.xautolimitmargin[], 0.0, 1)
autolimits!(la)
end
function tightlimits!(la::Axis, ::Right)
la.xautolimitmargin = Base.setindex(la.xautolimitmargin[], 0.0, 2)
autolimits!(la)
end
function tightlimits!(la::Axis, ::Bottom)
la.yautolimitmargin = Base.setindex(la.yautolimitmargin[], 0.0, 1)
autolimits!(la)
end
function tightlimits!(la::Axis, ::Top)
la.yautolimitmargin = Base.setindex(la.yautolimitmargin[], 0.0, 2)
autolimits!(la)
end
"""
layoutscene(padding = 30; kwargs...)
Create a `Scene` in `campixel!` mode and a `GridLayout` aligned to the scene's pixel area with `alignmode = Outside(padding)`.
"""
function layoutscene(padding = 30; inspectable = false, kwargs...)
scene = Scene(; camera = campixel!, inspectable = inspectable, kwargs...)
gl = GridLayout(scene, alignmode = Outside(padding))
scene, gl
end
"""
layoutscene(nrows::Int, ncols::Int, padding = 30; kwargs...)
Create a `Scene` in `campixel!` mode and a `GridLayout` aligned to the scene's pixel area with size `nrows` x `ncols` and `alignmode = Outside(padding)`.
"""
function layoutscene(nrows::Int, ncols::Int, padding = 30; inspectable = false, kwargs...)
scene = Scene(; camera = campixel!, inspectable = inspectable, kwargs...)
gl = GridLayout(scene, nrows, ncols, alignmode = Outside(padding))
scene, gl
end
GridLayoutBase.GridLayout(scene::Scene, args...; kwargs...) = GridLayout(args...; bbox = lift(x -> FRect2D(x), pixelarea(scene)), kwargs...)
function axislines!(scene, rect, spinewidth, topspinevisible, rightspinevisible,
leftspinevisible, bottomspinevisible, topspinecolor, leftspinecolor,
rightspinecolor, bottomspinecolor)
bottomline = lift(rect, spinewidth) do r, sw
y = bottom(r)
p1 = Point2(left(r) - 0.5sw, y)
p2 = Point2(right(r) + 0.5sw, y)
[p1, p2]
end
leftline = lift(rect, spinewidth) do r, sw
x = left(r)
p1 = Point2(x, bottom(r) - 0.5sw)
p2 = Point2(x, top(r) + 0.5sw)
[p1, p2]
end
topline = lift(rect, spinewidth) do r, sw
y = top(r)
p1 = Point2(left(r) - 0.5sw, y)
p2 = Point2(right(r) + 0.5sw, y)
[p1, p2]
end
rightline = lift(rect, spinewidth) do r, sw
x = right(r)
p1 = Point2(x, bottom(r) - 0.5sw)
p2 = Point2(x, top(r) + 0.5sw)
[p1, p2]
end
(lines!(scene, bottomline, linewidth = spinewidth, show_axis = false,
visible = bottomspinevisible, color = bottomspinecolor),
lines!(scene, leftline, linewidth = spinewidth, show_axis = false,
visible = leftspinevisible, color = leftspinecolor),
lines!(scene, rightline, linewidth = spinewidth, show_axis = false,
visible = rightspinevisible, color = rightspinecolor),
lines!(scene, topline, linewidth = spinewidth, show_axis = false,
visible = topspinevisible, color = topspinecolor))
end
function interleave_vectors(vec1::Vector{T}, vec2::Vector{T}) where T
n = length(vec1)
@assert n == length(vec2)
vec = Vector{T}(undef, 2 * n)
@inbounds for i in 1:n
k = 2(i - 1)
vec[k + 1] = vec1[i]
vec[k + 2] = vec2[i]
end
vec
end
"""
Take a sequence of variable definitions with docstrings above each and turn
them into Attributes, a Dict of varname => docstring pairs and a Dict of
varname => default_value pairs.
# Example
attrs, docdict, defaultdict = @documented_attributes begin
"The width."
width = 10
"The height."
height = 20 + x
end
attrs == Attributes(
width = 10,
height = 20
)
docdict == Dict(
width => "The width.",
height => "The height."
)
defaultdict == Dict(
width => "10",
height => "20 + x"
)
"""
macro documented_attributes(exp)
if exp.head != :block
error("Not a block")
end
expressions = filter(x -> !(x isa LineNumberNode), exp.args)
vars_and_exps = map(expressions) do e
if e.head == :macrocall && e.args[1] == GlobalRef(Core, Symbol("@doc"))
varname = e.args[4].args[1]
var_exp = e.args[4].args[2]
str_exp = e.args[3]
elseif e.head == Symbol("=")
varname = e.args[1]
var_exp = e.args[2]
str_exp = "no description"
else
error("Neither docstringed variable nor normal variable: $e")
end
varname, var_exp, str_exp
end
# make a dictionary of :variable_name => docstring_expression
exp_docdict = Expr(:call, :Dict,
(Expr(:call, Symbol("=>"), QuoteNode(name), strexp)
for (name, _, strexp) in vars_and_exps)...)
# make a dictionary of :variable_name => docstring_expression
defaults_dict = Expr(:call, :Dict,
(Expr(:call, Symbol("=>"), QuoteNode(name), exp isa String ? "\"$exp\"" : string(exp))
for (name, exp, _) in vars_and_exps)...)
# make an Attributes instance with of variable_name = variable_expression
exp_attrs = Expr(:call, :Attributes,
(Expr(:kw, name, exp)
for (name, exp, _) in vars_and_exps)...)
esc(quote
($exp_attrs, $exp_docdict, $defaults_dict)
end)
end
"""
Turn a combination of docdict and defaultdict from `@documented_attributes`
into a string to insert into a docstring.
"""
function docvarstring(docdict, defaultdict)
buffer = IOBuffer()
maxwidth = maximum(length ∘ string, keys(docdict))
for (var, doc) in sort(collect(pairs(docdict)))
print(buffer, "`$var`\\\nDefault: `$(defaultdict[var])`\\\n$doc\n\n")
end
String(take!(buffer))
end
function subtheme(scene, key::Symbol)
sub = haskey(theme(scene), key) ? theme(scene, key) : Attributes()
if !(sub isa Attributes)
error("Subtheme is not of type Attributes but is $sub")
end
sub
end
"""
labelslider!(scene, label, range; format = string, sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(), layoutkw...)
Construct a horizontal GridLayout with a label, a slider and a value label in `scene`.
Returns a `NamedTuple`:
`(slider = slider, label = label, valuelabel = valuelabel, layout = layout)`
Specify a format function for the value label with the `format` keyword.
The slider is forwarded the keywords from `sliderkw`.
The label is forwarded the keywords from `labelkw`.
The value label is forwarded the keywords from `valuekw`.
All other keywords are forwarded to the `GridLayout`.
Example:
```
ls = labelslider!(scene, "Voltage:", 0:10; format = x -> "\$(x)V")
layout[1, 1] = ls.layout
```
"""
function labelslider!(scene, label, range; format = string,
sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(), layoutkw...)
slider = Slider(scene; range = range, sliderkw...)
label = Label(scene, label; labelkw...)
valuelabel = Label(scene, lift(format, slider.value); valuekw...)
layout = hbox!(label, slider, valuelabel; layoutkw...)
(slider = slider, label = label, valuelabel = valuelabel, layout = layout)
end
"""
labelslidergrid!(scene, labels, ranges; formats = [string],
sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(), layoutkw...)
Construct a GridLayout with a column of label, a column of sliders and a column of value labels in `scene`.
The argument values are broadcast, so you can use scalars if you want to keep labels, ranges or formats constant across rows.
Returns a `NamedTuple`:
`(sliders = sliders, labels = labels, valuelabels = valuelabels, layout = layout)`
Specify format functions for the value labels with the `formats` keyword.
The sliders are forwarded the keywords from `sliderkw`.
The labels are forwarded the keywords from `labelkw`.
The value labels are forwarded the keywords from `valuekw`.
All other keywords are forwarded to the `GridLayout`.
Example:
```
ls = labelslidergrid!(scene, ["Voltage", "Ampere"], Ref(0:0.1:100); format = x -> "\$(x)V")
layout[1, 1] = ls.layout
```
"""
function labelslidergrid!(scene, labels, ranges; formats = [string],
sliderkw = Dict(), labelkw = Dict(), valuekw = Dict(), layoutkw...)
elements = broadcast(labels, ranges, formats) do label, range, format
slider = Slider(scene; range = range, sliderkw...)
label = Label(scene, label; halign = :left, labelkw...)
valuelabel = Label(scene, lift(format, slider.value); halign = :right, valuekw...)
(; slider = slider, label = label, valuelabel = valuelabel)
end
sliders = map(x -> x.slider, elements)
labels = map(x -> x.label, elements)
valuelabels = map(x -> x.valuelabel, elements)
layout = grid!(hcat(labels, sliders, valuelabels); layoutkw...)
(sliders = sliders, labels = labels, valuelabels = valuelabels, layout = layout)
end
# helper function to create either h or vlines depending on `direction`
# this works only with LAxes because it needs to react to limit changes
function hvlines!(ax::Axis, direction::Int, datavals, axmins, axmaxs; attributes...)
datavals, axmins, axmaxs = map(x -> x isa Observable ? x : Observable(x), (datavals, axmins, axmaxs))
linesegs = lift(ax.finallimits, ax.scene.px_area, datavals, axmins, axmaxs) do lims, pxa,
datavals, axmins, axmaxs
xlims = (minimum(lims)[direction], maximum(lims)[direction])
xfrac(f) = xlims[1] + f * (xlims[2] - xlims[1])
segs = broadcast(datavals, axmins, axmaxs) do dataval, axmin, axmax
if direction == 1
(Point2f0(xfrac(axmin), dataval), Point2f0(xfrac(axmax), dataval))
elseif direction == 2
(Point2f0(dataval, xfrac(axmin)), Point2f0(dataval, xfrac(axmax)))
else
error("direction must be 1 or 2")
end
end
# handle case that none of the inputs is an array, but we need an array for linesegments!
if segs isa Tuple
segs = [segs]
end
segs
end
linesegments!(ax, linesegs; xautolimits = direction == 2, yautolimits = direction == 1, attributes...)
end
"""
hlines!(ax::Axis, ys; xmin = 0.0, xmax = 1.0, attrs...)
Create horizontal lines across `ax` at `ys` in data coordinates and `xmin` to `xmax`
in axis coordinates (0 to 1). All three of these can have single or multiple values because
they are broadcast to calculate the final line segments.
"""
hlines!(ax::Axis, ys; xmin = 0.0, xmax = 1.0, attrs...) =
hvlines!(ax, 1, ys, xmin, xmax; attrs...)
"""
vlines!(ax::Axis, xs; ymin = 0.0, ymax = 1.0, attrs...)
Create vertical lines across `ax` at `xs` in data coordinates and `ymin` to `ymax`
in axis coordinates (0 to 1). All three of these can have single or multiple values because
they are broadcast to calculate the final line segments.
"""
vlines!(ax::Axis, xs; ymin = 0.0, ymax = 1.0, attrs...) =
hvlines!(ax, 2, xs, ymin, ymax; attrs...)
"""
abline!(axis::Axis, a::Number, b::Number; line_kw_args...)
Adds a line defined by `f(x) = x * b + a` to the axis.
kwargs are the same as for a `line` plot and are passed directly to the line attributess.
"""
function abline!(axis::Axis, a::Number, b::Number; kwargs...)
f(x) = x * b + a
line = map(axis.finallimits) do limits
xmin, xmax = first.(extrema(limits))
return [Point2f0(xmin, f(xmin)), Point2f0(xmax, f(xmax))]
end
return linesegments!(axis, line; xautolimits=false, yautolimits=false, kwargs...)
end