leaflet-rotate 0.4.0 → 0.5.0

package/src/layer/vector/Renderer.js

@@ -1,30 +1,57 @@
 /**
+ * Recalculates vector renderer bounds and transforms for rotated and pitched maps.
+ *
  * @external L.Renderer
  * 
  * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/layer/vector/Renderer.js
+ * 
+ * @since leaflet-rotate (v0.1.0)
  */
 
 const rendererProto = Object.defineProperties({}, Object.getOwnPropertyDescriptors(L.Renderer.prototype));
 const rendererBase = Object.getPrototypeOf(L.Renderer.prototype);
 const rendererGetEvents = rendererProto.getEvents || rendererBase.getEvents;
+const rendererOnMoveEnd = rendererProto._onMoveEnd || rendererBase._onMoveEnd;
 
 L.Renderer.include({
 
     /**
-     * Redraw L.Canvas and L.SVG renderer bounds after the
-     * map is moved by just calling `map.setBearing(theta)`
+     * Subscribe the renderer to map rotation so its visible bounds are recalculated.
      * 
      * @listens L.Map~rotate
+     * 
+     * @returns {Object} Leaflet event map for the renderer.
+     * 
+     * @since leaflet-rotate (v0.1.0)
      */
     getEvents() {
         const events = rendererGetEvents.apply(this, arguments);
-        return L.version.startsWith('2.') ? events : Object.assign(events, { rotate: this._update });
+        return Object.assign(events, { rotate: this._onRotate });
     },
 
     /**
-     * Fix for `map.flyTo()` when `false === map.options.zoomAnimation`
+     * Reproject vector paths and refresh renderer bounds after bearing changes.
+     * 
+     * @since leaflet-rotate (v0.1.0)
+     */
+    _onRotate() {
+        if (!this._map._rotate) { return; }
+        this._onZoomEnd();
+        if (L.version.startsWith('2.')) {
+            this._onMoveEnd();
+        } else {
+            this._update();
+        }
+    },
+
+    /**
+     * Add the zoom-animation class needed for correct renderer transforms in Leaflet 1.
+     *
+     * Fixes `map.flyTo()` when `map.options.zoomAnimation` is false.
      * 
      * @see https://github.com/Leaflet/Leaflet/pull/8794
+     * 
+     * @since leaflet-rotate (v0.2.0)
      */
     onAdd() {
         rendererProto.onAdd.apply(this, arguments);
@@ -35,6 +62,8 @@ L.Renderer.include({
     },
 
     /**
+     * Update the renderer transform during zoom animation, accounting for rotated coordinates.
+     *
      * @FIXME layer drifts on `map.setZoom()` (eg. zoom during animation)
      * 
      * the main cause seems to be related to `this._updateTransform(path._center, path._zoom))`
@@ -49,9 +78,14 @@ L.Renderer.include({
      * @see https://github.com/Leaflet/Leaflet/pull/8103
      * @see https://github.com/Leaflet/Leaflet/issues/7466
      * 
-     * @TODO rechek this changes from leaflet@v1.9.3
+     * @TODO recheck these changes against leaflet@v1.9.3
      * 
      * @see https://github.com/Leaflet/Leaflet/compare/v1.7.0...v1.9.3
+     * 
+     * @param {L.LatLng} center Target map center.
+     * @param {number} zoom Target zoom level.
+     * 
+     * @since leaflet-rotate (v0.1.0)
      */
     _updateTransform(center, zoom) {
         if (L.version.startsWith('2.')) {
@@ -82,9 +116,16 @@ L.Renderer.include({
         
     },
 
+    /**
+     * Recalculate bounds and finish renderer updates after movement on Leaflet 2.
+     *
+     * @param {Object} ev Map movement event.
+     * 
+     * @since leaflet-rotate (v0.4.0)
+     */
     _onMoveEnd(ev) {
         if (!L.version.startsWith('2.') || !this._map._rotate) {
-            return rendererBase._onMoveEnd.apply(this, arguments);
+            return rendererOnMoveEnd.apply(this, arguments);
         }
 
         this._bounds = this._map._getPaddedPixelBounds(this.options.padding);
@@ -97,6 +138,11 @@ L.Renderer.include({
         this._onSettled(ev);
     },
 
+    /**
+     * Resize the renderer container to cover the pitch-aware map bounds.
+     * 
+     * @since leaflet-rotate (v0.4.0)
+     */
     _resizeContainer() {
         if (!L.version.startsWith('2.') || !this._map._rotate || !this._bounds) {
             return rendererBase._resizeContainer.apply(this, arguments);
@@ -150,6 +196,11 @@ L.Renderer.include({
     //     }
     // },
 
+    /**
+     * Recalculate renderer bounds and cached view state.
+     * 
+     * @since leaflet-rotate (v0.1.0)
+     */
     _update() {
         if (!this._map._rotate) {
             return rendererProto._update.apply(this, arguments);