📄 `EllipseCurve.js`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	4
🧱 Classes	1
📦 Imports	2
📊 Variables & Constants	9

📚 Table of Contents¶

Imports
Variables & Constants
Functions
Classes

🛠️ File Location:¶

📂 src/extras/curves/EllipseCurve.js

📦 Imports¶

Name	Source
`Curve`	`../core/Curve.js`
`Vector2`	`../../math/Vector2.js`

Variables & Constants¶

Name	Type	Kind	Value	Exported
`point`	`Vector2`	let/var	`optionalTarget`	✗
`twoPi`	`number`	let/var	`Math.PI * 2`	✗
`deltaAngle`	`number`	let/var	`this.aEndAngle - this.aStartAngle`	✗
`samePoints`	`boolean`	let/var	`Math.abs( deltaAngle ) < Number.EPSILON`	✗
`angle`	`number`	let/var	`this.aStartAngle + t * deltaAngle`	✗
`x`	`number`	let/var	`this.aX + this.xRadius * Math.cos( angle )`	✗
`y`	`number`	let/var	`this.aY + this.yRadius * Math.sin( angle )`	✗
`tx`	`number`	let/var	`x - this.aX`	✗
`ty`	`number`	let/var	`y - this.aY`	✗

Functions¶

`EllipseCurve.getPoint(t: number, optionalTarget: Vector2): Vector2`¶

JSDoc:

/**
     * Returns a point on the curve.
     *
     * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
     * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
     * @return {Vector2} The position on the curve.
     */

Parameters:

t number
optionalTarget Vector2

Returns: Vector2

Calls:

Math.abs
Math.cos
Math.sin
point.set

Internal Comments:

// ensures that deltaAngle is 0 .. 2 PI
// Rotate the point about the center of the ellipse. (x3)

Code

getPoint( t, optionalTarget = new Vector2() ) {

        const point = optionalTarget;

        const twoPi = Math.PI * 2;
        let deltaAngle = this.aEndAngle - this.aStartAngle;
        const samePoints = Math.abs( deltaAngle ) < Number.EPSILON;

        // ensures that deltaAngle is 0 .. 2 PI
        while ( deltaAngle < 0 ) deltaAngle += twoPi;
        while ( deltaAngle > twoPi ) deltaAngle -= twoPi;

        if ( deltaAngle < Number.EPSILON ) {

            if ( samePoints ) {

                deltaAngle = 0;

            } else {

                deltaAngle = twoPi;

            }

        }

        if ( this.aClockwise === true && ! samePoints ) {

            if ( deltaAngle === twoPi ) {

                deltaAngle = - twoPi;

            } else {

                deltaAngle = deltaAngle - twoPi;

            }

        }

        const angle = this.aStartAngle + t * deltaAngle;
        let x = this.aX + this.xRadius * Math.cos( angle );
        let y = this.aY + this.yRadius * Math.sin( angle );

        if ( this.aRotation !== 0 ) {

            const cos = Math.cos( this.aRotation );
            const sin = Math.sin( this.aRotation );

            const tx = x - this.aX;
            const ty = y - this.aY;

            // Rotate the point about the center of the ellipse.
            x = tx * cos - ty * sin + this.aX;
            y = tx * sin + ty * cos + this.aY;

        }

        return point.set( x, y );

    }

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

Parameters:

source any

Returns: this

Calls:

super.copy

Code

copy( source ) {

        super.copy( source );

        this.aX = source.aX;
        this.aY = source.aY;

        this.xRadius = source.xRadius;
        this.yRadius = source.yRadius;

        this.aStartAngle = source.aStartAngle;
        this.aEndAngle = source.aEndAngle;

        this.aClockwise = source.aClockwise;

        this.aRotation = source.aRotation;

        return this;

    }

`EllipseCurve.toJSON(): any`¶

Returns: any

Calls:

super.toJSON

Code

toJSON() {

        const data = super.toJSON();

        data.aX = this.aX;
        data.aY = this.aY;

        data.xRadius = this.xRadius;
        data.yRadius = this.yRadius;

        data.aStartAngle = this.aStartAngle;
        data.aEndAngle = this.aEndAngle;

        data.aClockwise = this.aClockwise;

        data.aRotation = this.aRotation;

        return data;

    }

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

Parameters:

json any

Returns: this

Calls:

super.fromJSON

Code

fromJSON( json ) {

        super.fromJSON( json );

        this.aX = json.aX;
        this.aY = json.aY;

        this.xRadius = json.xRadius;
        this.yRadius = json.yRadius;

        this.aStartAngle = json.aStartAngle;
        this.aEndAngle = json.aEndAngle;

        this.aClockwise = json.aClockwise;

        this.aRotation = json.aRotation;

        return this;

    }

Classes¶

`EllipseCurve`¶

Class Code

class EllipseCurve extends Curve {

    /**
     * Constructs a new ellipse curve.
     *
     * @param {number} [aX=0] - The X center of the ellipse.
     * @param {number} [aY=0] - The Y center of the ellipse.
     * @param {number} [xRadius=1] - The radius of the ellipse in the x direction.
     * @param {number} [yRadius=1] - The radius of the ellipse in the y direction.
     * @param {number} [aStartAngle=0] - The start angle of the curve in radians starting from the positive X axis.
     * @param {number} [aEndAngle=Math.PI*2] - The end angle of the curve in radians starting from the positive X axis.
     * @param {boolean} [aClockwise=false] - Whether the ellipse is drawn clockwise or not.
     * @param {number} [aRotation=0] - The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
     */
    constructor( aX = 0, aY = 0, xRadius = 1, yRadius = 1, aStartAngle = 0, aEndAngle = Math.PI * 2, aClockwise = false, aRotation = 0 ) {

        super();

        /**
         * This flag can be used for type testing.
         *
         * @type {boolean}
         * @readonly
         * @default true
         */
        this.isEllipseCurve = true;

        this.type = 'EllipseCurve';

        /**
         * The X center of the ellipse.
         *
         * @type {number}
         * @default 0
         */
        this.aX = aX;

        /**
         * The Y center of the ellipse.
         *
         * @type {number}
         * @default 0
         */
        this.aY = aY;

        /**
         * The radius of the ellipse in the x direction.
         * Setting the this value equal to the {@link EllipseCurve#yRadius} will result in a circle.
         *
         * @type {number}
         * @default 1
         */
        this.xRadius = xRadius;

        /**
         * The radius of the ellipse in the y direction.
         * Setting the this value equal to the {@link EllipseCurve#xRadius} will result in a circle.
         *
         * @type {number}
         * @default 1
         */
        this.yRadius = yRadius;

        /**
         * The start angle of the curve in radians starting from the positive X axis.
         *
         * @type {number}
         * @default 0
         */
        this.aStartAngle = aStartAngle;

        /**
         * The end angle of the curve in radians starting from the positive X axis.
         *
         * @type {number}
         * @default Math.PI*2
         */
        this.aEndAngle = aEndAngle;

        /**
         * Whether the ellipse is drawn clockwise or not.
         *
         * @type {boolean}
         * @default false
         */
        this.aClockwise = aClockwise;

        /**
         * The rotation angle of the ellipse in radians, counterclockwise from the positive X axis.
         *
         * @type {number}
         * @default 0
         */
        this.aRotation = aRotation;

    }

    /**
     * Returns a point on the curve.
     *
     * @param {number} t - A interpolation factor representing a position on the curve. Must be in the range `[0,1]`.
     * @param {Vector2} [optionalTarget] - The optional target vector the result is written to.
     * @return {Vector2} The position on the curve.
     */
    getPoint( t, optionalTarget = new Vector2() ) {

        const point = optionalTarget;

        const twoPi = Math.PI * 2;
        let deltaAngle = this.aEndAngle - this.aStartAngle;
        const samePoints = Math.abs( deltaAngle ) < Number.EPSILON;

        // ensures that deltaAngle is 0 .. 2 PI
        while ( deltaAngle < 0 ) deltaAngle += twoPi;
        while ( deltaAngle > twoPi ) deltaAngle -= twoPi;

        if ( deltaAngle < Number.EPSILON ) {

            if ( samePoints ) {

                deltaAngle = 0;

            } else {

                deltaAngle = twoPi;

            }

        }

        if ( this.aClockwise === true && ! samePoints ) {

            if ( deltaAngle === twoPi ) {

                deltaAngle = - twoPi;

            } else {

                deltaAngle = deltaAngle - twoPi;

            }

        }

        const angle = this.aStartAngle + t * deltaAngle;
        let x = this.aX + this.xRadius * Math.cos( angle );
        let y = this.aY + this.yRadius * Math.sin( angle );

        if ( this.aRotation !== 0 ) {

            const cos = Math.cos( this.aRotation );
            const sin = Math.sin( this.aRotation );

            const tx = x - this.aX;
            const ty = y - this.aY;

            // Rotate the point about the center of the ellipse.
            x = tx * cos - ty * sin + this.aX;
            y = tx * sin + ty * cos + this.aY;

        }

        return point.set( x, y );

    }

    copy( source ) {

        super.copy( source );

        this.aX = source.aX;
        this.aY = source.aY;

        this.xRadius = source.xRadius;
        this.yRadius = source.yRadius;

        this.aStartAngle = source.aStartAngle;
        this.aEndAngle = source.aEndAngle;

        this.aClockwise = source.aClockwise;

        this.aRotation = source.aRotation;

        return this;

    }

    toJSON() {

        const data = super.toJSON();

        data.aX = this.aX;
        data.aY = this.aY;

        data.xRadius = this.xRadius;
        data.yRadius = this.yRadius;

        data.aStartAngle = this.aStartAngle;
        data.aEndAngle = this.aEndAngle;

        data.aClockwise = this.aClockwise;

        data.aRotation = this.aRotation;

        return data;

    }

    fromJSON( json ) {

        super.fromJSON( json );

        this.aX = json.aX;
        this.aY = json.aY;

        this.xRadius = json.xRadius;
        this.yRadius = json.yRadius;

        this.aStartAngle = json.aStartAngle;
        this.aEndAngle = json.aEndAngle;

        this.aClockwise = json.aClockwise;

        this.aRotation = json.aRotation;

        return this;

    }

}

Methods¶

`getPoint(t: number, optionalTarget: Vector2): Vector2`¶

Code

getPoint( t, optionalTarget = new Vector2() ) {

        const point = optionalTarget;

        const twoPi = Math.PI * 2;
        let deltaAngle = this.aEndAngle - this.aStartAngle;
        const samePoints = Math.abs( deltaAngle ) < Number.EPSILON;

        // ensures that deltaAngle is 0 .. 2 PI
        while ( deltaAngle < 0 ) deltaAngle += twoPi;
        while ( deltaAngle > twoPi ) deltaAngle -= twoPi;

        if ( deltaAngle < Number.EPSILON ) {

            if ( samePoints ) {

                deltaAngle = 0;

            } else {

                deltaAngle = twoPi;

            }

        }

        if ( this.aClockwise === true && ! samePoints ) {

            if ( deltaAngle === twoPi ) {

                deltaAngle = - twoPi;

            } else {

                deltaAngle = deltaAngle - twoPi;

            }

        }

        const angle = this.aStartAngle + t * deltaAngle;
        let x = this.aX + this.xRadius * Math.cos( angle );
        let y = this.aY + this.yRadius * Math.sin( angle );

        if ( this.aRotation !== 0 ) {

            const cos = Math.cos( this.aRotation );
            const sin = Math.sin( this.aRotation );

            const tx = x - this.aX;
            const ty = y - this.aY;

            // Rotate the point about the center of the ellipse.
            x = tx * cos - ty * sin + this.aX;
            y = tx * sin + ty * cos + this.aY;

        }

        return point.set( x, y );

    }

`copy(source: any): this`¶

Code

copy( source ) {

        super.copy( source );

        this.aX = source.aX;
        this.aY = source.aY;

        this.xRadius = source.xRadius;
        this.yRadius = source.yRadius;

        this.aStartAngle = source.aStartAngle;
        this.aEndAngle = source.aEndAngle;

        this.aClockwise = source.aClockwise;

        this.aRotation = source.aRotation;

        return this;

    }

`toJSON(): any`¶

Code

toJSON() {

        const data = super.toJSON();

        data.aX = this.aX;
        data.aY = this.aY;

        data.xRadius = this.xRadius;
        data.yRadius = this.yRadius;

        data.aStartAngle = this.aStartAngle;
        data.aEndAngle = this.aEndAngle;

        data.aClockwise = this.aClockwise;

        data.aRotation = this.aRotation;

        return data;

    }

`fromJSON(json: any): this`¶

Code

fromJSON( json ) {

        super.fromJSON( json );

        this.aX = json.aX;
        this.aY = json.aY;

        this.xRadius = json.xRadius;
        this.yRadius = json.yRadius;

        this.aStartAngle = json.aStartAngle;
        this.aEndAngle = json.aEndAngle;

        this.aClockwise = json.aClockwise;

        this.aRotation = json.aRotation;

        return this;

    }

📄 EllipseCurve.js¶

📊 Analysis Summary¶

📚 Table of Contents¶

🛠️ File Location:¶

📦 Imports¶

Variables & Constants¶

Functions¶

EllipseCurve.getPoint(t: number, optionalTarget: Vector2): Vector2¶

EllipseCurve.copy(source: any): this¶

EllipseCurve.toJSON(): any¶

EllipseCurve.fromJSON(json: any): this¶

Classes¶

EllipseCurve¶

Methods¶

getPoint(t: number, optionalTarget: Vector2): Vector2¶

copy(source: any): this¶

toJSON(): any¶

fromJSON(json: any): this¶

📄 `EllipseCurve.js`¶

`EllipseCurve.getPoint(t: number, optionalTarget: Vector2): Vector2`¶

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

`EllipseCurve.toJSON(): any`¶

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

`EllipseCurve`¶

`getPoint(t: number, optionalTarget: Vector2): Vector2`¶

`copy(source: any): this`¶

`toJSON(): any`¶

`fromJSON(json: any): this`¶