Global

Type Definitions

AahElementOptions

Type:
  • Object
Properties:
Name Type Description
armCount number

The number of arms for the Aah.
gapSDP number

The percentage of initial arm length (which is half the value of size) to use as a standard deviation when randomly varying central gap for each arm.
lengthSDP number

The percentage of initial arm length (which is half the value of size) to use as a standard deviation when randomly varying actual arm length.
rotate boolean

If true, rotate the final Aah a random number of degrees.
size number

The expected size of the Aah. The actual size will vary depending on random factors.
thetaSD number

The angle in degrees to use as a standard deviation when randomly varying the angles between the arms.
tipDistancePercent number

The percentage up the arm to place the tip. A valve if 100 puts the tip at the end of each arm.
tipDiameter number

The diameter of the tip. The special value of AahElement.tipType.gap makes the tip for each arm the same as that arm's gap.
any value

Any of the TangleElementOptions may be used here.
Source:

AahElementPlan

Type:
  • Object
Properties:
Name Type Description
sizeSDP number

The percentage of initial size to use as a standard deviation when randomly varying the size of each Aah.
desiredCount number

The number of Aah elements to try to draw. The actual number drawn will depend on how many will fit.
any value

Any of the AahOptions may be used here.
Source:

AahElementTipTypes

Type:
  • Object
Properties:
Name Type Description
any string

Any members of this object are preset tip types to indicate special processing
Source:

AahOptions

Type:
  • Object
Properties:
Name Type Description
plan AahPlan

A set of options for underlying elements.
any value

Any of the TangleOptions may be used here.
Source:

AahPlan

Type:
  • Object
Properties:
Name Type Description
aah AahElementPlan

Options for generating individual Aah elements.
dot DotElementPlan

Options for generating individual Dot elements.
Source:

AahPlans

Type:
  • Object
Properties:
Name Type Description
any AahPlan

Any members of this object are named AahPlan objects to be used as presets.
Source:

AmblerOptions

Type:
  • Object
Properties:
Name Type Description
any value

Any of the GridTangleOptions may be used here.
Source:

BoxSpiralElementOptions

Type:
  • Object
Properties:
Name Type Description
divisions number | Range

The number of divisions into which to subdivide the quadrilateral sides. The default is 4.
rotation string

The direction of the spiral. Must be 'ccw', 'cw' or 'random'. The default is 'ccw'.
startCorner string

The corner on which to start the spiral. Must be 'nw', 'ne', 'se', 'sw' or 'random'. The default is 'nw'.
size number

If size is specified, the quadrilateral is a square centered on the specified center.
nw Point

The northwest corner of the quadrilateral. Overrides size.
ne Point

The northeast corner of the quadrilateral. Overrides size.
se Point

The southeast corner of the quadrilateral. Overrides size.
sw Point

The southwest corner of the quadrilateral. Overrides size.
interior boolean

If true, do not touch the sides of the quadrilateral, draw the spiral inside the quadrilateral with two fewer divisions than specified. The default is false.
rotate number | Range

Number of degress to rotate the spiral.
any value

Any of the TangleElementOptions may be used here.
Source:

BoxSpiralOptions

Type:
  • Object
Properties:
Name Type Description
desiredCount number

The number of spirals to generate.
size number | Range

Size or size range of spirals to generate. The default is 50.
divisions number | Range

Number of divisions for each spiral.
any value

Any of the TangleOptions may be used here.
Source:

DotElementOptions

Type:
  • Object
Properties:
Name Type Description
size number | Range

Dot diameter.
spacing number

Relative dot spacing expressed as a percentage of diameter; defines the size of the enclosing polygon.
any value

Any of the TangleElementOptions may be used here.
Source:

DotElementPlan

Type:
  • Object
Properties:
Name Type Description
any value

Any of the DotOptions may be used here.
Source:

EmingleOptions

Type:
  • Object
Properties:
Name Type Description
startCorner string

The corner at which to start the box spiral. Can be 'nw', ne', 'se', 'sw' or 'random'. The default is 'nw'.
any value

Any of the GridTangleOptions may be used here.
Source:

GridTangleOptions

Type:
  • Object
Properties:
Name Type Description
gridShow boolean

If true, and this is a grid-based tangle, draw the grid lines after building the tangle. The default is true.
gridSpacing number | Range

The grid size in pixels. If used, both gridXSpacing and gridYSpacing are set to this.
gridXSpacing number | Range

The horizontal grid size in pixels. The default is 40. If set to a Range, the gridSpacingMode determines how that range is used.
gridYSpacing number | Range

The vertical grid size in pixels. The default is 40. If set to a Range, the gridSpacingMode determines how that range is used.
gridXSpacingMode string

The horizontal grid size in pixels. The default is 'static'.
gridYSpacingMode string

The vertical grid size in pixels. The default is 'static'.
gridVary number

The grid point location variation in pixels. If used, both gridXVary and gridYVary are set to this.
gridXVary number

The horizontal grid point location variation in pixels.
gridYVary number

The vertical grid point location variation in pixels.
gridDivisions number

The number of columns and rows the grid should have. If used, both gridXDivisions and gridYDivisions are set to this.
gridXDivisions number

The number of columns the grid should have. If not set, this is calculated from width and gridXSpacing.
gridYDivisions number

The number of rows the grid should have. If not set, this is calculated from height and gridYSpacing.
gridXOrigin number | Range

The x-coodinate of the upper left corner of the graph. The grid mode may modify this.
gridYOrigin number | Range

The y-coodinate of the upper left corner of the graph. The grid mode may modify this.
gridXFrequency number | Range

The grid horizontal wave frequency. The grid mode may ignore this or interpret it as it pleases.
gridYFrequency number | Range

The grid vertical wave frequency. The grid mode may ignore this or interpret it as it pleases.
gridXAmplitude number | Range

The grid horizontal wave amplitude. The grid mode may ignore this or interpret it as it pleases.
gridYAmplitude number | Range

The grid vertical wave amplitude. The grid mode may ignore this or interpret it as it pleases.
Source:

HugginsOptions

Type:
  • Object
Properties:
Name Type Description
holeDiameter number | string

The diameter of the dots in pixels. If set to 'proportional', which is the default, the diameter will be 1/8 if the smallest grid spacing.
holeFillColor p5.Color

The fill color for the dots. The default is 'black'.
holesShow boolean

If true, the dots will be drawn, otherwise they will be left out. The default is true.
curve number

If set to 1, the connecting lines will be straight. Increasing values add more curve to the lines. Extreme values distort the curves in interesting ways. The default is 5.
any value

Any of the GridTangleOptions may be used here.
Source:

TangleElementOptions

Type:
  • Object
Properties:
Name Type Description
debug number

The debug level.
fillColor p5.Color

The color with which to fill shapes.
strokeColor p5.Color

The color with which to draw lines.
Source:

TangleOptions

Type:
  • Object
Properties:
Name Type Description
debug number

The debug level.
background p5.Color

The color with which to fill the background.
polys Array.<object>

Polygons already drawn.
avoidCollisions boolean

If true, do not draw over other elements listed in this.polys. The default is true.
maskPoly Array.<Point>

A set of points defining a polygon. Only the portion of the image inside the polygon will be displayed, unless ignoreMask is true.
addStrings boolean

If true, the boundaries of the maskPoly are drawn. The default is true.
ignoreMask boolean

If true, do not mask the result, draw the entire rectangle. The default is false.
tangleRotate number

The number of degrees by which to rotate the tangle before applying the mask. The default is 0.
Source:

W2Options

Type:
  • Object
Properties:
Name Type Description
holeSize number | string

The size of the squares in pixels. If set to 'proportional', which is the default, the size will be 1/4 if the smallest grid spacing.
holeFillColor p5.Color

The fill color for the dots. The default is 'black'.
holesShow boolean

If true, the dots will be drawn, otherwise they will be left out. The default is true.
curve number

If set to 1, the connecting lines will be straight. Increasing values add more curve to the lines. Extreme values distort the curves in interesting ways. The default is 5.
any value

Any of the GridTangleOptions may be used here.
Source:

ZentangleOptions

Type:
  • Object
Properties:
Name Type Description
background p5.Color

The background of the Zentangle canvas.
borderSize number

The average width of the border in pixels.
any value

Any of the TangleElementOptions may be used here.
Source: