Giter Club home page Giter Club logo

harmonograph-xy's Introduction

@harmonograph/xy

๐Ÿ‘ฉโ€๐ŸŽจ Generate a harmonographs X and Y coordinates

Install

npm install @harmonograph/xy

Get started

The harmonograph is a mechanical apparatus that uses pendulums to create a geometric image. This function uses the drawing time, size and pendulums to create X and Y coordinates for a harmonograph.

If you wish to draw the harmonograph for use on a website you can use @harmonograph/svg.

Create harmonograph XY coordinates

const generateHarmonographXY = require('@harmonograph/xy');

const harmonograph = generateHarmonographXY(
  150,
  700,
  [{
    amplitude: 200, frequency: 2.985, phase: 2.054, damping: 0.001
  },
  {
    amplitude: 200, frequency: 3.006, phase: 1.820, damping: 0.008
  },
  {
    amplitude: 200, frequency: 3.003, phase: 2.283, damping: 0.001
  },
  {
    amplitude: 200, frequency: 1.994, phase: 1.155, damping: 0.001
  }]
);

This returns an object containing an array of X and Y coordinates. When drawn these points create a harmonograph.

{
  x: [1, 2, 3],
  y: [1, 3, 9]
}

Create randomised harmonograph XY coordinates

const generateHarmonographXY = require('@harmonograph/xy');
const {randomPendulums} = require('@harmonograph/xy');

const harmonograph = generateHarmonographXY(150, 700, randomPendulums());

Options

Option Description Default value Type
drawingTime How long the pendulum swings in seconds 150 number
size The size of the svg 700 number
pendulums Two pendulums require four items ( x, y and x, y ). Each X and Y value is an object that contains amplitude, frequency, phase, and damping ( see pendulum options below ) random values array

Pendulums object

Parameter Description Default value Type
pendulum.amplitude How far a pendulum swings back and forth, must be from 0 - 360 degrees random number number
pendulum.frequency How fast a pendulum swings back and forth, for best results use decimal values around 2 and 3 random number number
pendulum.phase The rate that a pendulum loses its energy, or slows down, must be from 0 to ฯ€ random number number
pendulum.damping The offset from the normal starting position of a pendulum, must be from 0 to 0.01 random number number

Release History

  • v0.0.0 - ๐Ÿ’ฅ Initial version

harmonograph-xy's People

Contributors

dependabot[bot] avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

romellogoodman

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.