Background

In game dev, generative art, and creative coding, sine is a ubiquitous function that is often used as a spring-like oscillator for a given parameter.

On its own, sine has some undesirable qualities which most developers will encounter and adjust in isolated situations. The purpose of Bounded Sine is to solve these issues up-front in a reusable way:

Here's an example:

const fn = boundedSine({ yStart: 2, yMax: 3, yMin: 0 });

Bounded Sine also takes period and invert parameters. Note that when invert is true, f(0) does not always equal yStart because the function is reflected across its average y-value.

const fn = boundedSine({ yStart: 2, yMax: 3, yMin: 0, period: 10, invert: true });

API

Installation and Usage

yarn add bounded-sine

import { boundedSine } from "bounded-sine";
const fn = boundedSine({ yStart: 2, yMax: 3, yMin: 0 });
const yStart = fn(0)