add descriptions and move simplify to be internal

mootw · Nov 21, 2023 · aa2e37e · aa2e37e
1 parent 080846f
commit aa2e37e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/lib/src/layer/polygon_layer/polygon_layer.dart b/lib/src/layer/polygon_layer/polygon_layer.dart
@@ -2,7 +2,7 @@ import 'dart:math';
 import 'dart:ui' as ui;
 
 import 'package:flutter/widgets.dart';
-import 'package:flutter_map/simplify.dart';
+import 'package:flutter_map/src/misc/simplify.dart';
 import 'package:flutter_map/src/geo/latlng_bounds.dart';
 import 'package:flutter_map/src/layer/general/mobile_layer_transformer.dart';
 import 'package:flutter_map/src/layer/polygon_layer/label.dart';
@@ -113,7 +113,9 @@ class PolygonLayer extends StatelessWidget {
   /// how much to simplify the polygons, in decimal degrees scaled to floored zoom
   final double? simplificationTolerance;
 
-  /// use high quality simplification
+  /// high quality simplification uses the https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm
+  /// otherwise, points within the radial distance of the threshold value are merged. (Also called radial distance simplification)
+  /// radial distance is faster, but does not preserve the shape of the original line as well as Douglas Peucker
   final bool simplificationHighQuality;
 
   // Turn on/off per-polygon label drawing on the layer-level.

diff --git a/lib/src/layer/polyline_layer.dart b/lib/src/layer/polyline_layer.dart
@@ -4,7 +4,7 @@ import 'dart:ui' as ui;
 
 import 'package:flutter/widgets.dart';
 import 'package:flutter_map/flutter_map.dart';
-import 'package:flutter_map/simplify.dart';
+import 'package:flutter_map/src/misc/simplify.dart';
 import 'package:latlong2/latlong.dart';
 
 class Polyline {
@@ -59,7 +59,9 @@ class PolylineLayer extends StatelessWidget {
   /// how much to simplify the polygons, in decimal degrees scaled to floored zoom
   final double? simplificationTolerance;
 
-  /// use high quality simplification
+  /// high quality simplification uses the https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm
+  /// otherwise, points within the radial distance of the threshold value are merged. (Also called radial distance simplification)
+  /// radial distance is faster, but does not preserve the shape of the original line as well as Douglas Peucker
   final bool simplificationHighQuality;
 
   const PolylineLayer({

diff --git a/lib/simplify.dart → lib/src/misc/simplify.dart b/lib/simplify.dart → lib/src/misc/simplify.dart
@@ -1,8 +1,6 @@
 // implementation based on
 // https://github.com/mourner/simplify-js/blob/master/simplify.js
 
-library simplify;
-
 import 'package:latlong2/latlong.dart';
 
 double _getSqDist(
@@ -42,6 +40,7 @@ double _getSqSegDist(
   return dx * dx + dy * dy;
 }
 
+
 List<LatLng> simplifyRadialDist(
   List<LatLng> points,
   double sqTolerance,