Global

Members

(constant) arc

Function to create arc equivalent to "new" constructor
Source:

(constant) box

Shortcut to create new box
Source:

(constant) CCW :boolean

Global constant CCW defines counterclockwise direction of arc
Source:
Type:
  • boolean

(constant) circle

Shortcut to create new circle
Source:

(constant) CW :boolean

Global constant CW defines clockwise direction of arc
Source:
Type:
  • boolean

DP_TOL :number

Floating point comparison tolerance. Default value is 0.000001 (10e-6)
Source:
Type:
  • number

(constant) inversion

Shortcut to create inversion operator
Source:

(constant) line

Function to create line equivalent to "new" constructor
Source:

(constant) matrix

Function to create matrix equivalent to "new" constructor
Source:

(constant) multiline

Shortcut function to create multiline
Source:

(constant) ORIENTATION :Object

Defines orientation for face of the polygon: clockwise, counterclockwise or not orientable in the case of self-intersection
Source:
Type:
  • Object

(constant) point

Function to create point equivalent to "new" constructor
Source:

(constant) polygon

Shortcut method to create new polygon
Source:

(constant) segment

Shortcut method to create new segment
Source:

(constant) vector

Function to create vector equivalent to "new" constructor
Source:

Methods

EQ(x, y) → {boolean}

Returns *true* if two values are equal up to DP_TOL
Source:
Parameters:
Name Type Description
x number
y number
Returns:
Type:
boolean

EQ_0(x, y) → {boolean}

Returns *true* if value comparable to zero
Source:
Parameters:
Name Type Description
x number
y number
Returns:
Type:
boolean

GE(x, y) → {boolean}

Returns *true* if first argument greater than or equal to second argument up to DP_TOL
Source:
Parameters:
Name Type Description
x number
y number
Returns:
Type:
boolean

getTolerance() → {number}

Get floating point comparison tolerance
Source:
Returns:
Type:
number

GT(x, y) → {boolean}

Returns *true* if first argument greater than second argument up to DP_TOL
Source:
Parameters:
Name Type Description
x number
y number
Returns:
Type:
boolean

isWktString(str) → {boolean}

Return true if given string starts with one of WKT tags and possibly contains WKT string,
Source:
Parameters:
Name Type Description
str
Returns:
Type:
boolean

LE(x, y) → {boolean}

Returns *true* if first argument less than or equal to second argument up to DP_TOL
Source:
Parameters:
Name Type Description
x number
y number
Returns:
Type:
boolean

LT(x, y) → {boolean}

Returns *true* if first argument less than second argument up to DP_TOL
Source:
Parameters:
Name Type Description
x number
y number
Returns:
Type:
boolean

parseWKT(str) → {Point|Array.<Point>|Multiline|Array.<Multiline>|Polygon|Array.<Shape>|null}

Convert WKT string to array of Flatten shapes.
Source:
Parameters:
Name Type Description
str
Returns:
Type:
Point | Array.<Point> | Multiline | Array.<Multiline> | Polygon | Array.<Shape> | null

setTolerance(tolerance)

Set new floating point comparison tolerance
Source:
Parameters:
Name Type Description
tolerance number