📄 `Path.js`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	13
🧱 Classes	1
📦 Imports	7
📊 Variables & Constants	9

📚 Table of Contents¶

Imports
Variables & Constants
Functions
Classes

🛠️ File Location:¶

📂 src/extras/core/Path.js

📦 Imports¶

Name	Source
`Vector2`	`../../math/Vector2.js`
`CurvePath`	`./CurvePath.js`
`EllipseCurve`	`../curves/EllipseCurve.js`
`SplineCurve`	`../curves/SplineCurve.js`
`CubicBezierCurve`	`../curves/CubicBezierCurve.js`
`QuadraticBezierCurve`	`../curves/QuadraticBezierCurve.js`
`LineCurve`	`../curves/LineCurve.js`

Variables & Constants¶

Name	Type	Kind	Value	Exported
`curve`	`LineCurve`	let/var	`new LineCurve( this.currentPoint.clone(), new Vector2( x, y ) )`	✗
`curve`	`QuadraticBezierCurve`	let/var	`new QuadraticBezierCurve( this.currentPoint.clone(), new Vector2( aCPx, aCPy ...`	✗
`curve`	`CubicBezierCurve`	let/var	`new CubicBezierCurve( this.currentPoint.clone(), new Vector2( aCP1x, aCP1y ),...`	✗
`curve`	`SplineCurve`	let/var	`new SplineCurve( npts )`	✗
`x0`	`number`	let/var	`this.currentPoint.x`	✗
`y0`	`number`	let/var	`this.currentPoint.y`	✗
`x0`	`number`	let/var	`this.currentPoint.x`	✗
`y0`	`number`	let/var	`this.currentPoint.y`	✗
`curve`	`EllipseCurve`	let/var	`new EllipseCurve( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwis...`	✗

Functions¶

`Path.setFromPoints(points: Vector2[]): Path`¶

JSDoc:

/**
     * Creates a path from the given list of points. The points are added
     * to the path as instances of {@link LineCurve}.
     *
     * @param {Array<Vector2>} points - An array of 2D points.
     * @return {Path} A reference to this path.
     */

Parameters:

points Vector2[]

Returns: Path

Calls:

this.moveTo
this.lineTo

Code

setFromPoints( points ) {

        this.moveTo( points[ 0 ].x, points[ 0 ].y );

        for ( let i = 1, l = points.length; i < l; i ++ ) {

            this.lineTo( points[ i ].x, points[ i ].y );

        }

        return this;

    }

`Path.moveTo(x: number, y: number): Path`¶

JSDoc:

/**
     * Moves {@link Path#currentPoint} to the given point.
     *
     * @param {number} x - The x coordinate.
     * @param {number} y - The y coordinate.
     * @return {Path} A reference to this path.
     */

Parameters:

x number
y number

Returns: Path

Calls:

this.currentPoint.set

Code

moveTo( x, y ) {

        this.currentPoint.set( x, y ); // TODO consider referencing vectors instead of copying?

        return this;

    }

`Path.lineTo(x: number, y: number): Path`¶

JSDoc:

/**
     * Adds an instance of {@link LineCurve} to the path by connecting
     * the current point with the given one.
     *
     * @param {number} x - The x coordinate of the end point.
     * @param {number} y - The y coordinate of the end point.
     * @return {Path} A reference to this path.
     */

Parameters:

x number
y number

Returns: Path

Calls:

this.currentPoint.clone
this.curves.push
this.currentPoint.set

Code

lineTo( x, y ) {

        const curve = new LineCurve( this.currentPoint.clone(), new Vector2( x, y ) );
        this.curves.push( curve );

        this.currentPoint.set( x, y );

        return this;

    }

`Path.quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Path`¶

JSDoc:

/**
     * Adds an instance of {@link QuadraticBezierCurve} to the path by connecting
     * the current point with the given one.
     *
     * @param {number} aCPx - The x coordinate of the control point.
     * @param {number} aCPy - The y coordinate of the control point.
     * @param {number} aX - The x coordinate of the end point.
     * @param {number} aY - The y coordinate of the end point.
     * @return {Path} A reference to this path.
     */

Parameters:

aCPx number
aCPy number
aX number
aY number

Returns: Path

Calls:

this.currentPoint.clone
this.curves.push
this.currentPoint.set

Code

quadraticCurveTo( aCPx, aCPy, aX, aY ) {

        const curve = new QuadraticBezierCurve(
            this.currentPoint.clone(),
            new Vector2( aCPx, aCPy ),
            new Vector2( aX, aY )
        );

        this.curves.push( curve );

        this.currentPoint.set( aX, aY );

        return this;

    }

`Path.bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Path`¶

JSDoc:

/**
     * Adds an instance of {@link CubicBezierCurve} to the path by connecting
     * the current point with the given one.
     *
     * @param {number} aCP1x - The x coordinate of the first control point.
     * @param {number} aCP1y - The y coordinate of the first control point.
     * @param {number} aCP2x - The x coordinate of the second control point.
     * @param {number} aCP2y - The y coordinate of the second control point.
     * @param {number} aX - The x coordinate of the end point.
     * @param {number} aY - The y coordinate of the end point.
     * @return {Path} A reference to this path.
     */

Parameters:

aCP1x number
aCP1y number
aCP2x number
aCP2y number
aX number
aY number

Returns: Path

Calls:

this.currentPoint.clone
this.curves.push
this.currentPoint.set

Code

bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {

        const curve = new CubicBezierCurve(
            this.currentPoint.clone(),
            new Vector2( aCP1x, aCP1y ),
            new Vector2( aCP2x, aCP2y ),
            new Vector2( aX, aY )
        );

        this.curves.push( curve );

        this.currentPoint.set( aX, aY );

        return this;

    }

`Path.splineThru(pts: Vector2[]): Path`¶

JSDoc:

/**
     * Adds an instance of {@link SplineCurve} to the path by connecting
     * the current point with the given list of points.
     *
     * @param {Array<Vector2>} pts - An array of points in 2D space.
     * @return {Path} A reference to this path.
     */

Parameters:

pts Vector2[]

Returns: Path

Calls:

[ this.currentPoint.clone() ].concat
this.currentPoint.clone
this.curves.push
this.currentPoint.copy

Code

splineThru( pts ) {

        const npts = [ this.currentPoint.clone() ].concat( pts );

        const curve = new SplineCurve( npts );
        this.curves.push( curve );

        this.currentPoint.copy( pts[ pts.length - 1 ] );

        return this;

    }

`Path.arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

JSDoc:

/**
     * Adds an arc as an instance of {@link EllipseCurve} to the path, positioned relative
     * to the current point.
     *
     * @param {number} [aX=0] - The x coordinate of the center of the arc offsetted from the previous curve.
     * @param {number} [aY=0] - The y coordinate of the center of the arc offsetted from the previous curve.
     * @param {number} [aRadius=1] - The radius of the arc.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
     * @return {Path} A reference to this path.
     */

Parameters:

aX number
aY number
aRadius number
aStartAngle number
aEndAngle number
aClockwise boolean

Returns: Path

Calls:

this.absarc

Code

arc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {

        const x0 = this.currentPoint.x;
        const y0 = this.currentPoint.y;

        this.absarc( aX + x0, aY + y0, aRadius,
            aStartAngle, aEndAngle, aClockwise );

        return this;

    }

`Path.absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

JSDoc:

/**
     * Adds an absolutely positioned arc as an instance of {@link EllipseCurve} to the path.
     *
     * @param {number} [aX=0] - The x coordinate of the center of the arc.
     * @param {number} [aY=0] - The y coordinate of the center of the arc.
     * @param {number} [aRadius=1] - The radius of the arc.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
     * @return {Path} A reference to this path.
     */

Parameters:

aX number
aY number
aRadius number
aStartAngle number
aEndAngle number
aClockwise boolean

Returns: Path

Calls:

this.absellipse

Code

absarc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {

        this.absellipse( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );

        return this;

    }

`Path.ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

JSDoc:

/**
     * Adds an ellipse as an instance of {@link EllipseCurve} to the path, positioned relative
     * to the current point
     *
     * @param {number} [aX=0] - The x coordinate of the center of the ellipse offsetted from the previous curve.
     * @param {number} [aY=0] - The y coordinate of the center of the ellipse offsetted from the previous curve.
     * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
     * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
     * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
     * @return {Path} A reference to this path.
     */

Parameters:

aX number
aY number
xRadius number
yRadius number
aStartAngle number
aEndAngle number
aClockwise boolean
aRotation number

Returns: Path

Calls:

this.absellipse

Code

ellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {

        const x0 = this.currentPoint.x;
        const y0 = this.currentPoint.y;

        this.absellipse( aX + x0, aY + y0, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );

        return this;

    }

`Path.absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

JSDoc:

/**
     * Adds an absolutely positioned ellipse as an instance of {@link EllipseCurve} to the path.
     *
     * @param {number} [aX=0] - The x coordinate of the absolute center of the ellipse.
     * @param {number} [aY=0] - The y coordinate of the absolute center of the ellipse.
     * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
     * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
     * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
     * @return {Path} A reference to this path.
     */

Parameters:

aX number
aY number
xRadius number
yRadius number
aStartAngle number
aEndAngle number
aClockwise boolean
aRotation number

Returns: Path

Calls:

curve.getPoint
firstPoint.equals
this.lineTo
this.curves.push
this.currentPoint.copy

Internal Comments:

// if a previous curve is present, attempt to join (x2)

Code

absellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {

        const curve = new EllipseCurve( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );

        if ( this.curves.length > 0 ) {

            // if a previous curve is present, attempt to join
            const firstPoint = curve.getPoint( 0 );

            if ( ! firstPoint.equals( this.currentPoint ) ) {

                this.lineTo( firstPoint.x, firstPoint.y );

            }

        }

        this.curves.push( curve );

        const lastPoint = curve.getPoint( 1 );
        this.currentPoint.copy( lastPoint );

        return this;

    }

`Path.copy(source: any): this`¶

Parameters:

source any

Returns: this

Calls:

super.copy
this.currentPoint.copy

Code

copy( source ) {

        super.copy( source );

        this.currentPoint.copy( source.currentPoint );

        return this;

    }

`Path.toJSON(): any`¶

Returns: any

Calls:

super.toJSON
this.currentPoint.toArray

Code

toJSON() {

        const data = super.toJSON();

        data.currentPoint = this.currentPoint.toArray();

        return data;

    }

`Path.fromJSON(json: any): this`¶

Parameters:

json any

Returns: this

Calls:

super.fromJSON
this.currentPoint.fromArray

Code

fromJSON( json ) {

        super.fromJSON( json );

        this.currentPoint.fromArray( json.currentPoint );

        return this;

    }

Classes¶

`Path`¶

Class Code

class Path extends CurvePath {

    /**
     * Constructs a new path.
     *
     * @param {Array<Vector2>} [points] - An array of 2D points defining the path.
     */
    constructor( points ) {

        super();

        this.type = 'Path';

        /**
         * The current offset of the path. Any new curve added will start here.
         *
         * @type {Vector2}
         */
        this.currentPoint = new Vector2();

        if ( points ) {

            this.setFromPoints( points );

        }

    }

    /**
     * Creates a path from the given list of points. The points are added
     * to the path as instances of {@link LineCurve}.
     *
     * @param {Array<Vector2>} points - An array of 2D points.
     * @return {Path} A reference to this path.
     */
    setFromPoints( points ) {

        this.moveTo( points[ 0 ].x, points[ 0 ].y );

        for ( let i = 1, l = points.length; i < l; i ++ ) {

            this.lineTo( points[ i ].x, points[ i ].y );

        }

        return this;

    }

    /**
     * Moves {@link Path#currentPoint} to the given point.
     *
     * @param {number} x - The x coordinate.
     * @param {number} y - The y coordinate.
     * @return {Path} A reference to this path.
     */
    moveTo( x, y ) {

        this.currentPoint.set( x, y ); // TODO consider referencing vectors instead of copying?

        return this;

    }

    /**
     * Adds an instance of {@link LineCurve} to the path by connecting
     * the current point with the given one.
     *
     * @param {number} x - The x coordinate of the end point.
     * @param {number} y - The y coordinate of the end point.
     * @return {Path} A reference to this path.
     */
    lineTo( x, y ) {

        const curve = new LineCurve( this.currentPoint.clone(), new Vector2( x, y ) );
        this.curves.push( curve );

        this.currentPoint.set( x, y );

        return this;

    }

    /**
     * Adds an instance of {@link QuadraticBezierCurve} to the path by connecting
     * the current point with the given one.
     *
     * @param {number} aCPx - The x coordinate of the control point.
     * @param {number} aCPy - The y coordinate of the control point.
     * @param {number} aX - The x coordinate of the end point.
     * @param {number} aY - The y coordinate of the end point.
     * @return {Path} A reference to this path.
     */
    quadraticCurveTo( aCPx, aCPy, aX, aY ) {

        const curve = new QuadraticBezierCurve(
            this.currentPoint.clone(),
            new Vector2( aCPx, aCPy ),
            new Vector2( aX, aY )
        );

        this.curves.push( curve );

        this.currentPoint.set( aX, aY );

        return this;

    }

    /**
     * Adds an instance of {@link CubicBezierCurve} to the path by connecting
     * the current point with the given one.
     *
     * @param {number} aCP1x - The x coordinate of the first control point.
     * @param {number} aCP1y - The y coordinate of the first control point.
     * @param {number} aCP2x - The x coordinate of the second control point.
     * @param {number} aCP2y - The y coordinate of the second control point.
     * @param {number} aX - The x coordinate of the end point.
     * @param {number} aY - The y coordinate of the end point.
     * @return {Path} A reference to this path.
     */
    bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {

        const curve = new CubicBezierCurve(
            this.currentPoint.clone(),
            new Vector2( aCP1x, aCP1y ),
            new Vector2( aCP2x, aCP2y ),
            new Vector2( aX, aY )
        );

        this.curves.push( curve );

        this.currentPoint.set( aX, aY );

        return this;

    }

    /**
     * Adds an instance of {@link SplineCurve} to the path by connecting
     * the current point with the given list of points.
     *
     * @param {Array<Vector2>} pts - An array of points in 2D space.
     * @return {Path} A reference to this path.
     */
    splineThru( pts ) {

        const npts = [ this.currentPoint.clone() ].concat( pts );

        const curve = new SplineCurve( npts );
        this.curves.push( curve );

        this.currentPoint.copy( pts[ pts.length - 1 ] );

        return this;

    }

    /**
     * Adds an arc as an instance of {@link EllipseCurve} to the path, positioned relative
     * to the current point.
     *
     * @param {number} [aX=0] - The x coordinate of the center of the arc offsetted from the previous curve.
     * @param {number} [aY=0] - The y coordinate of the center of the arc offsetted from the previous curve.
     * @param {number} [aRadius=1] - The radius of the arc.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
     * @return {Path} A reference to this path.
     */
    arc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {

        const x0 = this.currentPoint.x;
        const y0 = this.currentPoint.y;

        this.absarc( aX + x0, aY + y0, aRadius,
            aStartAngle, aEndAngle, aClockwise );

        return this;

    }

    /**
     * Adds an absolutely positioned arc as an instance of {@link EllipseCurve} to the path.
     *
     * @param {number} [aX=0] - The x coordinate of the center of the arc.
     * @param {number} [aY=0] - The y coordinate of the center of the arc.
     * @param {number} [aRadius=1] - The radius of the arc.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the arc clockwise or not.
     * @return {Path} A reference to this path.
     */
    absarc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {

        this.absellipse( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );

        return this;

    }

    /**
     * Adds an ellipse as an instance of {@link EllipseCurve} to the path, positioned relative
     * to the current point
     *
     * @param {number} [aX=0] - The x coordinate of the center of the ellipse offsetted from the previous curve.
     * @param {number} [aY=0] - The y coordinate of the center of the ellipse offsetted from the previous curve.
     * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
     * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
     * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
     * @return {Path} A reference to this path.
     */
    ellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {

        const x0 = this.currentPoint.x;
        const y0 = this.currentPoint.y;

        this.absellipse( aX + x0, aY + y0, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );

        return this;

    }

    /**
     * Adds an absolutely positioned ellipse as an instance of {@link EllipseCurve} to the path.
     *
     * @param {number} [aX=0] - The x coordinate of the absolute center of the ellipse.
     * @param {number} [aY=0] - The y coordinate of the absolute center of the ellipse.
     * @param {number} [xRadius=1] - The radius of the ellipse in the x axis.
     * @param {number} [yRadius=1] - The radius of the ellipse in the y axis.
     * @param {number} [aStartAngle=0] - The start angle in radians.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle in radians.
     * @param {boolean} [aClockwise=false] - Whether to sweep the ellipse clockwise or not.
     * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
     * @return {Path} A reference to this path.
     */
    absellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {

        const curve = new EllipseCurve( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );

        if ( this.curves.length > 0 ) {

            // if a previous curve is present, attempt to join
            const firstPoint = curve.getPoint( 0 );

            if ( ! firstPoint.equals( this.currentPoint ) ) {

                this.lineTo( firstPoint.x, firstPoint.y );

            }

        }

        this.curves.push( curve );

        const lastPoint = curve.getPoint( 1 );
        this.currentPoint.copy( lastPoint );

        return this;

    }

    copy( source ) {

        super.copy( source );

        this.currentPoint.copy( source.currentPoint );

        return this;

    }

    toJSON() {

        const data = super.toJSON();

        data.currentPoint = this.currentPoint.toArray();

        return data;

    }

    fromJSON( json ) {

        super.fromJSON( json );

        this.currentPoint.fromArray( json.currentPoint );

        return this;

    }

}

Methods¶

`setFromPoints(points: Vector2[]): Path`¶

Code

setFromPoints( points ) {

        this.moveTo( points[ 0 ].x, points[ 0 ].y );

        for ( let i = 1, l = points.length; i < l; i ++ ) {

            this.lineTo( points[ i ].x, points[ i ].y );

        }

        return this;

    }

`moveTo(x: number, y: number): Path`¶

Code

moveTo( x, y ) {

        this.currentPoint.set( x, y ); // TODO consider referencing vectors instead of copying?

        return this;

    }

`lineTo(x: number, y: number): Path`¶

Code

lineTo( x, y ) {

        const curve = new LineCurve( this.currentPoint.clone(), new Vector2( x, y ) );
        this.curves.push( curve );

        this.currentPoint.set( x, y );

        return this;

    }

`quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Path`¶

Code

quadraticCurveTo( aCPx, aCPy, aX, aY ) {

        const curve = new QuadraticBezierCurve(
            this.currentPoint.clone(),
            new Vector2( aCPx, aCPy ),
            new Vector2( aX, aY )
        );

        this.curves.push( curve );

        this.currentPoint.set( aX, aY );

        return this;

    }

`bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Path`¶

Code

bezierCurveTo( aCP1x, aCP1y, aCP2x, aCP2y, aX, aY ) {

        const curve = new CubicBezierCurve(
            this.currentPoint.clone(),
            new Vector2( aCP1x, aCP1y ),
            new Vector2( aCP2x, aCP2y ),
            new Vector2( aX, aY )
        );

        this.curves.push( curve );

        this.currentPoint.set( aX, aY );

        return this;

    }

`splineThru(pts: Vector2[]): Path`¶

Code

splineThru( pts ) {

        const npts = [ this.currentPoint.clone() ].concat( pts );

        const curve = new SplineCurve( npts );
        this.curves.push( curve );

        this.currentPoint.copy( pts[ pts.length - 1 ] );

        return this;

    }

`arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

Code

arc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {

        const x0 = this.currentPoint.x;
        const y0 = this.currentPoint.y;

        this.absarc( aX + x0, aY + y0, aRadius,
            aStartAngle, aEndAngle, aClockwise );

        return this;

    }

`absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

Code

absarc( aX, aY, aRadius, aStartAngle, aEndAngle, aClockwise ) {

        this.absellipse( aX, aY, aRadius, aRadius, aStartAngle, aEndAngle, aClockwise );

        return this;

    }

`ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

Code

ellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {

        const x0 = this.currentPoint.x;
        const y0 = this.currentPoint.y;

        this.absellipse( aX + x0, aY + y0, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );

        return this;

    }

`absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

Code

absellipse( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation ) {

        const curve = new EllipseCurve( aX, aY, xRadius, yRadius, aStartAngle, aEndAngle, aClockwise, aRotation );

        if ( this.curves.length > 0 ) {

            // if a previous curve is present, attempt to join
            const firstPoint = curve.getPoint( 0 );

            if ( ! firstPoint.equals( this.currentPoint ) ) {

                this.lineTo( firstPoint.x, firstPoint.y );

            }

        }

        this.curves.push( curve );

        const lastPoint = curve.getPoint( 1 );
        this.currentPoint.copy( lastPoint );

        return this;

    }

`copy(source: any): this`¶

Code

copy( source ) {

        super.copy( source );

        this.currentPoint.copy( source.currentPoint );

        return this;

    }

`toJSON(): any`¶

Code

toJSON() {

        const data = super.toJSON();

        data.currentPoint = this.currentPoint.toArray();

        return data;

    }

`fromJSON(json: any): this`¶

Code

fromJSON( json ) {

        super.fromJSON( json );

        this.currentPoint.fromArray( json.currentPoint );

        return this;

    }

📄 Path.js¶

📊 Analysis Summary¶

📚 Table of Contents¶

🛠️ File Location:¶

📦 Imports¶

Variables & Constants¶

Functions¶

Path.setFromPoints(points: Vector2[]): Path¶

Path.moveTo(x: number, y: number): Path¶

Path.lineTo(x: number, y: number): Path¶

Path.quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Path¶

Path.bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Path¶

Path.splineThru(pts: Vector2[]): Path¶

Path.arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path¶

Path.absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path¶

Path.ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path¶

Path.absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path¶

Path.copy(source: any): this¶

Path.toJSON(): any¶

Path.fromJSON(json: any): this¶

Classes¶

Path¶

Methods¶

setFromPoints(points: Vector2[]): Path¶

moveTo(x: number, y: number): Path¶

lineTo(x: number, y: number): Path¶

quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Path¶

bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Path¶

splineThru(pts: Vector2[]): Path¶

arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path¶

absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path¶

ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path¶

absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path¶

copy(source: any): this¶

toJSON(): any¶

fromJSON(json: any): this¶

📄 `Path.js`¶

`Path.setFromPoints(points: Vector2[]): Path`¶

`Path.moveTo(x: number, y: number): Path`¶

`Path.lineTo(x: number, y: number): Path`¶

`Path.quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Path`¶

`Path.bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Path`¶

`Path.splineThru(pts: Vector2[]): Path`¶

`Path.arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

`Path.absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

`Path.ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

`Path.absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

`Path.copy(source: any): this`¶

`Path.toJSON(): any`¶

`Path.fromJSON(json: any): this`¶

`Path`¶

`setFromPoints(points: Vector2[]): Path`¶

`moveTo(x: number, y: number): Path`¶

`lineTo(x: number, y: number): Path`¶

`quadraticCurveTo(aCPx: number, aCPy: number, aX: number, aY: number): Path`¶

`bezierCurveTo(aCP1x: number, aCP1y: number, aCP2x: number, aCP2y: number, aX: number, aY: number): Path`¶

`splineThru(pts: Vector2[]): Path`¶

`arc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

`absarc(aX: number, aY: number, aRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean): Path`¶

`ellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

`absellipse(aX: number, aY: number, xRadius: number, yRadius: number, aStartAngle: number, aEndAngle: number, aClockwise: boolean, aRotation: number): Path`¶

`copy(source: any): this`¶

`toJSON(): any`¶

`fromJSON(json: any): this`¶