started implementation of reveal mechanic for UnicodePlots

Author: chmerdon

ext/GridVisualizeUnicodePlotsExt.jl

@@ -5,15 +5,47 @@ Extension module for UnicodePlots.jl
 """
 module GridVisualizeUnicodePlotsExt
 
-import GridVisualize: initialize!, gridplot!, scalarplot!, bregion_cmap, region_cmap
-using GridVisualize: UnicodePlotsType
+import GridVisualize: initialize!, gridplot!, scalarplot!, bregion_cmap, region_cmap, reveal
+using GridVisualize: UnicodePlotsType, GridVisualizer, SubVisualizer
 using UnicodePlots: UnicodePlots
 using ExtendableGrids: Coordinates, simplexgrid, ON_CELLS, ON_FACES, ON_EDGES, CellNodes, FaceNodes, BFaceNodes, CellGeometries, CellRegions, BFaceRegions, num_cells, num_nodes, local_celledgenodes, num_bfaceregions, num_cellregions, num_targets, interpolate!
 using Colors: Colors, RGB, RGBA
 
 initialize!(p, ::Type{UnicodePlotsType}) = nothing
 
-function gridplot!(ctx, ::Type{UnicodePlotsType}, ::Type{Val{2}}, grid)
+
+function reveal(p::GridVisualizer, ::Type{UnicodePlotsType})
+    return p.context[:figure]
+end
+
+
+function reveal(ctx::SubVisualizer, TP::Type{UnicodePlotsType})
+    if ctx[:show] || ctx[:reveal]
+        return ctx[:figure]
+    end
+    return nothing
+end
+
+
+function region_legend!(canvas, title, x, y, colors)
+    # legend by annotate!
+    for (i, char) in enumerate(title)
+        UnicodePlots.char_point!(canvas, x + i - 1, y, char, UInt32(0), false)
+    end
+    startx = x + length(title)
+    for r in 1:length(colors)
+        red, green, blue = UInt32.(colors[r])
+        uint_color = (red << 16) | (green << 8) | blue
+        reg_string = "$r "
+        for char in reg_string
+            startx += 1
+            UnicodePlots.char_point!(canvas, startx, y, char, uint_color, false)
+        end
+    end
+    return
+end
+
+function gridplot!(ctx, TP::Type{UnicodePlotsType}, ::Type{Val{2}}, grid)
     UnicodePlots = ctx[:Plotter]
 
     # find bounding box
@@ -157,30 +189,12 @@ function gridplot!(ctx, ::Type{UnicodePlotsType}, ::Type{Val{2}}, grid)
     UnicodePlots.annotate!(canvas, ex[1] - 1.5 * padding, ey[2], "$(ey[2])", UInt32(0), false; halign = :left)
 
     # plot
-    plot = UnicodePlots.Plot(canvas; title = ctx[:title])
-    return plot
-end
-
-function region_legend!(canvas, title, x, y, colors)
-    # legend by annotate!
-    for (i, char) in enumerate(title)
-        UnicodePlots.char_point!(canvas, x + i - 1, y, char, UInt32(0), false)
-    end
-    startx = x + length(title)
-    for r in 1:length(colors)
-        red, green, blue = UInt32.(colors[r])
-        uint_color = (red << 16) | (green << 8) | blue
-        reg_string = "$r "
-        for char in reg_string
-            startx += 1
-            UnicodePlots.char_point!(canvas, startx, y, char, uint_color, false)
-        end
-    end
-    return
+    ctx[:figure] = UnicodePlots.Plot(canvas; title = ctx[:title])
+    return reveal(ctx, TP)
 end
 
 
-function gridplot!(ctx, ::Type{UnicodePlotsType}, ::Type{Val{1}}, grid)
+function gridplot!(ctx, TP::Type{UnicodePlotsType}, ::Type{Val{1}}, grid)
     UnicodePlots = ctx[:Plotter]
 
     # find bounding box
@@ -273,14 +287,15 @@ function gridplot!(ctx, ::Type{UnicodePlotsType}, ::Type{Val{1}}, grid)
     UnicodePlots.annotate!(canvas, ex[2], 0.1, "$(ex[2])", UInt32(0), false)
 
     # plot
-    plot = UnicodePlots.Plot(canvas; title = ctx[:title])
-    return plot
+    ctx[:figure] = UnicodePlots.Plot(canvas; title = ctx[:title])
+
+    return reveal(ctx, TP)
 end
 
 
 function scalarplot!(
         ctx,
-        ::Type{UnicodePlotsType},
+        TP::Type{UnicodePlotsType},
         ::Type{Val{1}},
         grids,
         parentgrid,
@@ -307,14 +322,15 @@ function scalarplot!(
             UnicodePlots.lineplot!(plt, coord[1, :], func; name = ctx[:label])
         end
     end
+    ctx[:figure] = plt
 
-    return plt
+    return reveal(ctx, TP)
 end
 
 
 function scalarplot!(
         ctx,
-        ::Type{UnicodePlotsType},
+        TP::Type{UnicodePlotsType},
         ::Type{Val{2}},
         grids,
         parentgrid,
@@ -343,8 +359,7 @@ function scalarplot!(
     I = zeros(Float64, num_nodes(xgrid_plot))
     interpolate!(I, xgrid_plot, func, grids[1]; eps = 1.0e-14, not_in_domain_value = NaN, trybrute = true)
 
-    plt = ctx[:clear] ? nothing : ctx[:figure]
-    plt = UnicodePlots.heatmap(
+    ctx[:figure] = UnicodePlots.heatmap(
         reshape(I, (resolution[1], resolution[2]))',
         xlabel = "x",
         ylabel = "y",
@@ -356,7 +371,7 @@ function scalarplot!(
         colormap = colormap,
     )
 
-    return plt
+    return reveal(ctx, TP)
 end
 
 end # module