The path to add.
The model to add to.
The id of the path.
Optional flag to overwrite any path referenced by pathId. Default is false, which will create an id similar to pathId.
The original path (for cascading).
Alter a path by lengthening or shortening it.
Path to alter.
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.
Optional flag to alter from the origin instead of the end of the path.
The original path (for cascading), or null if the path could not be altered.
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.
A new path of the same type, when path type is line or arc. Returns null for circle.
Connect 2 lines at their slope intersection point.
First line to converge.
Second line to converge.
Optional flag to converge the origin point of lineA instead of the end point.
Optional flag to converge the origin point of lineB instead of the end point.
point of convergence.
Adds a round corner to the outside angle between 2 lines. The lines must meet at one point.
First line to fillet, which will be modified to fit the fillet.
Second line to fillet, which will be modified to fit the fillet.
Arc path object of the new fillet.
Adds a round corner to the inside angle between 2 paths. The paths must meet at one point.
First path to fillet, which will be modified to fit the fillet.
Second path to fillet, which will be modified to fit the fillet.
Radius of the fillet.
Optional IPointMatchOptions object to specify pointMatchingDistance.
Arc path object of the new fillet.
Find the point(s) where 2 paths intersect.
First path to find intersection.
Second path to find intersection.
Optional IPathIntersectionOptions.
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.
Move some paths relatively during a task execution, then unmove them.
The paths to move.
The x & y adjustments as a point object array.
The function to call while the paths are temporarily moved.
Represent an arc using straight lines.
Arc to straighten.
Optional flag to bevel the angle to prevent it from being too sharp.
Optional string prefix to apply to path ids.
Optional flag to make a closed geometry by connecting the endpoints.
Model of straight lines with same endpoints as the arc.
Get key points (a minimal a number of points) along a path.
Path to get points from.
Optional maximum length between points on an arc or circle.
Array of points which are on the path.
Get points along a path.
Path to get points from.
Number of points to divide the path.
Array of points which are on the path spread at a uniform interval.
Generated using TypeDoc
Add a path to a model. This is basically equivalent to:
parentModel.paths[pathId] = childPath;with additional checks to make it safe for cascading.