Maker.js, a Microsoft Garage project, is a JavaScript library for creating and sharing modular line drawings for CNC and laser cutters.

View project on GitHub

Star

Api - ICascadePoint Interface

Hierarchy

ICascade
- ICascadePoint

Index

Properties

Methods

Properties

$initial

$initial: any

The initial context object of the cascade.

$reset

$reset: function

Use the $original as the $result.

Type declaration

- (): this
- Returns this

$result

$result: any

The current final value of the cascade.

Methods

add

add(b: IPoint, subtract?: boolean): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:437
Add two points together and return the result as a new point object.

Parameters
- b: IPoint
  
  Second point.
- Optional subtract: boolean
  
  Optional boolean to subtract instead of add.
Returns ICascadePoint

this cascade container, this.$result will be A new point object.

average

average(b: IPoint): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:446
Get the average of two points.

Parameters
- b: IPoint
  
  Second point.
Returns ICascadePoint

this cascade container, this.$result will be New point object which is the average of a and b.

clone

clone(): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:454
Clone a point into a new point.

Returns ICascadePoint

this cascade container, this.$result will be A new point with same values as the original.

closest

closest(pointOptions: IPoint[]): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:463
From an array of points, find the closest point to a given reference point.

Parameters
- pointOptions: IPoint[]
  
  Array of points to choose from.
Returns ICascadePoint

this cascade container, this.$result will be The first closest point from the pointOptions.

distort

distort(scaleX: number, scaleY: number): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:473
Distort a point's coordinates.

Parameters
- scaleX: number
  
  The amount of x scaling.
- scaleY: number
  
  The amount of y scaling.
Returns ICascadePoint

this cascade container, this.$result will be A new point.

mirror

mirror(mirrorX: boolean, mirrorY: boolean): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:483
Create a clone of a point, mirrored on either or both x and y axes.

Parameters
- mirrorX: boolean
  
  Boolean to mirror on the x axis.
- mirrorY: boolean
  
  Boolean to mirror on the y axis.
Returns ICascadePoint

this cascade container, this.$result will be Mirrored point.

rotate

rotate(angleInDegrees: number, rotationOrigin?: IPoint): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:493
Rotate a point.

Parameters
- angleInDegrees: number
  
  The amount of rotation, in degrees.
- Optional rotationOrigin: IPoint
  
  (default [0, 0]) The center point of rotation.
Returns ICascadePoint

this cascade container, this.$result will be A new point.

rounded

rounded(accuracy?: number): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:502
Round the values of a point.

Parameters
- Optional accuracy: number
  
  Optional exemplar number of decimal places.
Returns ICascadePoint

this cascade container, this.$result will be A new point with the values rounded.

scale

scale(scaleValue: number): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:511
Scale a point's coordinates.

Parameters
- scaleValue: number
  
  The amount of scaling.
Returns ICascadePoint

this cascade container, this.$result will be A new point.

subtract

subtract(b: IPoint): ICascadePoint

- Defined in src/maker.js/packages/maker.js/src/core/cascades.ts:520
Subtract a point from another point, and return the result as a new point. Shortcut to Add(a, b, subtract = true).

Parameters
- b: IPoint
  
  Second point.
Returns ICascadePoint

this cascade container, this.$result will be A new point object.

Generated using TypeDoc