LineString

How do you stop drawing? I've tried a few keys without effect... Escape cancels completely. mapbox-gl-draw uses enter to finish.

If I click while moving my mouse quickly, there's no effect -- I'm guessing there's a threshold param and it's counting as a drag. All of the sudden direction changes are a click, but only ones where I stopped long enough seem to count:

https://user-images.githubusercontent.com/1664407/202569947-7fedf407-7708-48ab-bb52-3d18152c7684.mp4

Freehand

Feels choppy, but guessing this is known. :)

Creating a specific adaptor for MapLibre will give better type safety for MapLibre and also allow any future drift in APIs to be accounted for. It is possible that some of the logic could be reused via shared functions or using the MapLibre adapter internally and just wrapping around it for now.

To make sure people actually know how to use the API of the library, we want to use TSDoc comments and then auto generate docs for these with something like TypeDoc.

Original issue for this is https://github.com/JamesLMilner/terra-draw/issues/2 (thank you @dabreegster!) , I am extracting this so it can be tackled in isolation.

Being able to close a geometry using a keyboard shortcut whilst drawing may be a nice improvement and probably wouldn't be too much work to implement. This approach is taken in other open source drawing libraries, so people may expect this behavior.

I would recommend that as with all keybindings in Terra Draw, we make it configureable.

Original issue for this is https://github.com/JamesLMilner/terra-draw/issues/2 (thank you again @dabreegster!) , I am extracting this so it can be tackled in isolation.

The problem here is that the Freehand drawing tool currently uses a rate limiting/throttling mechanism against the incoming events, to prevent too many points being created and hence a large amount of data. However, as pointed out this can lead to a bit of a choppy experience whilst drawing. The solutions here are to potentially decrease the aggressiveness of the throttling via the reducing the everyNthMouseEvent default property, or to take a different approach such as a minimum distance threshold (probably best to implement in pixel distance). The pixel distance approach would probably be the smoother of the two approaches but it would be good to experiment. There may also be other approaches, or a combination which result in better results with regards to the smoothness/data size tradeoff.

Original issue for this is #2 (thank you @dabreegster!) , I am extracting this so it can be tackled in isolation.

Currently it's not super clear how to close a LineString. I think it would make sense to take a similar approach to Polygons where we create a visible closing Point which has a pointer cursor on hover. This hopefully makes it more obvious to the user that the way to close the geometry is by clicking on it.

For reference here is the current behaviour:

https://user-images.githubusercontent.com/8822075/202893542-75da98c4-82df-435e-8936-0747985bbbe2.mp4

At the moment there is not simple way to clear all drawn data. It may make sense to add this onto the public API.

Something simple would work well, such as:

draw.clear() 

Points when selected currently do not indicate they are selected in anyway - it would probably make sense to add stroke as per Polygon and LineString modes on select

At the moment circle mode does not respect the coordinate precision set in Terra Draw options. This should be remedied.

Offending line:

https://github.com/JamesLMilner/terra-draw/blob/main/src/geometry/shape/create-circle.ts#L48

Currently when you use setMode, the mode will start even if Terra Draw itself has not been started:

https://github.com/JamesLMilner/terra-draw/blob/main/src/terra-draw.ts#L276

We should check to make sure Terra Draw has started first.

Whilst drawing a using the Mapbox or MapLibre adapters the initial line appears to disappear when in the 0 and 180 degree positions. See this GIF for an example:

https://user-images.githubusercontent.com/8822075/205132213-337023cf-d632-4836-b18b-0dcb35e785f3.mp4

This should be fairly easy to replicate, simply start drawing a polygon using the Mapbox Adapter and rotate the line 360 to see it flash and reappear as you move past the 0 and 180 degree marks.

In the name of configurability, it probably makes sense to not enforce key bindings in the builtin draw modes. This means if library users do not want their users to cancel and finish a geometry using keyboard shortcuts they can disable them.