API Docs for: 0.1.5
Show:

Hypotrochoid Class

Defined in: src\hypotrochoid.js:30

Hypotrochoid. http://en.wikipedia.org/wiki/Hypotrochoid

Constructor

Hypotrochoid

(
  • [options]
)

Defined in src\hypotrochoid.js:30

Parameters:

  • [options] Object optional
    • The settings.
    • [R] Number optional
      • Radius of the outer circle.
    • [r] Number optional
      • Radius of the inner circle.
    • [d=0.0] Number optional
      • Distance from the center to the inner circle.
    • [origin={x: 0.0, y: 0.0}] Object optional
      • Object with x and y components, representing the origin coordinates.
    • [rotation=0.0] Number optional
      • Sets the rotational direction and speed. (Negative for left rotation, 0.0 for no rotation.)
    • [iterations=64] Number optional
      • Limits the processing of very detailed hypotrochoids.
    • [opacity=0.75] Number optional
      • The opacity.
    • [lineWidth=0.5] Number optional
      • The line width.
    • [colourRoll=true] Boolean optional
      • Whether the colour should change continuously.
    • [hue=0.0] Number optional
      • The hue in degree.
    • [saturation=100.0] Number optional
      • The saturation in percent.
    • [luminance=50.0] Number optional
      • The luminance in percent.

Methods

draw

(
  • ctx
)

Defined in src\hypotrochoid.js:325

Draws the hypotrochoid onto the given 2D-context. This function does not clear the canvas.

Parameters:

  • ctx CanvasRenderingContext2D
    • The surface to draw on.

equal

(
  • a
  • b
)
Boolean private static

Defined in src\hypotrochoid.js:13

Checks if two float values are (almost) equal.

Parameters:

  • a Number
    • Value a.
  • b Number
    • Value b.

Returns:

Boolean:

Whether the values are equal or not.

update

()

Defined in src\hypotrochoid.js:301

Updates hue and rotation.

Properties

colourRoll

Boolean

Defined in src\hypotrochoid.js:186

Colour roll flag.

d

Number

Defined in src\hypotrochoid.js:132

d.

EPSILON

Number private final static

Defined in src\hypotrochoid.js:1

A float threshold.

firstCoord

Object private

Defined in src\hypotrochoid.js:94

The first 2D-point in the draw process.

firstCoord

Object private

Defined in src\hypotrochoid.js:104

The previous 2D-point in the draw process.

hue

Number

Defined in src\hypotrochoid.js:195

The current hue.

iterations

Number

Defined in src\hypotrochoid.js:141

Maximum iteration count.

lineWidth

Number

Defined in src\hypotrochoid.js:177

The line width.

luminance

Number

Defined in src\hypotrochoid.js:213

The current limunance.

opacity

Object

Defined in src\hypotrochoid.js:168

the current opacity.

origin

Object

Defined in src\hypotrochoid.js:159

The origin of the hypotrochoid.

r

Number

Defined in src\hypotrochoid.js:114

r.

R

Number

Defined in src\hypotrochoid.js:123

R.

rInv

Number private

Defined in src\hypotrochoid.js:225

The inverted r value.

rotation

Number private

Defined in src\hypotrochoid.js:64

Current rotation.

rotationSpeed

Number

Defined in src\hypotrochoid.js:150

Rotation speed and direction.

saturation

Number

Defined in src\hypotrochoid.js:204

The current saturation.

settings

Object

Defined in src\hypotrochoid.js:237

The hypotrochoid's settings: { r, R, d, iterations, rotation, origin, opacity, lineWidth, colourRoll, saturation, luminance, hue }

step

Number private

Defined in src\hypotrochoid.js:84

Theta is incremented by step.

theta

Number private

Defined in src\hypotrochoid.js:74

Incremented by step, used to draw the hypotrochoid.

TWO_PI

Number private final

Defined in src\hypotrochoid.js:53

Pi * 2.