Api - path Module

Index

Interfaces

Variables

Private breakPathFunctionMap

breakPathFunctionMap: IBreakPathFunctionMap

Private distortMap

distortMap: object

Type declaration

[pathType: string]: function
- - (pathValue: IPath, scaleX: number, scaleY: number): IModel | IPath
  - Parameters
    - pathValue: IPath
    - scaleX: number
    - scaleY: number
    Returns IModel | IPath

Private filletResultMap

filletResultMap: object

Type declaration

[pathType: string]: function
- - (pathContext: IPath, propertyName: string, filletRadius: number, filletCenter: IPoint): IFilletResult
  - Parameters
    - pathContext: IPath
    - propertyName: string
    - filletRadius: number
    - filletCenter: IPoint
    Returns IFilletResult

Private guidePathMap

guidePathMap: object

Type declaration

[pathType: string]: function
- - (pathContext: IPath, filletRadius: number, nearPoint: IPoint, shardPoint: IPoint, isStart: boolean): IPath
  - Parameters
    - pathContext: IPath
    - filletRadius: number
    - nearPoint: IPoint
    - shardPoint: IPoint
    - isStart: boolean
    Returns IPath

Private map

map: IPathIntersectionMap

Private mirrorMap

mirrorMap: object

Type declaration

[pathType: string]: function
- - (pathToMirror: IPath, origin: IPoint, mirrorX: boolean, mirrorY: boolean): IPath
  - Parameters
    - pathToMirror: IPath
    - origin: IPoint
    - mirrorX: boolean
    - mirrorY: boolean
    Returns IPath

Private moveMap

moveMap: object

Type declaration

[pathType: string]: function
- - (pathToMove: IPath, origin: IPoint): void
  - Parameters
    - pathToMove: IPath
    - origin: IPoint
    Returns void

Private moveRelativeMap

moveRelativeMap: object

Type declaration

[pathType: string]: function
- - (pathToMove: IPath, delta: IPoint, subtract: boolean): void
  - Parameters
    - pathToMove: IPath
    - delta: IPoint
    - subtract: boolean
    Returns void

Private propertyNamesMap

propertyNamesMap: object

Type declaration

[pathType: string]: function
- - (pathToInspect: IPath): string[]
  - Parameters
    - pathToInspect: IPath
    Returns string[]

Private rotateMap

rotateMap: object

Type declaration

[pathType: string]: function
- - (pathToRotate: IPath, angleInDegrees: number, rotationOrigin: IPoint): void
  - Parameters
    - pathToRotate: IPath
    - angleInDegrees: number
    - rotationOrigin: IPoint
    Returns void

Private scaleMap

scaleMap: object

Type declaration

[pathType: string]: function
- - (pathValue: IPath, scaleValue: number): void
  - Parameters
    - pathValue: IPath
    - scaleValue: number
    Returns void

Functions

breakAtPoint

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

- Defined in 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.

Private circleToCircle

circleToCircle(circle1: IPathCircle, circle2: IPathCircle, options: IPathIntersectionOptions): number[]

- Defined in core/intersect.ts:364
Parameters
- circle1: IPathCircle
- circle2: IPathCircle
- options: IPathIntersectionOptions
Returns number[]

clone

clone(pathToClone: IPath): IPath

- Defined in core/path.ts:18
Create a clone of a path. This is faster than cloneObject.

Parameters
- pathToClone: IPath
  
  The path to clone.
Returns IPath

Cloned path.

Private cloneAndBreakPath

cloneAndBreakPath(pathToShard: IPath, shardPoint: IPoint): IPath[]

- Defined in core/fillet.ts:130
Parameters
- pathToShard: IPath
- shardPoint: IPoint
Returns IPath[]

converge

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

- Defined in core/path.ts:347
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

Private copyLayer

copyLayer(pathA: IPath, pathB: IPath): void

- Defined in core/path.ts:6
Parameters
- pathA: IPath
- pathB: IPath
Returns void

distort

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

- Defined in core/path.ts:328
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 core/fillet.ts:306
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 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 core/fillet.ts:370
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
- Optional options: IPointMatchOptions
Returns IPathArc

Arc path object of the new fillet.

Private findCorrespondingAngleIndex

findCorrespondingAngleIndex(circleAngles: number[], arcAngle: number[]): number

- Defined in core/intersect.ts:254
Parameters
- circleAngles: number[]
- arcAngle: number[]
Returns number

Private getAnglesWithinArc

getAnglesWithinArc(angles: number[], arc: IPathArc, options: IPathIntersectionOptions): number[]

- Defined in core/intersect.ts:274
Parameters
- angles: number[]
- arc: IPathArc
- options: IPathIntersectionOptions
Returns number[]

Private getDogboneResult

getDogboneResult(context: IMatchPointProperty, filletCenter: IPoint): IFilletResult

- Defined in core/fillet.ts:244
Parameters
- context: IMatchPointProperty
- filletCenter: IPoint
Returns IFilletResult

Private getFilletResult

getFilletResult(context: IMatchPointProperty, filletRadius: number, filletCenter: IPoint): IFilletResult

- Defined in core/fillet.ts:226
Parameters
- context: IMatchPointProperty
- filletRadius: number
- filletCenter: IPoint
Returns IFilletResult

Private getGuidePath

getGuidePath(context: IMatchPointProperty, filletRadius: number, nearPoint: IPoint): IPath

- Defined in core/fillet.ts:166
Parameters
- context: IMatchPointProperty
- filletRadius: number
- nearPoint: IPoint
Returns IPath

Private getLineRatio

getLineRatio(lines: IPathLine[]): number

- Defined in core/fillet.ts:286
Parameters
- lines: IPathLine[]
Returns number

Private getMatchingPointProperties

getMatchingPointProperties(pathA: IPath, pathB: IPath, options?: IPointMatchOptions): IMatchPointProperty[]

- Defined in core/fillet.ts:68
Parameters
- pathA: IPath
- pathB: IPath
- Optional options: IPointMatchOptions
Returns IMatchPointProperty[]

Private getPointProperties

getPointProperties(pathToInspect: IPath): IPointProperty[]

- Defined in core/fillet.ts:45
Parameters
- pathToInspect: IPath
Returns IPointProperty[]

intersection

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

- Defined in 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.

Private lineToCircle

lineToCircle(line: IPathLine, circle: IPathCircle, options: IPathIntersectionOptions): number[]

- Defined in core/intersect.ts:294
Parameters
- line: IPathLine
- circle: IPathCircle
- options: IPathIntersectionOptions
Returns number[]

mirror

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

- Defined in core/path.ts:103
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 core/path.ts:137
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 chaining).

moveRelative

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

- Defined in core/path.ts:173
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 chaining).

Private moveTemp

moveTemp(pathsToOffset: IPath[], options: IPathIntersectionOptions, swapOffsets: boolean, task: Function): void

- Defined in core/intersect.ts:208
Parameters
- pathsToOffset: IPath[]
- options: IPathIntersectionOptions
- swapOffsets: boolean
- task: Function
Returns void

moveTemporary

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

- Defined in core/path.ts:195
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

Private pointsFromAnglesOnCircle

pointsFromAnglesOnCircle(anglesInDegrees: number[], circle: IPathCircle): IPoint[]

- Defined in core/intersect.ts:263
Parameters
- anglesInDegrees: number[]
- circle: IPathCircle
Returns IPoint[]

Private populateShardPointsFromReferenceCircle

populateShardPointsFromReferenceCircle(filletRadius: number, center: IPoint, properties: IMatchPointProperty[], options: IPointMatchOptions): boolean

- Defined in core/fillet.ts:103
Parameters
- filletRadius: number
- center: IPoint
- properties: IMatchPointProperty[]
- options: IPointMatchOptions
Returns boolean

rotate

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

- Defined in core/path.ts:238
Rotate a path.

Parameters
- pathToRotate: IPath
  
  The path to rotate.
- angleInDegrees: number
  
  The amount of rotation, in degrees.
- rotationOrigin: IPoint
  
  The center point of rotation.
Returns IPath

The original path (for chaining).

scale

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

- Defined in core/path.ts:278
Scale a path.

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

The original path (for chaining).

straighten

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

- Defined in core/expand.ts:51
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 prefix to apply to path ids.
- Optional close: boolean
Returns IModel

Model of straight lines with same endpoints as the arc.

Private swapAngles

swapAngles(result: IPathIntersection): IPathIntersection

- Defined in core/intersect.ts:216
Parameters
- result: IPathIntersection
Returns IPathIntersection

Private testFilletResult

testFilletResult(context: IMatchPointProperty, result: IFilletResult): boolean

- Defined in core/fillet.ts:262
Parameters
- context: IMatchPointProperty
- result: IFilletResult
Returns boolean

Generated using TypeDoc

Api - path Module

Index

Interfaces

Variables

Functions

Variables

Private breakPathFunctionMap

Private distortMap

Type declaration

[pathType: string]: function

Parameters

pathValue: IPath

scaleX: number

scaleY: number

Returns IModel | IPath

Private filletResultMap

Type declaration

[pathType: string]: function

Parameters

pathContext: IPath

propertyName: string

filletRadius: number

filletCenter: IPoint

Returns IFilletResult

Private guidePathMap

Type declaration

[pathType: string]: function

Parameters

pathContext: IPath

filletRadius: number

nearPoint: IPoint

shardPoint: IPoint

isStart: boolean

Returns IPath

Private map

Private mirrorMap

Type declaration

[pathType: string]: function

Parameters

pathToMirror: IPath

origin: IPoint

mirrorX: boolean

mirrorY: boolean

Returns IPath

Private moveMap

Type declaration

[pathType: string]: function

Parameters

pathToMove: IPath

origin: IPoint

Returns void

Private moveRelativeMap

Type declaration

[pathType: string]: function

Parameters

pathToMove: IPath

delta: IPoint

subtract: boolean

Returns void

Private propertyNamesMap

Type declaration

[pathType: string]: function

Parameters

pathToInspect: IPath

Returns string[]

Private rotateMap

Type declaration

[pathType: string]: function

Parameters

pathToRotate: IPath

angleInDegrees: number

rotationOrigin: IPoint

Returns void

Private scaleMap

Type declaration

[pathType: string]: function

Parameters

pathValue: IPath

scaleValue: number

Returns void