Add map cube command.

Author: jericks

examples/map_cube.txt

@@ -0,0 +1,35 @@
+download --url https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/110m/cultural/ne_110m_admin_0_countries.zip --file countries.zip --overwrite false
+
+unzip --file countries.zip --directory countries
+
+download --url https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/110m/physical/ne_110m_ocean.zip --file ocean.zip --overwrite false
+
+unzip --file ocean.zip --directory ocean
+
+workspace open --name countries --params countries/ne_110m_admin_0_countries.shp
+
+layer open --workspace countries --layer ne_110m_admin_0_countries
+
+workspace open --name ocean --params ocean/ne_110m_ocean.shp
+
+layer open --workspace ocean --layer ne_110m_ocean
+
+style create --params "fill=#ffffff fill-opacity=1.0 stroke=#b2b2b2 stroke-width=0.5" --file countries.sld
+
+style create --params "fill=#a5bfdd fill-opacity=1.0" --file ocean.sld
+
+layer style set --name countries:ne_110m_admin_0_countries --style countries.sld
+
+layer style set --name ocean:ne_110m_ocean --style ocean.sld
+
+map open --name world
+
+map add layer --name world --layer ocean:ne_110m_ocean
+
+map add layer --name world --layer countries:ne_110m_admin_0_countries
+
+map cube --name world --draw-tabs true --draw-outline true --title World --source "Natural Earth"
+
+map close --name world
+
+open --file image.png

src/main/docs/map.adoc

@@ -388,4 +388,44 @@ include::output/map_display_7_result.txt[]
 include::output/map_display_8_command.txt[]
 include::output/map_display_8_result.txt[]
 
-image::map_display.png[]
+image::map_display.png[]
+
+=== Map Cube
+
+include::commands/map_cube_description.txt[]
+
+include::output/map_cube_8_command.txt[]
+
+include::commands/map_cube.txt[]
+
+include::output/map_cube_0_command.txt[]
+include::output/map_cube_0_result.txt[]
+
+include::output/map_cube_1_command.txt[]
+include::output/map_cube_1_result.txt[]
+
+include::output/map_cube_2_command.txt[]
+include::output/map_cube_2_result.txt[]
+
+include::output/map_cube_3_command.txt[]
+include::output/map_cube_3_result.txt[]
+
+include::output/map_cube_4_command.txt[]
+include::output/map_cube_4_result.txt[]
+
+include::output/map_cube_5_command.txt[]
+include::output/map_cube_5_result.txt[]
+
+include::output/map_cube_6_command.txt[]
+include::output/map_cube_6_result.txt[]
+
+include::output/map_cube_7_command.txt[]
+include::output/map_cube_7_result.txt[]
+
+include::output/map_cube_8_command.txt[]
+include::output/map_cube_8_result.txt[]
+
+include::output/map_cube_9_command.txt[]
+include::output/map_cube_9_result.txt[]
+
+image::map_cube.png[]

src/main/groovy/org/geoshell/map/MapCommands.groovy

@@ -2,6 +2,7 @@ package org.geoshell.map
 
 import geoscript.geom.Bounds
 import geoscript.proj.Projection
+import geoscript.render.MapCube
 import geoscript.render.MapWindow
 import geoscript.render.Window
 import org.geoshell.Catalog
@@ -197,4 +198,33 @@ class MapCommands implements CommandMarker {
             "Unable to find Map ${name}"
         }
     }
+
+    @CliCommand(value = "map cube", help = "Draw a map cube.")
+    String renderMapCube(
+            @CliOption(key = "name", mandatory = true, help = "The map name") MapName name,
+            @CliOption(key = "draw-outline", mandatory = false, specifiedDefaultValue = "false", unspecifiedDefaultValue = "false", help = "Whether to draw outline or now") boolean drawOutline,
+            @CliOption(key = "draw-tabs", mandatory = false, specifiedDefaultValue = "false", unspecifiedDefaultValue = "false", help = "Whether to draw tabs or not") boolean drawTabs,
+            @CliOption(key = "tab-size", mandatory = false, unspecifiedDefaultValue = "30", specifiedDefaultValue = "30", help = "The size of the tabs") int tabSize,
+            @CliOption(key = "title", mandatory = false, unspecifiedDefaultValue = "", specifiedDefaultValue = "", help = "The map title") String title,
+            @CliOption(key = "source", mandatory = false, unspecifiedDefaultValue = "", specifiedDefaultValue = "", help = "The map source") String source,
+            @CliOption(key = "type", mandatory = false, unspecifiedDefaultValue = "png", specifiedDefaultValue = "png", help = "The type") String type,
+            @CliOption(key = "file", mandatory = false, help = "The file") File file
+    ) throws Exception {
+        org.geoshell.map.Map map = catalog.maps[name]
+        if (map) {
+            MapCube mapCube = new MapCube(
+                    drawOutline: drawOutline,
+                    drawTabs: drawTabs,
+                    tabSize: tabSize,
+                    title: title,
+                    source: source,
+                    imageType: type
+            )
+            file = file ? file : new File("image.${type}")
+            mapCube.render(map.getLayers(), file)
+            "Done drawing ${file.absolutePath}!"
+        } else {
+            "Unable to find Map ${name}"
+        }
+    }
 }

src/test/groovy/org/geoshell/docs/MapDocTest.groovy

@@ -158,4 +158,21 @@ class MapDocTest extends AbstractDocTest {
         copyFile(new File("examples/map_draw.png"), new File("src/main/docs/images"))
     }
 
+    @Test
+    void mapCube() {
+        run("map_cube", [
+                "map open --name world",
+                "workspace open --name naturalearth --params examples/naturalearth.gpkg",
+                "layer open --workspace naturalearth --layer countries --name countries",
+                "layer style set --name countries --style examples/countries.sld",
+                "layer open --workspace naturalearth --layer ocean --name ocean",
+                "layer style set --name ocean --style examples/ocean.sld",
+                "map add layer --name world --layer ocean",
+                "map add layer --name world --layer countries",
+                "map cube --name world --file examples/map_cube.png --title World --source NaturalEarth --draw-tabs true --draw-outline true",
+                "map close --name world"
+        ])
+        copyFile(new File("examples/map_cube.png"), new File("src/main/docs/images"))
+    }
+
 }

src/test/groovy/org/geoshell/map/MapCommandsTest.groovy

@@ -140,4 +140,27 @@ class MapCommandsTest {
         assertTrue result.endsWith("map.png!")
     }
 
+    @Test void drawMapCube() {
+        Layer layer = new Shapefile(new File(getClass().getClassLoader().getResource("grid.shp").toURI()))
+        Catalog catalog = new Catalog()
+        catalog.layers[new LayerName("grid")] = layer
+
+        MapCommands cmds = new MapCommands(catalog: catalog)
+        cmds.open(new MapName("grid"))
+        cmds.addLayer(new MapName("grid"), new LayerName("grid"), null)
+        File file = new File(folder, "mapcube.png")
+        String result = cmds.renderMapCube(
+                new MapName("grid"),
+                true,
+                true,
+                30,
+                "World Grid",
+                "Natural Earth",
+                "png",
+                file
+        )
+        assertTrue result.startsWith("Done drawing")
+        assertTrue result.endsWith("mapcube.png!")
+    }
+
 }