Added new example (#69)

* Added class Palette. Updated example.

* New library files. New example.

* Update documentation.

Author: stigmollerhansen

README.md

@@ -39,3 +39,5 @@ It is based on and inspired by a number of Processing library templates, includi
 I wish to thank the developers of these repositories, who generously provided
 guidance and time. This template has been developed in collaboration with
 [@enkatsu](https://github.com/enkatsu).
+
+The example library was developed by Stig Møller Hansen ([@stixan](https://github.com/stixan)).

build.gradle.kts

@@ -94,8 +94,8 @@ dependencies {
     compileOnly(group = "org.processing", name = "core", version = "4.3.1")
 
     // insert your external dependencies
-    implementation(group = "org.apache.commons", name = "commons-math3", version = "3.6.1")
-    // The provided example uses commons-math3. Replace or add as needed.
+    // For example uncomment the following line to declare commons-math3 as a dependency.
+    // implementation(group = "org.apache.commons", name = "commons-math3", version = "3.6.1")
 
     // To add a dependency on a Processing library that is installed locally,
     // uncomment the line below, and replace <library folder> with the location of that library

docs/develop.md

@@ -16,6 +16,9 @@ Intellij and Visual Studio Code will then direct you to move your code into nest
 with your package name. For instance, if the package is `com.myDomain.myLibrary`, the code will
 be in the folder structure `src/main/java/com/myDomain/myLibrary/`.
 
+If you would like to use Processing functionality in your library, you can do so by importing Processing core
+and referencing Processing objects from the PApplet instance. An example of how to do this is given in the
+example library in this template.
 
 ## Resolving dependencies
 In the `build.gradle.kts` file, there are a few places you should edit, to input your own values.
@@ -27,18 +30,13 @@ sections of the `build.gradle.kts` file are the `repositories` and `dependencies
 dependencies can be resolved from Maven. You can add additional repositories here if
 your dependencies are hosted elsewhere. 
 
-**Your dependencies should be listed within `dependencies`.** For example, the example library
-uses the `commons-math3` package from `org.apache.commons` as a dependency, which is resolved
-from your listed repositories. It is listed within `dependencies` with the following structure:
+**Your dependencies should be listed within `dependencies`.** For example, if the example library
+were to use the `commons-math3` package from `org.apache.commons` as a dependency, it would be listed within `dependencies` with the following structure:
 
 ```
 implementation(group = "org.apache.commons", name = "commons-math3", version = "3.6.1")
 ```
 
-This dependency, `commons-math3`, is only needed by the example library. 
-You can delete this dependency for your own library. 
-Add your own dependencies using the same structure.
-
 NOTE: Dependencies added with `implementation` will be included in the release. Dependencies
 added with `compileOnly`, such as Processing core, are available for compilation, but won't
 be included in the release.

docs/example_sketch_output.jpg

@@ -3,7 +3,7 @@
 The Processing Library Template is a template to help developers of Processing libraries to develop and release.
 It can be found on Github at [https://github.com/processing/processing-library-template](https://github.com/processing/processing-library-template).
 
-![example sketch output](./example_sketch_output.jpg)
+![example sketch output](./example_sketch_output.png)
 
 This documentation provides information on
 
@@ -36,3 +36,5 @@ It is based on and inspired by a number of Processing library templates, includi
 I wish to thank the developers of these repositories, who generously provided
 guidance and time. This template has been developed in collaboration with
 [@enkatsu](https://github.com/enkatsu).
+
+The example library was developed by Stig Møller Hansen ([@stixan](https://github.com/stixan)).

docs/example_sketch_output.png

@@ -1,24 +1,31 @@
 import com.myDomain.myLibrary.*;
 
-RandomCircles circles;
-SayHello hello;
+Palette p;
+Grid g;
 
 void setup() {
-  size(400,400);
-  smooth();
-
-  circles = new RandomCircles(this);
-  hello = new SayHello(this);
-  
-  PFont font = createFont("Arial", 40);
-  textFont(font);
+  size(1280, 720);
+  p = new Palette(this);
+  makeGrid();
 }
 
 void draw() {
-  background(0);
-  noStroke();
-  fill(255,0,0);
-  circles.drawCircles();
-  fill(255);
-  text(hello.text(), 40, 200);
+  background(16);
+  g.show();
+  displayText();
+}
+
+void mouseClicked() {
+  makeGrid();
 }
+
+void makeGrid() {
+  g = new Grid(this, p.getPalette());
+}
+
+void displayText() {
+  fill(240);
+  textAlign(CENTER, CENTER);
+  textSize(200);
+  text("Hello Library", width / 2, height / 2);
+}

docs/index.md

@@ -0,0 +1,108 @@
+package com.myDomain.myLibrary;
+
+import processing.core.PApplet;
+import processing.core.PConstants;
+
+import java.util.ArrayList;
+
+/**
+ * This is an example class within library myLibrary.
+ * Make sure you rename this class as well as the name of the example
+ * package 'com.myDomain.myLibrary' to your own library naming convention.
+ */
+
+public class Grid {
+
+    // parent is a reference to the parent sketch, and to Processing commands
+    PApplet parent;
+
+    ArrayList<Dot> dots;
+
+    /**
+     * a Constructor, usually called in the setup() method in your sketch to
+     * initialize and start the Library.
+     *
+     * @param theParent the parent PApplet
+     * @param palette   an array of color values from the Palette class
+     */
+    public Grid(PApplet theParent, int[] palette) {
+
+        // parent is a reference to the parent sketch, and to Processing commands
+        parent = theParent;
+
+        dots = new ArrayList<Dot>();
+
+        int gridSizeY = (int) parent.random(3, 16);
+        int gridSizeX = (int) (gridSizeY * ((float) parent.width / parent.height));
+        float cellSizeY = parent.height / (float) gridSizeY;
+        float cellSizeX = parent.width / (float) gridSizeX;
+        float dotSpeed = parent.random(0.008F, 0.064F);
+
+        for (int y = 0; y < gridSizeY; y++) {
+            for (int x = 0; x < gridSizeX; x++) {
+                float xpos = x * cellSizeX + cellSizeX / 2;
+                float ypos = y * cellSizeY + cellSizeY / 2;
+                int dotColor = palette[(int) parent.random(palette.length)];
+                dots.add(new Dot(xpos, ypos, PApplet.min(cellSizeX, cellSizeY), dotSpeed, dotColor));
+            }
+        }
+    }
+
+    /**
+     * show both updates and displays the grid by calling the
+     * update and display methods of the inline Dot class (see below)
+     */
+    public void show() {
+        for (Dot d : dots) {
+            d.update();
+            d.display();
+        }
+    }
+
+    // Dot is an inline class of the Grid class.
+    private class Dot {
+
+        float xpos, ypos;
+        float diameterOriginal, diameterCurrent;
+        float pulseValue, pulseSpeed;
+        int colorFill;
+
+        /**
+         * a Constructor called from the constructor of the parent Grid class.
+         *
+         * @param x horisontal position of the dot
+         * @param y vertical position of the dot
+         * @param d diameter of the dot
+         * @param s pulse speed of the dot
+         * @param c color of the dot
+         */
+        public Dot(float x, float y, float d, float s, int c) {
+            xpos = x;
+            ypos = y;
+            diameterOriginal = d;
+            diameterCurrent = diameterOriginal;
+            pulseValue = parent.random(PConstants.TWO_PI);
+            pulseSpeed = parent.random(s * 0.5F, s * 2.0F);
+            colorFill = c;
+        }
+
+        /**
+         * display draws a dot
+         */
+        public void display() {
+            parent.pushStyle();
+            parent.noStroke();
+            parent.circle(xpos, ypos, diameterCurrent);
+            parent.popStyle();
+            parent.fill(colorFill);
+        }
+
+        /**
+         * update updates the dots current diameter based on its pulse value and original diameter
+         */
+        public void update() {
+            pulseValue += pulseSpeed;
+            diameterCurrent = PApplet.map(PApplet.sin(pulseValue), -1, 1, diameterOriginal * 0.1F, diameterOriginal * 0.9F);
+        }
+    }
+}

examples/HelloCircles/HelloCircles.pde

@@ -0,0 +1,46 @@
+package com.myDomain.myLibrary;
+
+import processing.core.*;
+
+/**
+ * This is an example class within library myLibrary.
+ * Make sure you rename this class as well as the name of the example
+ * package 'com.myDomain.myLibrary' to your own library naming convention.
+ */
+
+public class Palette {
+
+    // parent is a reference to the parent sketch, and to Processing commands
+    PApplet parent;
+
+    /**
+     * a Constructor, usually called in the setup() method in your sketch to
+     * initialize and start the Library.
+     *
+     * @param theParent the parent PApplet
+     */
+    public Palette(PApplet theParent) {
+        this.parent = theParent;
+    }
+
+    /**
+     * getPalette returns a an array containing five colors defined as integers
+     */
+    public int[] getPalette() {
+        int numColors = 5;
+        int[] palette = new int[numColors];
+        this.parent.pushStyle();
+        this.parent.colorMode(PConstants.HSB, 1.0F, 1.0F, 1.0F);
+        int mix = this.parent.color(this.parent.random(1.0F), 1.0F, 1.0F);
+        float h, s, b;
+        for (int i = 0; i < palette.length; i++) {
+            h = (this.parent.random(1.0F) + this.parent.hue(mix)) / 2;
+            s = this.parent.random(0.8F, 1.0F);
+            b = this.parent.random(1.0F) < 0.2F ? 0.2F : 1.0F;
+            palette[i] = this.parent.color(h, s, b);
+        }
+        this.parent.popStyle();
+        return palette;
+    }
+
+}