Function customShapes

src/shape/custom_shapes.js:1541–3034

(p5, fn)

}

function customShapes(p5, fn) {
  // ---- GENERAL CLASSES ----

  /**
   * @private
   * A class to describe a custom shape made with `beginShape()`/`endShape()`.
   *
   * Every `Shape` has a `kind`. The kind takes any value that
   * can be passed to <a href="#/p5/beginShape">beginShape()</a>:
   *
   * - `PATH`
   * - `POINTS`
   * - `LINES`
   * - `TRIANGLES`
   * - `QUADS`
   * - `TRIANGLE_FAN`
   * - `TRIANGLE_STRIP`
   * - `QUAD_STRIP`
   *
   * A `Shape` of any kind consists of `contours`, which can be thought of as
   * subshapes (shapes inside another shape). Each `contour` is built from
   * basic shapes called primitives, and each primitive consists of one or more vertices.
   *
   * For example, a square can be made from a single path contour with four line-segment
   * primitives. Each line segment contains a vertex that indicates its endpoint. A square
   * with a circular hole in it contains the circle in a separate contour.
   *
   * By default, each vertex only has a position, but a shape's vertices may have other
   * properties such as texture coordinates, a normal vector, a fill color, and a stroke color.
   * The properties every vertex should have may be customized by passing `vertexProperties` to
   * `createShape()`.
   *
   * Once a shape is created and given a name like `myShape`, it can be built up with
   * methods such as `myShape.beginShape()`, `myShape.vertex()`, and `myShape.endShape()`.
   *
   * Vertex functions such as `vertex()` or `bezierVertex()` are used to set the `position`
   * property of vertices, as well as the `textureCoordinates` property if applicable. Those
   * properties only apply to a single vertex.
   *
   * If `vertexProperties` includes other properties, they are each set by a method of the
   * same name. For example, if vertices in `myShape` have a `fill`, then that is set with
   * `myShape.fill()`. In the same way that a <a href="#/p5/fill">fill()</a> may be applied
   * to one or more shapes, `myShape.fill()` may be applied to one or more vertices.
   *
   * @class p5.Shape
   * @param {Object} [vertexProperties={position: createVector(0, 0)}] vertex properties and their initial values.
   */

  p5.Shape = Shape;

  /**
   * @private
   * A class to describe a contour made with `beginContour()`/`endContour()`.
   *
   * Contours may be thought of as shapes inside of other shapes.
   * For example, a contour may be used to create a hole in a shape that is created
   * with <a href="#/p5/beginShape">beginShape()</a>/<a href="#/p5/endShape">endShape()</a>.
   * Multiple contours may be included inside a single shape.