Skip to content

markroland/sand-table-pattern-maker

Repository files navigation

Sand Table Pattern Maker

Sand Table

Launch Pattern Maker

This is part of my Sand Table Build

Built with p5.js

Installation

npm install
npm run dev

Run using NPM

node sand-pattern.mjs --pattern=circle > circle.json

Or using the bin command:

sand-pattern --pattern=circle > circle.json

Controls

  • Press "o" to toggle an overlay of the pattern settings in the canvas
  • Press "c" to toggle the live coordinates and plotter mechanism view
  • Press "d" to download a heightmap PNG of the pattern.
  • Press "p" to play/pause playback of pattern.

How to Build a New Pattern

node ./scripts/create-new.js NewPatternName

Pattern classes are made up of at least 4 methods:

  • constructor - The class constructor defines a few aspect of the class including:
    • this.key - Used for identifying the class's properties in the main sketch file
    • this.name - Used for referencing the pattern in the UI.
    • this.config - This is an object that defines the pattern's input configuration options.
    • this.path - Initializes the pattern's output path coordinates
  • draw - This class is called by the main sketch to draw the pattern. It reads and updates the UI input values and sends the input to the class's calc method.
  • calc - This is where the algorithm for the pattern is implemented. Using the selected inputs, the method returns the coordinates for the complete path.

Once you've completed your design, submit a Pull Request and if it works, I'll merge it in. Thanks in advance!

Patterns

License

Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

This work is licensed under a Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License.

This work makes use of p5.js, which carries a GNU Lesser General Public License.

About

A tool for creating G-code commands to draw patterns

Topics

Resources

Stars

Watchers

Forks