https://github.com/makieorg/makiedraw.jl

Simple tools for drawing raster images, points, lines and polygons in Makie.jl.
https://github.com/makieorg/makiedraw.jl

Last synced: 2 days ago
JSON representation

Simple tools for drawing raster images, points, lines and polygons in Makie.jl.

• Host: GitHub
• URL: https://github.com/makieorg/makiedraw.jl
• Owner: MakieOrg
• License: mit
• Created: 2023-01-12T18:43:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-27T00:56:38.000Z (4 months ago)
• Last Synced: 2024-11-10T08:14:55.370Z (about 2 months ago)
• Language: Julia
• Homepage:
• Size: 199 KB
• Stars: 42
• Watchers: 3
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MakieDraw

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MakieOrg.github.io/MakieDraw.jl/stable/)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MakieOrg.github.io/MakieDraw.jl/dev/)

[![Build Status](https://github.com/MakieOrg/MakieDraw.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/MakieOrg/MakieDraw.jl/actions/workflows/CI.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/MakieOrg/MakieDraw.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/MakieOrg/MakieDraw.jl)

Plot an interactive canvas of GeometryBaseics `Point`, `LineString` or `Polygon`, or an ms-paint style canvas for any numerical or color `Array`. These can be overlayed and activated/deactivated to have multiple drawing task on the same `Axis`.

[makie_draw_life.webm](https://user-images.githubusercontent.com/2534009/228633357-52798d12-36dc-4bb7-a1d4-fdb620aa5ca6.webm)

_Drawing into a DynamicGrids.jl game of life simulation_

# Example use cases

- `GeometryCanvas` can be used to manually crreate GeoInterface.jl compatible FeatureCollections (and even add metadata columns for each geometry), which can be done over a heatmap or other spatial plot. A `GeometryCanvas` can be written directly to disk with GeoJSON.jl or Shapefile.jl.

- `GeometryCanvas` can also be used to edit any GeoInterface.jl compatible geometries and feature collections.

- `PaintCanvas` can be used to manually edit matrices of any kind that Makie can plot. You could make `Bool` mask layers over maps or other images, edit categorical images, or just draw some retro pictures on a `Matrix{RGB}`. 

- MakieDraw could also be used for live interaction, such as using `PaintCanvas` as a mask or aux layer in DynamicGrids.jl simulations.

[makie_draws-2023-03-29_17.48.57.webm](https://user-images.githubusercontent.com/2534009/228595860-ae996719-c4a3-4479-b4da-f65183da867a.webm)

Or try this example over Tyler.jl tiles:

```julia

using MakieDraw

using GLMakie

using GeoJSON

using GeometryBasics

using GeoInterface

using TileProviders

using Tyler

using Extents

provider = Google(:satelite)

figure = Figure()

axis = Axis(figure[1, 1])

tyler = Tyler.Map(Extent(Y=(-27.0, 0.025), X=(0.04, 38.0)); 

    figure, axis, provider=Google()

)

categories = Observable(Int[])

point_canvas = GeometryCanvas{Point2}(; 

  figure, axis, properties=(; categories), mouse_property=:categories,

  scatter_kw=(; color=categories, colorrange=(0, 2), colormap=:spring)

)

line_canvas = GeometryCanvas{LineString}(; figure, axis)

line_canvas.active[] = false

point_canvas.active[] = true

poly_canvas = GeometryCanvas{Polygon}(; figure, axis)

layers = Dict(

    :point=>point_canvas, 

    :line=>line_canvas,

    :poly=>poly_canvas,

)

MakieDraw.CanvasSelect(figure[3, 1], axis; layers)

# Write the polygons to JSON

# Have to convert here because GeometryBasics `isgeometry` has a bug, see PR #193

polygons = GeoInterface.convert.(Ref(GeoInterface), poly_canvas.geoms[])

mp = GeoInterface.MultiPolygon(polygons)

GeoJSON.write("multipolygon.json", mp)

# Reload and edit again

polygons = collect(GeoInterface.getgeom(GeoJSON.read(read("multipolygon.json"))))

tyler = Tyler.Map(Extent(Y=(-27.0, 0.025), X=(0.04, 38.0)); provider)

fig = tyler.figure;

axis = tyler.axis;

poly_canvas = GeometryCanvas(polygons; figure, axis)

```

`GeometryCanvas` keys:

Cick to add, grab or drag points. Left/Right/Center can be used for data entry of `0/1/2` with the `mouseproperty` keyword.

Shift + click starts new lines and polygons.

Alt + click deletes points, hold and drag continues deleting them.

`PaintCanvas` keys:

Left click draws with `fill_left`, right click draws with `fill_right`.