doc & new api

Author: sergiandreplace

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.1.1] - 2020-May-5.
+
+* `FillConfig no has a builder`
+* `Rough.draw` is now `drawRough`, a extension method of ``Draw
+* Basic external api documentation
+
 ## [0.1.0+2] - 2020-May-5.
 
 * Basic documentation

README.md

@@ -24,38 +24,37 @@ To draw a figure you have to:
 2. Create a `Filler` to be used when drawing objects (you have to provide a configuration for the filling and a `DrawConfig` for the filling path).
 3. Create a `Generator` object using the created `DrawConfig` and `Filler`. This will define a drawing/filling style.
 4. Invoke the drawing method from the `Generator` to create a `Drawable`.
-5. Paint the `Drawable` in the canvas using the `Rough.draw` method.
+5. Paint the `Drawable` in the canvas using the `drawRough` method extension for `Canvas`.
 
-Here an example on how to draw a rectangle:
+Here an example on how to draw a circle:
 
 ```dart
-    //Create a `DrawConfig` object.
-    DrawConfig myDrawConfig = DrawConfig.build(
-      roughness: 3,
-      curveStepCount: 14,
-      maxRandomnessOffset: 3,
-    );
-
-    //Create a `Filler` (we reuse the drawConfig in this case).
-    Filler myFiller = ZigZagFiller(
-        FillerConfig(
-          hachureGap: 8,
-          hachureAngle: -20,
-          drawConfig: myDrawConfig,
-        ),
-    );
-
-    //3Create a `Generator` with the created `DrawConfig` and `Filler`
-    Generator generator = Generator(
-      myDrawConfig,
-      myFiller,
-    );
-
-    //4. Build a circle `Drawable`.
-    Drawable figure = generator.circle(200, 200, 320);
-
-    //5. Paint the `Drawable` in the canvas.
-    Rough().draw(canvas, figure, pathPaint, fillPaint);
+//Create a `DrawConfig` object.
+DrawConfig myDrawConfig = DrawConfig.build(
+  roughness: 3,
+  curveStepCount: 14,
+  maxRandomnessOffset: 3,
+);
+
+//Create a `Filler` with a configuration (we reuse the drawConfig in this case).
+FillerConfig myFillerConfig = FillerConfig(
+    hachureGap: 8,
+    hachureAngle: -20,
+    drawConfig: myDrawConfig,
+);
+Filler myFiller = ZigZagFiller(myFillerConfig);
+
+//Create a `Generator` with the created `DrawConfig` and `Filler`
+Generator generator = Generator(
+  myDrawConfig,
+  myFiller,
+);
+
+//4. Build a circle `Drawable`.
+Drawable figure = generator.circle(200, 200, 320);
+
+//5. Paint the `Drawable` in the canvas.
+Canvas.drawRough(figure, pathPaint, fillPaint);
 ```
 
 And this is the result:

example/lib/pages/flutter_logo.dart

@@ -24,8 +24,6 @@ class FlutterLogoPage extends StatelessWidget {
 }
 
 class FlutterLogoPainter extends InteractivePainter {
-  final Rough rough = Rough();
-
   Paint stroke = Paint()
     ..strokeWidth = 2
     ..isAntiAlias = true
@@ -43,12 +41,11 @@ class FlutterLogoPainter extends InteractivePainter {
 
   @override
   void paintRough(canvas, size) {
-    FillerConfig fillerConfig = FillerConfig(
+    FillerConfig fillerConfig = FillerConfig.build(
       hachureAngle: 90,
       drawConfig: drawConfig,
       fillWeight: 10,
       hachureGap: 5,
-//      zigzagOffset: 10,
     );
 
     Generator gen = Generator(drawConfig, HachureFiller(fillerConfig));
@@ -62,11 +59,11 @@ class FlutterLogoPainter extends InteractivePainter {
 
     canvas
       ..translate(translateX, translateY)
-      ..scale(scale);
-    rough.draw(canvas, gen.polygon([PointD(37, 128), PointD(9, 101), PointD(100, 10), PointD(156, 10)]), stroke, fillPaint);
-    canvas.translate(-4, -4);
-    rough.draw(canvas, gen.polygon([PointD(156, 94), PointD(100, 94), PointD(50, 141), PointD(79, 170)]), stroke, fillPaint);
-    canvas.translate(6, 6);
-    rough.draw(canvas, gen.polygon([PointD(79, 170), PointD(100, 191), PointD(156, 191), PointD(107, 142)]), stroke, fillPaint);
+      ..scale(scale)
+      ..drawRough(gen.polygon([PointD(37, 128), PointD(9, 101), PointD(100, 10), PointD(156, 10)]), stroke, fillPaint)
+      ..translate(-4, -4)
+      ..drawRough(gen.polygon([PointD(156, 94), PointD(100, 94), PointD(50, 141), PointD(79, 170)]), stroke, fillPaint)
+      ..translate(6, 6)
+      ..drawRough(gen.polygon([PointD(79, 170), PointD(100, 191), PointD(156, 191), PointD(107, 142)]), stroke, fillPaint);
   }
 }

example/lib/pages/interactive_arc.dart

@@ -41,9 +41,9 @@ class ArcPainter extends InteractivePainter {
 
   @override
   void paintRough(Canvas canvas, Size size) {
-    Generator generator = Generator(drawConfig, HachureFiller(const FillerConfig().copyWith(drawConfig: drawConfig)));
+    Generator generator = Generator(drawConfig, HachureFiller(FillerConfig.build().copyWith(drawConfig: drawConfig)));
     double s = min(size.width, size.height);
     Drawable figure = generator.arc(size.width / 2, size.height / 2, s * 0.8, s * 0.8, pi * 0.2, pi * 1.8, true);
-    Rough().draw(canvas, figure, pathPaint, fillPaint);
+    canvas.drawRough(figure, pathPaint, fillPaint);
   }
 }

example/lib/pages/interactive_circle.dart

@@ -41,9 +41,9 @@ class CirclePainter extends InteractivePainter {
 
   @override
   void paintRough(Canvas canvas, Size size) {
-    Generator generator = Generator(drawConfig, NoFiller(const FillerConfig().copyWith(drawConfig: drawConfig)));
+    Generator generator = Generator(drawConfig, NoFiller(FillerConfig.build().copyWith(drawConfig: drawConfig)));
     double s = min(size.width, size.height);
     Drawable figure = generator.circle(size.width / 2, size.height / 2, s * 0.8);
-    Rough().draw(canvas, figure, pathPaint, fillPaint);
+    canvas.drawRough(figure, pathPaint, fillPaint);
   }
 }

example/lib/pages/interactive_rectangle.dart

@@ -39,9 +39,9 @@ class Rectangle extends InteractivePainter {
 
   @override
   void paintRough(Canvas canvas, Size size) {
-    Generator generator = Generator(drawConfig, NoFiller(const FillerConfig().copyWith(drawConfig: drawConfig)));
+    Generator generator = Generator(drawConfig, NoFiller(FillerConfig.build().copyWith(drawConfig: drawConfig)));
 
     Drawable figure = generator.rectangle(size.width * 0.1, size.height * 0.2, size.width * 0.8, size.height * 0.6);
-    Rough().draw(canvas, figure, pathPaint, fillPaint);
+    canvas.drawRough(figure, pathPaint, fillPaint);
   }
 }

example/pubspec.lock

@@ -122,7 +122,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.1.0+1"
+    version: "0.1.0+2"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -192,4 +192,4 @@ packages:
     source: hosted
     version: "3.5.0"
 sdks:
-  dart: ">=2.4.0 <3.0.0"
+  dart: ">=2.6.0 <3.0.0"

lib/src/config.dart

@@ -1,12 +1,13 @@
 import 'dart:math';
 
+// Describe how a particular shape is drawn.
 class DrawConfig {
-  final double maxRandomnessOffset; //line + solidFiller
-  final double roughness; //everything
-  final double bowing; //line
-  final double curveFitting; //ellipse
-  final double curveTightness; //curve
-  final double curveStepCount; //generateEllipseParams
+  final double maxRandomnessOffset;
+  final double roughness;
+  final double bowing;
+  final double curveFitting;
+  final double curveTightness;
+  final double curveStepCount;
   final int seed;
   final Randomizer randomizer;
 
@@ -31,6 +32,13 @@ class DrawConfig {
     this.randomizer,
   });
 
+  /// Generates a [DrawConfig]
+  /// * [roughness] Numerical value indicating how rough the drawing is. A rectangle with the roughness of 0 would be a perfect rectangle. Default value is 1. There is no upper limit to this value, but a value over 10 is mostly useless.
+  /// * [bowing] Numerical value indicating how curvy the lines are when drawing a sketch. A value of 0 will cause straight lines. Default value is 1.
+  /// * [seed] The seed for creating random values used in shape generation. This is useful for creating the exact shape when re-generating with the same parameters. Default value is 1.
+  /// * [curveStepCount] When drawing ellipses, circles, and arcs, Rough approximates [curveStepCount] number of points to estimate the shape. Default value is 9.
+  /// * [curveTightness]
+  /// * [curveFitting] When drawing ellipses, circles, and arcs, it means how close should the rendered dimensions be when compared to the specified one. Default value is 0.95.
   static DrawConfig build({
     double maxRandomnessOffset,
     double roughness,

lib/src/filler.dart

@@ -24,16 +24,43 @@ class FillerConfig {
   final double dashGap;
   final double zigzagOffset;
 
-  const FillerConfig({
+  const FillerConfig._({
     DrawConfig drawConfig,
-    this.fillWeight = 1,
-    this.hachureAngle = -41,
-    this.hachureGap = 15,
-    this.dashOffset = 15,
-    this.dashGap = 2,
-    this.zigzagOffset = 5,
+    this.fillWeight,
+    this.hachureAngle,
+    this.hachureGap,
+    this.dashOffset,
+    this.dashGap,
+    this.zigzagOffset,
   }) : _drawConfig = drawConfig;
 
+  /// * [fillWeigh] When using dots styles to fill the shape, this value represents the diameter of the dot.
+  /// * [hachureAngle] Numerical value (in degrees) that defines the angle of the hachure lines. Default value is -41 degrees.
+  /// * [hachureGap] Numerical value that defines the average gap, in pixels, between two hachure lines. Default value is 15.
+  /// * [dashOffset] When filling a shape using the [DashedFiller], this property indicates the nominal length of dash (in pixels). If not set, it defaults to the hachureGap value.
+  /// * [dashGap] When filling a shape using the [DashedFiller], this property indicates the nominal gap between dashes (in pixels). If not set, it defaults to the hachureGap value.
+  /// * [zigzagOffset] When filling a shape using the [ZigZagLineFiller], this property indicates the nominal width of the zig-zag triangle in each line. If not set, it defaults to the hachureGap value.
+  static FillerConfig build({
+    DrawConfig drawConfig,
+    double fillWeight = 1,
+    double hachureAngle = -41,
+    double hachureGap = 15,
+    double dashOffset = 15,
+    double dashGap = 2,
+    double zigzagOffset = 5,
+  }) =>
+      FillerConfig._(
+        drawConfig: drawConfig,
+        fillWeight: fillWeight,
+        hachureAngle: hachureAngle,
+        hachureGap: hachureGap,
+        dashOffset: dashOffset,
+        dashGap: dashGap,
+        zigzagOffset: zigzagOffset,
+      );
+
+  static FillerConfig defaultConfig = FillerConfig.build(drawConfig: DrawConfig.defaultValues);
+
   DrawConfig get drawConfig => _drawConfig;
 
   FillerConfig copyWith({
@@ -45,7 +72,7 @@ class FillerConfig {
     double dashGap,
     double zigzagOffset,
   }) =>
-      FillerConfig(
+      FillerConfig._(
         drawConfig: drawConfig ?? _drawConfig,
         fillWeight: fillWeight ?? this.fillWeight,
         hachureAngle: hachureAngle ?? this.hachureAngle,
@@ -59,7 +86,7 @@ class FillerConfig {
 abstract class Filler {
   final FillerConfig config;
 
-  Filler(this.config);
+  Filler(this.config) : assert(config != null, 'FillerConfig could not be null');
 
   OpSet fill(List<PointD> points);
 
@@ -104,9 +131,9 @@ abstract class Filler {
           }
           List<Edge> removed = edges.sublist(0, ix + 1);
           edges.removeRange(0, ix + 1);
-          removed.forEach((edge) {
+          for (Edge edge in removed) {
             activeEdges.add(ActiveEdge(y, edge));
-          });
+          }
         }
         activeEdges = activeEdges.where((ae) => ae.edge.yMax > y).toList();
 
@@ -268,7 +295,7 @@ abstract class Filler {
 }
 
 class NoFiller extends Filler {
-  NoFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  NoFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {
@@ -277,7 +304,7 @@ class NoFiller extends Filler {
 }
 
 class HachureFiller extends Filler {
-  HachureFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  HachureFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {
@@ -286,7 +313,7 @@ class HachureFiller extends Filler {
 }
 
 class ZigZagFiller extends Filler {
-  ZigZagFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  ZigZagFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {
@@ -295,7 +322,7 @@ class ZigZagFiller extends Filler {
 }
 
 class HatchFiller extends Filler {
-  HatchFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  HatchFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {
@@ -307,7 +334,7 @@ class HatchFiller extends Filler {
 }
 
 class DashedFiller extends Filler {
-  DashedFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  DashedFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {
@@ -348,7 +375,7 @@ class DashedFiller extends Filler {
 }
 
 class DotFiller extends Filler {
-  DotFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  DotFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {
@@ -385,7 +412,7 @@ class DotFiller extends Filler {
 }
 
 class SolidFiller extends Filler {
-  SolidFiller([FillerConfig config = const FillerConfig()]) : super(config);
+  SolidFiller([FillerConfig config]) : super(config);
 
   @override
   OpSet fill(List<PointD> points) {