diff --git a/ext/VizProject.jl b/ext/VizProject.jl index b2d04ac2..dedeaad9 100644 --- a/ext/VizProject.jl +++ b/ext/VizProject.jl @@ -1,21 +1,4 @@ -const MODEL = 1; const GRID = 2; const MESH = 4; const EMPTY = 0 -const REFINEMENTS = 8; const ALL = 15 - - -""" - plotProject!(proj::Project, plotOptions::Int = 0) - -Plot objects specified by the `plotOptions`. Construct the `plotOptions` by the sum -of what is to be drawn from the choices `MODEL`, `GRID`, `MESH`, `REFINEMENTS`. - -Example: To plot the model and the grid, `plotOptions = MODEL + GRID`. To plot -just the mesh, `plotOptions = MESH`. - -To plot everything, `plotOptions = MODEL + GRID + MESH + REFINEMENTS` - -Contents are overlaid in the order: GRID, MESH, MODEL, REFINEMENTS -""" function plotProject!(proj::Project, plotOptions::Int = 0) if isnothing(proj.plt) @@ -113,15 +96,6 @@ function plotProject!(proj::Project, plotOptions::Int = 0) end -""" - updatePlot!(proj::Project, plotOptions::Int) - -Replot with the new plotOptions = combinations (sums) of - - GRID, MESH, MODEL, REFINEMENTS - -Example: updatePlot!(p, MESH + MODEL) -""" function updatePlot!(proj::Project, plotOptions::Int) if !isnothing(proj.plt) proj.plt = Figure(size = (1000, 1000)) diff --git a/src/Viz/visualization.jl b/src/Viz/visualization.jl index 7ad77524..397dee64 100644 --- a/src/Viz/visualization.jl +++ b/src/Viz/visualization.jl @@ -6,5 +6,35 @@ const REFINEMENTS = 8; const ALL = 15 # Add function definitions here such that they can be exported from HOHQMesh.jl # and extended in the HOHQMeshMakieExt package extension or by the # Makie-specific code loaded by Requires.jl + +""" + plotProject!(proj::Project, plotOptions::Int = 0) + +Plot objects specified by the `plotOptions`. Construct the `plotOptions` by the sum +of what is to be drawn from the choices `MODEL`, `GRID`, `MESH`, `REFINEMENTS`. + +Example: To plot the model and the grid, `plotOptions = MODEL + GRID`. To plot +just the mesh, `plotOptions = MESH`. + +To plot everything, `plotOptions = MODEL + GRID + MESH + REFINEMENTS` + +Contents are overlaid in the order: GRID, MESH, MODEL, REFINEMENTS +!!! note + The function implementation is found in `ext/VizProject.jl`. +""" function plotProject! end + + +""" + updatePlot!(proj::Project, plotOptions::Int) + +Replot with the new plotOptions = combinations (sums) of + + GRID, MESH, MODEL, REFINEMENTS + +Example: updatePlot!(p, MESH + MODEL) + +!!! note + The function implementation is found in `ext/VizProject.jl`. +""" function updatePlot! end \ No newline at end of file