add extjs 6.0.1 sources

[extjs.git] / extjs / packages / charts / src / draw / Point.js

/**\r
 * A helper class to facilitate common operations on points and vectors.\r
 */\r
Ext.define('Ext.draw.Point', {\r
\r
    requires: [\r
        'Ext.draw.Draw',\r
        'Ext.draw.Matrix'\r
    ],\r
\r
    isPoint: true,\r
\r
    x: 0,\r
    y: 0,\r
\r
    length: 0,\r
    angle: 0,\r
\r
    angleUnits: 'degrees',\r
\r
    statics: {\r
        /**\r
         * @method\r
         * @static\r
         * Creates a flyweight Ext.draw.Point instance.\r
         * Takes the same parameters as the {@link Ext.draw.Point#constructor}.\r
         * Do not hold the instance of the flyweight point.\r
         *\r
         * @param point {Number/Number[]/Object/Ext.draw.Point}\r
         * @return {Ext.draw.Point}\r
         */\r
        fly: (function () {\r
            var point = null;\r
            return function (x, y) {\r
                if (!point) {\r
                    point = new Ext.draw.Point();\r
                }\r
                point.constructor(x, y);\r
                return point;\r
            }\r
        })()\r
    },\r
\r
    /**\r
     * Creates a point.\r
     *\r
     *     new Ext.draw.Point(3, 4);\r
     *     new Ext.draw.Point(3); // both x and y equal 3\r
     *     new Ext.draw.Point([3, 4]);\r
     *     new Ext.draw.Point({x: 3, y: 4});\r
     *     new Ext.draw.Point(p); // where `p` is a Ext.draw.Point instance.\r
     *\r
     * @param point {Number/Number[]/Object/Ext.draw.Point}\r
     */\r
    constructor: function (x, y) {\r
        var me = this;\r
\r
        if (typeof x === 'number') {\r
            me.x = x;\r
            if (typeof y === 'number') {\r
                me.y = y;\r
            } else {\r
                me.y = x;\r
            }\r
        } else if (Ext.isArray(x)) {\r
            me.x = x[0];\r
            me.y = x[1];\r
        } else if (x) {\r
            me.x = x.x;\r
            me.y = x.y;\r
        }\r
\r
        me.calculatePolar();\r
    },\r
\r
    calculateCartesian: function () {\r
        var me = this,\r
            length = me.length,\r
            angle = me.angle;\r
\r
        if (me.angleUnits === 'degrees') {\r
            angle = Ext.draw.Draw.rad(angle);\r
        }\r
        me.x = Math.cos(angle) * length;\r
        me.y = Math.sin(angle) * length;\r
    },\r
\r
    calculatePolar: function () {\r
        var me = this,\r
            x = me.x,\r
            y = me.y;\r
\r
        me.length = Math.sqrt(x * x + y * y);\r
        me.angle = Math.atan2(y, x);\r
        if (me.angleUnits === 'degrees') {\r
            me.angle = Ext.draw.Draw.degrees(me.angle);\r
        }\r
    },\r
\r
    /**\r
     * Sets the x-coordinate of the point.\r
     * @param x {Number}\r
     */\r
    setX: function (x) {\r
        this.x = x;\r
        this.calculatePolar();\r
    },\r
\r
    /**\r
     * Sets the y-coordinate of the point.\r
     * @param y {Number}\r
     */\r
    setY: function (y) {\r
        this.y = y;\r
        this.calculatePolar();\r
    },\r
\r
    /**\r
     * Sets coordinates of the point.\r
     * Takes the same parameters as the {@link #constructor}.\r
     * @param point {Number/Number[]/Object/Ext.draw.Point}\r
     */\r
    set: function (x, y) {\r
        this.constructor(x, y);\r
    },\r
\r
    /**\r
     * Sets the angle of the vector (measured from the x-axis to the vector)\r
     * without changing its length.\r
     * @param angle {Number}\r
     */\r
    setAngle: function (angle) {\r
        this.angle = angle;\r
        this.calculateCartesian();\r
    },\r
\r
    /**\r
     * Sets the length of the vector without changing its angle.\r
     * @param length {Number}\r
     */\r
    setLength: function (length) {\r
        this.length = length;\r
        this.calculateCartesian();\r
    },\r
\r
    /**\r
     * Sets both the angle and the length of the vector.\r
     * A point can be thought of as a vector pointing from the origin to the point's location.\r
     * This can also be interpreted as setting coordinates of a point in the polar\r
     * coordinate system.\r
     * @param angle {Number}\r
     * @param length {Number}\r
     */\r
    setPolar: function (angle, length) {\r
        this.angle = angle;\r
        this.length = length;\r
        this.calculateCartesian();\r
    },\r
\r
    /**\r
     * Returns a copy of the point.\r
     * @return {Ext.draw.Point}\r
     */\r
    clone: function () {\r
        return new Ext.draw.Point(this.x, this.y);\r
    },\r
\r
    /**\r
     * Adds another vector to this one and returns the resulting vector\r
     * without changing this vector.\r
     * @param point {Number/Number[]/Object/Ext.draw.Point}\r
     * @return {Ext.draw.Point}\r
     */\r
    add: function (x, y) {\r
        var fly = Ext.draw.Point.fly(x, y);\r
        return new Ext.draw.Point(this.x + fly.x, this.y + fly.y);\r
    },\r
\r
    /**\r
     * Subtracts another vector from this one and returns the resulting vector\r
     * without changing this vector.\r
     * @param point {Number/Number[]/Object/Ext.draw.Point}\r
     * @return {Ext.draw.Point}\r
     */\r
    sub: function (x, y) {\r
        var fly = Ext.draw.Point.fly(x, y);\r
        return new Ext.draw.Point(this.x - fly.x, this.y - fly.y);\r
    },\r
\r
    /**\r
     * Returns the result of scalar multiplication of this vector by the given factor.\r
     * This vector is not modified.\r
     * @param n {Number} The factor.\r
     * @return {Ext.draw.Point}\r
     */\r
    mul: function (n) {\r
        return new Ext.draw.Point(this.x * n, this.y * n);\r
    },\r
\r
    /**\r
     * Returns a vector which coordinates are the result of division of this vector's\r
     * coordinates by the given number. This vector is not modified.\r
     * This vector is not modified.\r
     * @param n {Number} The denominator.\r
     * @return {Ext.draw.Point}\r
     */\r
    div: function (n) {\r
        return new Ext.draw.Point(this.x / n, this.y / n);\r
    },\r
\r
    /**\r
     * Returns the dot product of this vector and the given vector.\r
     * @param point {Number/Number[]/Object/Ext.draw.Point}\r
     * @return {Number}\r
     */\r
    dot: function (x, y) {\r
        var fly = Ext.draw.Point.fly(x, y);\r
        return this.x * fly.x + this.y * fly.y;\r
    },\r
\r
    /**\r
     * Checks whether coordinates of the point match those of the point provided.\r
     * @param point {Number/Number[]/Object/Ext.draw.Point}\r
     * @return {Boolean}\r
     */\r
    equals: function (x, y) {\r
        var fly = Ext.draw.Point.fly(x, y);\r
        return this.x === fly.x && this.y === fly.y;\r
    },\r
\r
    /**\r
     * Rotates the point by the given angle. This point is not modified.\r
     * @param angle {Number} The rotation angle.\r
     * @param center {Ext.draw.Point} The center of rotation (optional). Defaults to origin.\r
     * @return {Ext.draw.Point} The rotated point.\r
     */\r
    rotate: function (angle, center) {\r
        var sin, cos,\r
            cx, cy,\r
            point;\r
\r
        if (this.angleUnits === 'degrees') {\r
            angle = Ext.draw.Draw.rad(angle);\r
            sin = Math.sin(angle);\r
            cos = Math.cos(angle);\r
        }\r
        if (center) {\r
            cx = center.x;\r
            cy = center.y;\r
        } else {\r
            cx = 0;\r
            cy = 0;\r
        }\r
        point = Ext.draw.Matrix.fly([\r
            cos, sin,\r
            -sin, cos,\r
            cx - cos * cx + cy * sin,\r
            cy - cos * cy + cx * -sin\r
        ]).transformPoint(this);\r
\r
        return new Ext.draw.Point(point);\r
    },\r
\r
    /**\r
     * Transforms the point from one coordinate system to another\r
     * using the transformation matrix provided. This point is not modified.\r
     * @param matrix {Ext.draw.Matrix/Number[]} A trasformation matrix or its elements.\r
     * @return {Ext.draw.Point}\r
     */\r
    transform: function (matrix) {\r
        if (matrix && matrix.isMatrix) {\r
            return new Ext.draw.Point(matrix.transformPoint(this));\r
        } else if (arguments.length === 6) {\r
            return new Ext.draw.Point(Ext.draw.Matrix.fly(arguments).transformPoint(this));\r
        } else {\r
            Ext.raise("Invalid parameters.");\r
        }\r
    },\r
\r
    /**\r
     * Returns a new point with rounded x and y values. This point is not modified.\r
     * @return {Ext.draw.Point}\r
     */\r
    round: function () {\r
        return new Ext.draw.Point(\r
            Math.round(this.x),\r
            Math.round(this.y)\r
        );\r
    },\r
\r
    /**\r
     * Returns a new point with ceiled x and y values. This point is not modified.\r
     * @return {Ext.draw.Point}\r
     */\r
    ceil: function () {\r
        return new Ext.draw.Point(\r
            Math.ceil(this.x),\r
            Math.ceil(this.y)\r
        );\r
    },\r
\r
    /**\r
     * Returns a new point with floored x and y values. This point is not modified.\r
     * @return {Ext.draw.Point}\r
     */\r
    floor: function () {\r
        return new Ext.draw.Point(\r
            Math.floor(this.x),\r
            Math.floor(this.y)\r
        );\r
    },\r
\r
    /**\r
     * Returns a new point with absolute values of the x and y values of this point.\r
     * This point is not modified.\r
     * @return {Ext.draw.Point}\r
     */\r
    abs: function (x, y) {\r
        return new Ext.draw.Point(\r
            Math.abs(this.x),\r
            Math.abs(this.y)\r
        );\r
    },\r
\r
    /**\r
     * Normalizes the vector by changing its length to 1 without changing its angle.\r
     * The returned result is a normalized vector. This vector is not modified.\r
     * @param length {Number=1} The length of the normalized vector. Defaults to 1.\r
     * @return {Ext.draw.Point}\r
     */\r
    normalize: function (length) {\r
        var x = this.x,\r
            y = this.y,\r
            nx, ny, tg;\r
\r
        length = length || 1;\r
\r
        if (x === 0) {\r
            nx = 0;\r
            ny = length * Ext.Number.sign(y);\r
        } else {\r
            tg = y/x;\r
            nx = length / Math.sqrt(1 + tg * tg);\r
            ny = nx * tg;\r
        }\r
        return new Ext.draw.Point(nx, ny);\r
    },\r
\r
    /**\r
     * Returns the vector from the point perpendicular to the line (shortest distance).\r
     * Where line is specified using two points or the coordinates of those points.\r
     * @param p1 {Ext.draw.Point}\r
     * @param p2 {Ext.draw.Point}\r
     * @return {Ext.draw.Point}\r
     */\r
    getDistanceToLine: function (p1, p2) {\r
        if (arguments.length === 4) {\r
            p1 = new Ext.draw.Point(arguments[0], arguments[1]);\r
            p2 = new Ext.draw.Point(arguments[2], arguments[3]);\r
        }\r
        // See http://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line#Vector_formulation\r
        var n = p2.sub(p1).normalize(),\r
            pp1 = p1.sub(this);\r
        return pp1.sub(n.mul(pp1.dot(n)));\r
    },\r
\r
    /**\r
     * Checks if both x and y coordinates of the point are zero.\r
     * @return {Boolean}\r
     */\r
    isZero: function () {\r
        return this.x === 0 && this.y === 0;\r
    },\r
\r
    /**\r
     * Checks if both x and y coordinates of the point are valid numbers.\r
     * @return {Boolean}\r
     */\r
    isNumber: function () {\r
        return Ext.isNumber(this.x + this.y);\r
    }\r
\r
});