Api - path Namespace

Index

Functions

addTo

addTo(childPath: IPath, parentModel: IModel, pathId: string, overwrite?: boolean): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:16
Add a path to a model. This is basically equivalent to:
```
parentModel.paths[pathId] = childPath;
```
with additional checks to make it safe for cascading.
Parameters
- childPath: IPath
  
  The path to add.
- parentModel: IModel
  
  The model to add to.
- pathId: string
  
  The id of the path.
- Default value overwrite: boolean = false
  
  Optional flag to overwrite any path referenced by pathId. Default is false, which will create an id similar to pathId.
Returns IPath

The original path (for cascading).

alterLength

alterLength(pathToAlter: IPath, distance: number, useOrigin?: boolean): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:488
Alter a path by lengthening or shortening it.

Parameters
- pathToAlter: IPath
  
  Path to alter.
- distance: number
  
  Numeric amount of length to add or remove from the path. Use a positive number to lengthen, negative to shorten. When shortening: this function will not alter the path and will return null if the resulting path length is less than or equal to zero.
- Default value useOrigin: boolean = false
  
  Optional flag to alter from the origin instead of the end of the path.
Returns IPath

The original path (for cascading), or null if the path could not be altered.

breakAtPoint

breakAtPoint(pathToBreak: IPath, pointOfBreak: IPoint): IPath

- Defined in src/maker.js/packages/maker.js/src/core/break.ts:96
Breaks a path in two. The supplied path will end at the supplied pointOfBreak, a new path is returned which begins at the pointOfBreak and ends at the supplied path's initial end point. For Circle, the original path will be converted in place to an Arc, and null is returned.

Parameters
- pathToBreak: IPath
  
  The path to break.
- pointOfBreak: IPoint
  
  The point at which to break the path.
Returns IPath

A new path of the same type, when path type is line or arc. Returns null for circle.

center

center(pathToCenter: IPath): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:600
Center a path at [0, 0].

Parameters
- pathToCenter: IPath
  
  The path to center.
Returns IPath

The original path (for cascading).

clone

clone(pathToClone: IPath, offset?: IPoint): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:66
Create a clone of a path. This is faster than cloneObject.

Parameters
- pathToClone: IPath
  
  The path to clone.
- Optional offset: IPoint
  
  Optional point to move path a relative distance.
Returns IPath

Cloned path.

converge

converge(lineA: IPathLine, lineB: IPathLine, useOriginA?: boolean, useOriginB?: boolean): IPoint

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:413
Connect 2 lines at their slope intersection point.

Parameters
- lineA: IPathLine
  
  First line to converge.
- lineB: IPathLine
  
  Second line to converge.
- Optional useOriginA: boolean
  
  Optional flag to converge the origin point of lineA instead of the end point.
- Optional useOriginB: boolean
  
  Optional flag to converge the origin point of lineB instead of the end point.
Returns IPoint

point of convergence.

copyProps

copyProps(srcPath: IPath, destPath: IPath): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:83
Copy the schema properties of one path to another.

Parameters
- srcPath: IPath
  
  The source path to copy property values from.
- destPath: IPath
  
  The destination path to copy property values to.
Returns IPath

The source path.

distort

distort(pathToDistort: IPath, scaleX: number, scaleY: number): IModel | IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:387
Distort a path - scale x and y individually.

Parameters
- pathToDistort: IPath
  
  The path to distort.
- scaleX: number
  
  The amount of x scaling.
- scaleY: number
  
  The amount of y scaling.
Returns IModel | IPath

A new IModel (for circles and arcs) or IPath (for lines and bezier seeds).

dogbone

dogbone(lineA: IPathLine, lineB: IPathLine, filletRadius: number, options?: IPointMatchOptions): IPathArc

- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:308
Adds a round corner to the outside angle between 2 lines. The lines must meet at one point.

Parameters
- lineA: IPathLine
  
  First line to fillet, which will be modified to fit the fillet.
- lineB: IPathLine
  
  Second line to fillet, which will be modified to fit the fillet.
- filletRadius: number
- Optional options: IPointMatchOptions
Returns IPathArc

Arc path object of the new fillet.

expand

expand(pathToExpand: IPath, expansion: number, isolateCaps?: boolean): IModel

- Defined in src/maker.js/packages/maker.js/src/core/expand.ts:28
Expand path by creating a model which surrounds it.

Parameters
- pathToExpand: IPath
  
  Path to expand.
- expansion: number
  
  Distance to expand.
- Optional isolateCaps: boolean
  
  Optional flag to put the end caps into a separate model named "caps".
Returns IModel

Model which surrounds the path.

fillet

fillet(pathA: IPath, pathB: IPath, filletRadius: number, options?: IPointMatchOptions): IPathArc

- Defined in src/maker.js/packages/maker.js/src/core/fillet.ts:375
Adds a round corner to the inside angle between 2 paths. The paths must meet at one point.

Parameters
- pathA: IPath
  
  First path to fillet, which will be modified to fit the fillet.
- pathB: IPath
  
  Second path to fillet, which will be modified to fit the fillet.
- filletRadius: number
  
  Radius of the fillet.
- Optional options: IPointMatchOptions
  
  Optional IPointMatchOptions object to specify pointMatchingDistance.
Returns IPathArc

Arc path object of the new fillet.

intersection

intersection(path1: IPath, path2: IPath, options?: IPathIntersectionOptions): IPathIntersection

- Defined in src/maker.js/packages/maker.js/src/core/intersect.ts:240
Find the point(s) where 2 paths intersect.

Parameters
- path1: IPath
  
  First path to find intersection.
- path2: IPath
  
  Second path to find intersection.
- Default value options: IPathIntersectionOptions = {}
  
  Optional IPathIntersectionOptions.
Returns IPathIntersection

IPathIntersection object, with points(s) of intersection (and angles, when a path is an arc or circle); or null if the paths did not intersect.

layer

layer(pathContext: IPath, layer: string): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:149
Set the layer of a path. This is equivalent to:
```
pathContext.layer = layer;
```
Parameters
- pathContext: IPath
  
  The path to set the layer.
- layer: string
  
  The layer name.
Returns IPath

The original path (for cascading).

mirror

mirror(pathToMirror: IPath, mirrorX: boolean, mirrorY: boolean): IPath

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

Parameters
- pathToMirror: IPath
  
  The path to mirror.
- mirrorX: boolean
  
  Boolean to mirror on the x axis.
- mirrorY: boolean
  
  Boolean to mirror on the y axis.
Returns IPath

Mirrored path.

move

move(pathToMove: IPath, origin: IPoint): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:196
Move a path to an absolute point.

Parameters
- pathToMove: IPath
  
  The path to move.
- origin: IPoint
  
  The new origin for the path.
Returns IPath

The original path (for cascading).

moveRelative

moveRelative(pathToMove: IPath, delta: IPoint, subtract?: boolean): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:232
Move a path's origin by a relative amount.

Parameters
- pathToMove: IPath
  
  The path to move.
- delta: IPoint
  
  The x & y adjustments as a point object.
- Optional subtract: boolean
  
  Optional boolean to subtract instead of add.
Returns IPath

The original path (for cascading).

moveTemporary

moveTemporary(pathsToMove: IPath[], deltas: IPoint[], task: Function): void

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:254
Move some paths relatively during a task execution, then unmove them.

Parameters
- pathsToMove: IPath[]
  
  The paths to move.
- deltas: IPoint[]
  
  The x & y adjustments as a point object array.
- task: Function
  
  The function to call while the paths are temporarily moved.
Returns void

rotate

rotate(pathToRotate: IPath, angleInDegrees: number, rotationOrigin?: IPoint): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:297
Rotate a path.

Parameters
- pathToRotate: IPath
  
  The path to rotate.
- angleInDegrees: number
  
  The amount of rotation, in degrees.
- Default value rotationOrigin: IPoint = [0, 0]
  
  The center point of rotation.
Returns IPath

The original path (for cascading).

scale

scale(pathToScale: IPath, scaleValue: number): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:337
Scale a path.

Parameters
- pathToScale: IPath
  
  The path to scale.
- scaleValue: number
  
  The amount of scaling.
Returns IPath

The original path (for cascading).

straighten

straighten(arc: IPathArc, bevel?: boolean, prefix?: string, close?: boolean): IModel

- Defined in src/maker.js/packages/maker.js/src/core/expand.ts:52
Represent an arc using straight lines.

Parameters
- arc: IPathArc
  
  Arc to straighten.
- Optional bevel: boolean
  
  Optional flag to bevel the angle to prevent it from being too sharp.
- Optional prefix: string
  
  Optional string prefix to apply to path ids.
- Optional close: boolean
  
  Optional flag to make a closed geometry by connecting the endpoints.
Returns IModel

Model of straight lines with same endpoints as the arc.

toKeyPoints

toKeyPoints(pathContext: IPath, maxArcFacet?: number): IPoint[]

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:562
Get key points (a minimal a number of points) along a path.

Parameters
- pathContext: IPath
  
  Path to get points from.
- Optional maxArcFacet: number
  
  Optional maximum length between points on an arc or circle.
Returns IPoint[]

Array of points which are on the path.

toPoints

toPoints(pathContext: IPath, numberOfPoints: number): IPoint[]

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:512
Get points along a path.

Parameters
- pathContext: IPath
  
  Path to get points from.
- numberOfPoints: number
  
  Number of points to divide the path.
Returns IPoint[]

Array of points which are on the path spread at a uniform interval.

zero

zero(pathToZero: IPath): IPath

- Defined in src/maker.js/packages/maker.js/src/core/path.ts:614
Move a path so its bounding box begins at [0, 0].

Parameters
- pathToZero: IPath
  
  The path to zero.
Returns IPath

The original path (for cascading).

Generated using TypeDoc

Api - path Namespace

Index

Functions

Functions

addTo

Parameters

childPath: IPath

parentModel: IModel

pathId: string

Default value overwrite: boolean = false

Returns IPath

alterLength

Parameters

pathToAlter: IPath

distance: number

Default value useOrigin: boolean = false

Returns IPath

breakAtPoint

Parameters

pathToBreak: IPath

pointOfBreak: IPoint

Returns IPath

center

Parameters

pathToCenter: IPath

Returns IPath

clone

Parameters

pathToClone: IPath

Optional offset: IPoint

Returns IPath

converge

Parameters

lineA: IPathLine

lineB: IPathLine

Optional useOriginA: boolean

Optional useOriginB: boolean

Returns IPoint

copyProps

Parameters

srcPath: IPath

destPath: IPath

Returns IPath

distort

Parameters

pathToDistort: IPath

scaleX: number

scaleY: number

Returns IModel | IPath

dogbone

Parameters

lineA: IPathLine

lineB: IPathLine

filletRadius: number

Optional options: IPointMatchOptions

Returns IPathArc

expand

Parameters

pathToExpand: IPath

expansion: number

Optional isolateCaps: boolean

Returns IModel

fillet

Parameters

pathA: IPath

pathB: IPath

filletRadius: number

Optional options: IPointMatchOptions

Returns IPathArc

intersection

Parameters

path1: IPath

path2: IPath

Default value options: IPathIntersectionOptions = {}

Returns IPathIntersection

layer

Parameters

pathContext: IPath

layer: string

Returns IPath