Skip to content

Commit

Permalink
cleanup to remove unused function and move docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewwinters5000 committed Apr 5, 2024
1 parent b46e863 commit 9485364
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 26 deletions.
26 changes: 0 additions & 26 deletions ext/VizProject.jl
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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))
Expand Down
30 changes: 30 additions & 0 deletions src/Viz/visualization.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 9485364

Please sign in to comment.