@casual-simulation/aux-common 3.0.10 → 3.0.11

package/math/Rotation.js

@@ -0,0 +1,378 @@
+import { Quaternion } from './Quaternion';
+import { Vector3 } from './Vector3';
+/**
+ * Defines a class that can represent geometric rotations.
+ */
+export class Rotation {
+    /**
+     * Creates a new rotation using the given parameters.
+     * @param rotation The information that should be used to construct the rotation.
+     *
+     * @example Create a rotation from an axis and angle.
+     * const rotation = new Rotation({
+     *     axis: new Vector3(0, 0, 1),
+     *     angle: Math.PI / 2
+     * }); // 90 degree rotation around Z axis
+     *
+     * @example Create a rotation from two vectors.
+     * const rotation = new Rotation({
+     *     from: new Vector3(1, 0, 0),
+     *     to: new Vector3(0, 1, 0)
+     * }); // Rotation that rotates (1, 0, 0) to (0, 1, 0)
+     *
+     * @example Create a rotation that looks along the X axis.
+     * const rotation = new Rotation({
+     *     direction: new Vector3(1, 0, 0),
+     *     upwards: new Vector3(0, 0, 1),
+     *     errorHandling: 'nudge'
+     * });
+     *
+     * @example Tilt this bot forwards in the home dimension.
+     * tags.homeRotation = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 6 // 30 degrees
+     * });
+     */
+    constructor(rotation) {
+        var _a, _b;
+        if (!rotation) {
+            this._q = new Quaternion(0, 0, 0, 1);
+        }
+        else if ('axis' in rotation) {
+            this._q = Rotation.quaternionFromAxisAndAngle(rotation);
+        }
+        else if ('from' in rotation) {
+            this._q = Rotation.quaternionFromTo(rotation);
+        }
+        else if ('quaternion' in rotation) {
+            const q = rotation.quaternion;
+            this._q = new Quaternion(q.x, q.y, q.z, q.w).normalize();
+        }
+        else if ('sequence' in rotation) {
+            let q = new Quaternion(0, 0, 0, 1);
+            for (let r of rotation.sequence) {
+                q = r.quaternion.multiply(q);
+            }
+            this._q = q;
+        }
+        else if ('euler' in rotation) {
+            let q = new Quaternion(0, 0, 0, 1);
+            let order = (_a = rotation.euler.order) !== null && _a !== void 0 ? _a : 'XYZ';
+            let extrinsic = (_b = rotation.euler.extrinsic) !== null && _b !== void 0 ? _b : false;
+            function combine(q, rotation) {
+                if (extrinsic) {
+                    return rotation.multiply(q);
+                }
+                else {
+                    return q.multiply(rotation);
+                }
+            }
+            for (let char of order) {
+                if (char === 'X' || char === 'x') {
+                    q = combine(q, Rotation.quaternionFromAxisAndAngle({
+                        axis: new Vector3(1, 0, 0),
+                        angle: rotation.euler.x,
+                    }));
+                }
+                else if (char === 'Y' || char === 'y') {
+                    q = combine(q, Rotation.quaternionFromAxisAndAngle({
+                        axis: new Vector3(0, 1, 0),
+                        angle: rotation.euler.y,
+                    }));
+                }
+                else if (char === 'Z' || char === 'z') {
+                    q = combine(q, Rotation.quaternionFromAxisAndAngle({
+                        axis: new Vector3(0, 0, 1),
+                        angle: rotation.euler.z,
+                    }));
+                }
+            }
+            this._q = q;
+        }
+        else if ('direction' in rotation) {
+            this._q = Rotation.quaternionLook(rotation);
+        }
+        else if (rotation instanceof Quaternion) {
+            this._q = rotation.normalize();
+        }
+        else {
+            this._q = new Quaternion(0, 0, 0, 1);
+        }
+    }
+    /**
+     * The quaternion that this rotation uses.
+     */
+    get quaternion() {
+        return this._q;
+    }
+    /**
+     * Constructs a new Quaternion from the given axis and angle.
+     * @param axisAndAngle The object that contains the axis and angle values.
+     */
+    static quaternionFromAxisAndAngle(axisAndAngle) {
+        const normalizedAxis = axisAndAngle.axis.normalize();
+        const sinAngle = Math.sin(axisAndAngle.angle / 2);
+        const cosAngle = Math.cos(axisAndAngle.angle / 2);
+        return new Quaternion(normalizedAxis.x * sinAngle, normalizedAxis.y * sinAngle, normalizedAxis.z * sinAngle, cosAngle);
+    }
+    /**
+     * Constructs a new Quaternion from the given from/to rotation.
+     * This is equivalent to calculating the cross product and angle between the two vectors and constructing an axis/angle quaternion.
+     * @param fromToRotation The object that contains the from and to values.
+     */
+    static quaternionFromTo(fromToRotation) {
+        const normalizedFrom = fromToRotation.from.normalize();
+        const normalizedTo = fromToRotation.to.normalize();
+        const cross = normalizedFrom.cross(normalizedTo);
+        const angle = Vector3.angleBetween(normalizedFrom, normalizedTo);
+        return Rotation.quaternionFromAxisAndAngle({
+            axis: cross,
+            angle,
+        });
+    }
+    /**
+     * Constructs a new Quaternion from the given look rotation.
+     * @param look The object that contains the look rotation values.
+     */
+    static quaternionLook(look) {
+        if (look.errorHandling !== 'error' && look.errorHandling !== 'nudge') {
+            throw new Error('The errorHandling property must be provided. It must be a string that contains either "error" or "nudge".');
+        }
+        if (look.direction.squareLength() < 0.0001) {
+            return new Quaternion();
+        }
+        let direction = look.direction;
+        let up = look.upwards;
+        const lookUpDot = direction.dot(up);
+        if (look.errorHandling === 'error') {
+            if (lookUpDot > 0.9998) {
+                throw new Error(`The up and direction vectors must not be the same when constructing a look rotation.\nThis is because vectors that are parallel don't have a valid cross product. (i.e. There are infinite vectors that are perpendicular to both)`);
+            }
+            else if (lookUpDot < -0.9998) {
+                throw new Error(`The up and direction vectors must not be opposites when constructing a look rotation.\nThis is because vectors that are parallel don't have a valid cross product. (i.e. There are infinite vectors that are perpendicular to both)`);
+            }
+        }
+        else {
+            if (Math.abs(up.z) === 1) {
+                direction = new Vector3(direction.x, direction.y, direction.z + 0.00001);
+            }
+            else {
+                direction = new Vector3(direction.x + 0.00001, direction.y, direction.z);
+            }
+        }
+        // Matrix version from:
+        // https://www.euclideanspace.com/maths/algebra/vectors/lookat/index.htm
+        // with changed order to use Y-up coordinate system
+        const y = direction.normalize();
+        const x = y.cross(up).normalize();
+        const z = x.cross(y);
+        const m00 = x.x;
+        const m01 = y.x;
+        const m02 = z.x;
+        const m10 = x.y;
+        const m11 = y.y;
+        const m12 = z.y;
+        const m20 = x.z;
+        const m21 = y.z;
+        const m22 = z.z;
+        // https://www.euclideanspace.com/maths/geometry/rotations/conversions/matrixToQuaternion/
+        const qw = Math.sqrt(Math.max(0, 1 + m00 + m11 + m22)) / 2;
+        let qx = copySign(m21 - m12, Math.sqrt(Math.max(0, 1 + m00 - m11 - m22)) / 2);
+        let qy = copySign(m02 - m20, Math.sqrt(Math.max(0, 1 - m00 + m11 - m22)) / 2);
+        let qz = copySign(m10 - m01, Math.sqrt(Math.max(0, 1 - m00 - m11 + m22)) / 2);
+        return new Quaternion(qx, qy, qz, qw);
+    }
+    /**
+     * Determines the angle between the two given quaternions and returns the result in radians.
+     * @param first The first quaternion. Must be a quaterion that represents a rotation
+     * @param second The second quaternion.
+     */
+    static angleBetween(first, second) {
+        const delta = first.quaternion.invert().multiply(second.quaternion);
+        return 2 * Math.acos(delta.w);
+    }
+    /**
+     * Constructs a new rotation that is the spherical linear interpolation between the given first and second rotations.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     * @param first The first rotation.
+     * @param second The second rotation.
+     * @param amount The amount that the resulting rotation should be interpolated between the first and second rotations. Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     */
+    static interpolate(first, second, amount) {
+        const q1 = first.quaternion;
+        const q2 = second.quaternion;
+        const cosHalfTheta = q1.w * q2.w + q1.x * q2.x + q1.y * q2.y + q1.z * q2.z;
+        // if angle beween is 0 then we can simply return the first rotation
+        if (cosHalfTheta >= 1 || cosHalfTheta <= -1) {
+            return new Rotation(new Quaternion(q1.x, q1.y, q1.z, q1.w));
+        }
+        const sinHalfTheta = Math.sqrt(1 - cosHalfTheta * cosHalfTheta);
+        // If angle between is 180, then we can choose either axis normal to first or second.
+        if (Math.abs(sinHalfTheta) <= 0.001) {
+            return new Rotation(new Quaternion(q1.x * 0.5 + q2.x * 0.5, q1.y * 0.5 + q2.y * 0.5, q1.z * 0.5 + q2.z * 0.5, q1.w * 0.5 + q2.w * 0.5));
+        }
+        const halfTheta = Math.acos(cosHalfTheta);
+        const ratioA = Math.sin((1 - amount) * halfTheta) / sinHalfTheta;
+        const ratioB = Math.sin(amount * halfTheta) / sinHalfTheta;
+        return new Rotation(new Quaternion(q1.x * ratioA + q2.x * ratioB, q1.y * ratioA + q2.y * ratioB, q1.z * ratioA + q2.z * ratioB, q1.w * ratioA + q2.w * ratioB));
+    }
+    /**
+     * Rotates the given Vector3 by this quaternion and returns a new vector containing the result.
+     * @param vector The 3D vector that should be rotated.
+     *
+     * @example Apply a rotation to a Vector3 object.
+     * const rotation = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 4
+     * }); // 45 degree rotation around X axis
+     *
+     * const point = new Vector3(1, 2, 0);
+     * const rotated = rotation.rotateVector3(point);
+     * os.toast(rotated);
+     */
+    rotateVector3(vector) {
+        // Multiplied out version of (q * vector * q^-1)
+        const q = this.quaternion;
+        return new Vector3(q.w * q.w * vector.x +
+            2 * q.y * q.w * vector.z -
+            2 * q.z * q.w * vector.y +
+            q.x * q.x * vector.x +
+            2 * q.y * q.x * vector.y +
+            2 * q.z * q.x * vector.z -
+            q.z * q.z * vector.x -
+            q.y * q.y * vector.x, 2 * q.x * q.y * vector.x +
+            q.y * q.y * vector.y +
+            2 * q.z * q.y * vector.z +
+            2 * q.w * q.z * vector.x -
+            q.z * q.z * vector.y +
+            q.w * q.w * vector.y -
+            2 * q.x * q.w * vector.z -
+            q.x * q.x * vector.y, 2 * q.x * q.z * vector.x +
+            2 * q.y * q.z * vector.y +
+            q.z * q.z * vector.z -
+            2 * q.w * q.y * vector.x -
+            q.y * q.y * vector.z +
+            2 * q.w * q.x * vector.y -
+            q.x * q.x * vector.z +
+            q.w * q.w * vector.z);
+    }
+    /**
+     * Rotates the given Vector2 by this quaternion and returns a new vector containing the result.
+     * Note that rotations around any other axis than (0, 0, 1) or (0, 0, -1) can produce results that contain a Z component.
+     * @param vector The 2D vector that should be rotated.
+     *
+     * @example Apply a rotation to a Vector2 object.
+     * const rotation = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 4
+     * }); // 45 degree rotation around X axis
+     *
+     * const point = new Vector2(1, 2);
+     * const rotated = rotation.rotateVector2(point);
+     * os.toast(rotated);
+     */
+    rotateVector2(vector) {
+        return this.rotateVector3(new Vector3(vector.x, vector.y));
+    }
+    /**
+     * Combines this rotation with the other rotation and returns a new rotation that represents the combination of the two.
+     * @param other The other rotation.
+     *
+     * @example Combine two rotations together.
+     * const first = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 4
+     * }); // 45 degree rotation around X axis
+     * const second = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 4
+     * }); // 45 degree rotation around X axis
+     *
+     * const third = first.combineWith(second); // 90 degree rotation around X
+     *
+     * os.toast(third);
+     */
+    combineWith(other) {
+        return new Rotation(other.quaternion.multiply(this.quaternion));
+    }
+    /**
+     * Calculates the inverse rotation of this rotation and returns a new rotation with the result.
+     *
+     * @example Calculate the inverse of a rotation.
+     * const first = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 4
+     * }); // 45 degree rotation around X axis
+     * const inverse = first.inverse();
+     *
+     * const result = first.combineWith(inverse);
+     *
+     * os.toast(result);
+     */
+    invert() {
+        return new Rotation(this._q.invert());
+    }
+    /**
+     * Gets the axis and angle that this rotation rotates around.
+     */
+    axisAndAngle() {
+        const halfAngle = Math.acos(this.quaternion.w);
+        const sinHalfAngle = Math.sin(halfAngle);
+        const x = this.quaternion.x / sinHalfAngle;
+        const y = this.quaternion.y / sinHalfAngle;
+        const z = this.quaternion.z / sinHalfAngle;
+        const angle = halfAngle * 2;
+        return {
+            axis: new Vector3(x, y, z),
+            angle: angle,
+        };
+    }
+    /**
+     * Determines if this rotation equals the other rotation.
+     * @param other The rotation to check.
+     */
+    equals(other) {
+        return this._q.equals(other === null || other === void 0 ? void 0 : other._q);
+    }
+    /**
+     * Converts this rotation to a human-readable string representation.
+     *
+     * @example Get a string of a rotation.
+     * const myRotation = new Rotation({
+     *     axis: new Vector3(1, 0, 0),
+     *     angle: Math.PI / 4
+     * }); // 45 degree rotation around X axis
+     * const rotationString = myRotation.toString();
+     *
+     * os.toast('My Rotation: ' + rotationString);
+     */
+    toString() {
+        const { axis, angle } = this.axisAndAngle();
+        const angleWithoutPi = angle / Math.PI;
+        if (angle === 0) {
+            return `Rotation(identity)`;
+        }
+        return `Rotation(axis: ${axis}, angle: Math.PI * ${angleWithoutPi})`;
+    }
+}
+/**
+ * Defines a constant that contains a rotation that, when combined with a rotation, converts a rotation in AUX coordinates to THREE.js coordinates.
+ */
+export const AUX_ROTATION_TO_THREEJS = new Rotation({
+    axis: new Vector3(1, 0, 0),
+    angle: -Math.PI / 2,
+});
+/**
+ * Copies the sign from signGiver onto signTaker and returns the result.
+ * @param signGiver The number whose sign should be given to the other number.
+ * @param signTaker The number whose sign should be set.
+ */
+export function copySign(signGiver, signTaker) {
+    if (Math.sign(signGiver) === Math.sign(signTaker)) {
+        return signTaker;
+    }
+    else {
+        return signTaker * -1;
+    }
+}
+//# sourceMappingURL=Rotation.js.map

package/math/Rotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rotation.js","sourceRoot":"","sources":["Rotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,QAAQ;IAUjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YACI,QAOkB;;QAElB,IAAI,CAAC,QAAQ,EAAE;YACX,IAAI,CAAC,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACxC;aAAM,IAAI,MAAM,IAAI,QAAQ,EAAE;YAC3B,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;SAC3D;aAAM,IAAI,MAAM,IAAI,QAAQ,EAAE;YAC3B,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;SACjD;aAAM,IAAI,YAAY,IAAI,QAAQ,EAAE;YACjC,MAAM,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC9B,IAAI,CAAC,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;SAC5D;aAAM,IAAI,UAAU,IAAI,QAAQ,EAAE;YAC/B,IAAI,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACnC,KAAK,IAAI,CAAC,IAAI,QAAQ,CAAC,QAAQ,EAAE;gBAC7B,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;aAChC;YACD,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;SACf;aAAM,IAAI,OAAO,IAAI,QAAQ,EAAE;YAC5B,IAAI,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACnC,IAAI,KAAK,GAAG,MAAA,QAAQ,CAAC,KAAK,CAAC,KAAK,mCAAI,KAAK,CAAC;YAC1C,IAAI,SAAS,GAAG,MAAA,QAAQ,CAAC,KAAK,CAAC,SAAS,mCAAI,KAAK,CAAC;YAElD,SAAS,OAAO,CAAC,CAAa,EAAE,QAAoB;gBAChD,IAAI,SAAS,EAAE;oBACX,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;iBAC/B;qBAAM;oBACH,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;iBAC/B;YACL,CAAC;YAED,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;gBACpB,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE;oBAC9B,CAAC,GAAG,OAAO,CACP,CAAC,EACD,QAAQ,CAAC,0BAA0B,CAAC;wBAChC,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;wBAC1B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;qBAC1B,CAAC,CACL,CAAC;iBACL;qBAAM,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE;oBACrC,CAAC,GAAG,OAAO,CACP,CAAC,EACD,QAAQ,CAAC,0BAA0B,CAAC;wBAChC,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;wBAC1B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;qBAC1B,CAAC,CACL,CAAC;iBACL;qBAAM,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE;oBACrC,CAAC,GAAG,OAAO,CACP,CAAC,EACD,QAAQ,CAAC,0BAA0B,CAAC;wBAChC,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;wBAC1B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;qBAC1B,CAAC,CACL,CAAC;iBACL;aACJ;YACD,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;SACf;aAAM,IAAI,WAAW,IAAI,QAAQ,EAAE;YAChC,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;SAC/C;aAAM,IAAI,QAAQ,YAAY,UAAU,EAAE;YACvC,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;SAClC;aAAM;YACH,IAAI,CAAC,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IA7GD;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,EAAE,CAAC;IACnB,CAAC;IA0GD;;;OAGG;IACH,MAAM,CAAC,0BAA0B,CAAC,YAA0B;QACxD,MAAM,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAClD,OAAO,IAAI,UAAU,CACjB,cAAc,CAAC,CAAC,GAAG,QAAQ,EAC3B,cAAc,CAAC,CAAC,GAAG,QAAQ,EAC3B,cAAc,CAAC,CAAC,GAAG,QAAQ,EAC3B,QAAQ,CACX,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,cAA8B;QAClD,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACvD,MAAM,YAAY,GAAG,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC;QAEnD,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;QAEjE,OAAO,QAAQ,CAAC,0BAA0B,CAAC;YACvC,IAAI,EAAE,KAAK;YACX,KAAK;SACR,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,IAAkB;QACpC,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,EAAE;YAClE,MAAM,IAAI,KAAK,CACX,2GAA2G,CAC9G,CAAC;SACL;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,GAAG,MAAM,EAAE;YACxC,OAAO,IAAI,UAAU,EAAE,CAAC;SAC3B;QAED,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAC/B,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACtB,MAAM,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,aAAa,KAAK,OAAO,EAAE;YAChC,IAAI,SAAS,GAAG,MAAM,EAAE;gBACpB,MAAM,IAAI,KAAK,CACX,oOAAoO,CACvO,CAAC;aACL;iBAAM,IAAI,SAAS,GAAG,CAAC,MAAM,EAAE;gBAC5B,MAAM,IAAI,KAAK,CACX,qOAAqO,CACxO,CAAC;aACL;SACJ;aAAM;YACH,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;gBACtB,SAAS,GAAG,IAAI,OAAO,CACnB,SAAS,CAAC,CAAC,EACX,SAAS,CAAC,CAAC,EACX,SAAS,CAAC,CAAC,GAAG,OAAO,CACxB,CAAC;aACL;iBAAM;gBACH,SAAS,GAAG,IAAI,OAAO,CACnB,SAAS,CAAC,CAAC,GAAG,OAAO,EACrB,SAAS,CAAC,CAAC,EACX,SAAS,CAAC,CAAC,CACd,CAAC;aACL;SACJ;QAED,uBAAuB;QACvB,wEAAwE;QACxE,mDAAmD;QACnD,MAAM,CAAC,GAAG,SAAS,CAAC,SAAS,EAAE,CAAC;QAChC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;QAElC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAErB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAEhB,0FAA0F;QAC1F,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QAC3D,IAAI,EAAE,GAAG,QAAQ,CACb,GAAG,GAAG,GAAG,EACT,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAClD,CAAC;QACF,IAAI,EAAE,GAAG,QAAQ,CACb,GAAG,GAAG,GAAG,EACT,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAClD,CAAC;QACF,IAAI,EAAE,GAAG,QAAQ,CACb,GAAG,GAAG,GAAG,EACT,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAClD,CAAC;QAEF,OAAO,IAAI,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,KAAe,EAAE,MAAgB;QACjD,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpE,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CACd,KAAe,EACf,MAAgB,EAChB,MAAc;QAEd,MAAM,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC;QAC5B,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;QAE7B,MAAM,YAAY,GACd,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAE1D,oEAAoE;QACpE,IAAI,YAAY,IAAI,CAAC,IAAI,YAAY,IAAI,CAAC,CAAC,EAAE;YACzC,OAAO,IAAI,QAAQ,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/D;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,YAAY,GAAG,YAAY,CAAC,CAAC;QAEhE,qFAAqF;QACrF,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,KAAK,EAAE;YACjC,OAAO,IAAI,QAAQ,CACf,IAAI,UAAU,CACV,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,EACvB,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,EACvB,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,EACvB,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,CAC1B,CACJ,CAAC;SACL;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,YAAY,CAAC;QACjE,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,YAAY,CAAC;QAE3D,OAAO,IAAI,QAAQ,CACf,IAAI,UAAU,CACV,EAAE,CAAC,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,EAC7B,EAAE,CAAC,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,EAC7B,EAAE,CAAC,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,EAC7B,EAAE,CAAC,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,CAAC,GAAG,MAAM,CAChC,CACJ,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,MAAe;QACzB,gDAAgD;QAChD,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1B,OAAO,IAAI,OAAO,CACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YAChB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EACxB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EACxB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YACpB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAC3B,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,MAAe;QACzB,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,KAAe;QACvB,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM;QACF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,YAAY;QACR,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACzC,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,YAAY,CAAC;QAC3C,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,YAAY,CAAC;QAC3C,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,YAAY,CAAC;QAC3C,MAAM,KAAK,GAAG,SAAS,GAAG,CAAC,CAAC;QAE5B,OAAO;YACH,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAC1B,KAAK,EAAE,KAAK;SACf,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAe;QAClB,OAAO,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ;QACJ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,MAAM,cAAc,GAAG,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC;QACvC,IAAI,KAAK,KAAK,CAAC,EAAE;YACb,OAAO,oBAAoB,CAAC;SAC/B;QACD,OAAO,kBAAkB,IAAI,sBAAsB,cAAc,GAAG,CAAC;IACzE,CAAC;CACJ;AAkHD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,QAAQ,CAAC;IAChD,IAAI,EAAE,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1B,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;CACtB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,SAAiB,EAAE,SAAiB;IACzD,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QAC/C,OAAO,SAAS,CAAC;KACpB;SAAM;QACH,OAAO,SAAS,GAAG,CAAC,CAAC,CAAC;KACzB;AACL,CAAC"}

package/math/Vector2.d.ts

@@ -0,0 +1,251 @@
+/**
+ * Defines a class that represents a 2D point in space.
+ */
+export declare class Vector2 {
+    /**
+     * The X value of this vector.
+     */
+    x: number;
+    /**
+     * The Y value of this vector.
+     */
+    y: number;
+    /**
+     * Constructs a new 2D vector with the given X and Y values.
+     * @param x The X value of the vector.
+     * @param y The Y value of the vector.
+     *
+     * @example Create a new Vector2 object with the position (2, 3).
+     * let myVector = new Vector2(2, 3);
+     *
+     * os.toast(`X: ${myVector.x}, Y: ${myVector.y}`);
+     *
+     * @example Move this bot to (10, 15) in the home dimension.
+     * tags.homePosition = new Vector2(10, 15);
+     */
+    constructor(x?: number, y?: number);
+    /**
+     * Creates a 2D vector with the given X and Y values that is normalized immediately upon creation.
+     * @param x The X value of the vector.
+     * @param y The Y value of the vector.
+     *
+     * @example Create a normalized vector
+     * const vector = Vector2.createNormalized(1, 2);
+     */
+    static createNormalized(x: number, y: number): Vector2;
+    /**
+     * Calculates the angle between the two given vectors and returns the result in radians.
+     * @param first The first vector that should be used for comparision.
+     * @param second The second vector that should be used for comparision.
+     *
+     * @example Find the angle between two vectors.
+     * const first = new Vector2(
+     *     Math.cos(Math.PI / 3),
+     *     Math.sin(Math.PI / 3)
+     * ); // 60 degrees
+     * const second = new Vector2(
+     *     Math.cos(Math.PI / 2),
+     *     Math.sin(Math.PI / 2)
+     * ); // 90 degrees
+     *
+     * const angle = Vector2.angleBetween(first, second);
+     * os.toast(angle);
+     */
+    static angleBetween(first: Vector2, second: Vector2): number;
+    /**
+     * Calculates the distance between the two given vectors and returns the result.
+     * @param first The first vector that should be used for comparision.
+     * @param second The second vector that should be used for comparision.
+     *
+     * @example Find the distance between two vectors.
+     * const first = new Vector2(5, 10);
+     * const second = new Vector2(9, 2);
+     * const distance = Vector2.distanceBetween(first, second);
+     *
+     * os.toast(`Distance: ${distance}`);
+     */
+    static distanceBetween(first: Vector2, second: Vector2): number;
+    /**
+     * Constructs a new vector that is the linear interpolation between the given start and end positions.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     * @param start The start position.
+     * @param finish The end position.
+     * @param amount The amount that the resulting position should be interpolated between the start and end positions.  Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     *
+     * @example Find the position that is halfway between two vectors.
+     * const start = new Vector2(5, 10);
+     * const finish = new Vector2(9, 2);
+     * const halfway = Vector2.interpolatePosition(start, finish, 0.5);
+     *
+     * os.toast(halfway);
+     *
+     * @example Find the position that is 1/4 between two vectors.
+     * const start = new Vector2(5, 10);
+     * const finish = new Vector2(9, 2);
+     * const halfway = Vector2.interpolatePosition(start, finish, 0.25);
+     *
+     * os.toast(halfway);
+     */
+    static interpolatePosition(start: Vector2, finish: Vector2, amount: number): Vector2;
+    /**
+     * Constructs a new vector that is the directional linear interpolation between the given start and end positions.
+     * The degree that the result is interpolated is determined by the given amount parameter.
+     *
+     * This function works similarly to interpolatePosition(), except the result is always a normalized vector.
+     *
+     * @param start The start position.
+     * @param finish The end position.
+     * @param amount The amount that the resulting position should be interpolated between the start and end positions.  Values near 0 indicate rotations close to the first and values near 1 indicate rotations close to the second.
+     *
+     * @example Find the direction that points halfway between the two vectors.
+     * const start = new Vector2(5, 10);
+     * const finish = new Vector2(9, 2);
+     * const halfway = Vector2.interpolatePosition(start, finish, 0.5);
+     *
+     * os.toast(halfway);
+     */
+    static interpolateDirection(start: Vector2, finish: Vector2, amount: number): Vector2;
+    /**
+     * Adds this vector with the other vector and returns the result.
+     * @param other The other vector to add with this vector.
+     *
+     * @example Add two vectors together.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const added = first.add(second);
+     *
+     * os.toast(added); // Prints (4, 6)
+     */
+    add(other: Vector2): Vector2;
+    /**
+     * Subtracts the other vector from this vector and returns the result.
+     * @param other The other vector that should be subtracted from this vector.
+     *
+     * @example Subtract two vectors.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const subtracted = first.subtract(second);
+     * os.toast(subtracted);
+     *
+     * @example Find the direction from one vector to another.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     *
+     * const directionFromFirstToSecond = second.subtract(first);
+     * const directionFromSecondToFirst = first.subtract(second);
+     *
+     * os.toast(`first -> second = ${directionFromFirstToSecond}; second -> first = ${directionFromSecondToFirst}`);
+     */
+    subtract(other: Vector2): Vector2;
+    /**
+     * Multiplies each component of this vector by the given value and returns the result.
+     * @param scale The scale that should be applied to this vector.
+     *
+     * @example Scale a vector by 10.
+     * const myVector = new Vector2(1, 1);
+     * const scaled = myVector.multiplyScalar(10);
+     * os.toast(scaled); // Prints (10, 10)
+     */
+    multiplyScalar(scale: number): Vector2;
+    /**
+     * Multiplies this vector by the given other vector and returns the result.
+     * @param other The other vector to multiply with this vector.
+     *
+     * @example Multiply two vectors together.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const multiplied = first.multiply(second);
+     *
+     * os.toast(multiplied); // Prints (3, 8)
+     */
+    multiply(other: Vector2): Vector2;
+    /**
+     * Calculates the dot product of this vector compared to the given other vector.
+     * Returns a number that is positive if the vectors point in the same direction,
+     * negative if they point in opposite directions, and zero if they are perpendicular.
+     * For normalized vectors, this value is clamped to 1 and -1.
+     * @param other The other vector to calculate the dot product with.
+     *
+     * @example Determine how two vectors are pointing towards/away from the same direction.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     *
+     * const dot = first.dot(second);
+     * if (dot < 0) {
+     *     os.toast("Vectors are pointing away from each other!");
+     * } else if (dot === 0) {
+     *     os.toast("Vectors 90 degrees away from each other!");
+     * } else {
+     *     os.toast("Vectors are pointing towards from each other!");
+     * }
+     */
+    dot(other: Vector2): number;
+    /**
+     * Calculates the length of this vector and returns the result.
+     *
+     * @example Get the length of the vector.
+     * const myVector = new Vector2(1, 2);
+     * const length = myVector.length();
+     *
+     * os.toast(`Vector is ${length} units long`);
+     */
+    length(): number;
+    /**
+     * Calculates the square length of this vector and returns the result.
+     * This is equivalent to length^2, but it is faster to calculate than length because it doesn't require
+     * calculating a square root.
+     *
+     * @example Get the square length of the vector.
+     * const myVector = new Vector2(1, 2);
+     * const length = myVector.squareLength();
+     *
+     * os.toast(`Vector is ${length}^2 units long`);
+     */
+    squareLength(): number;
+    /**
+     * Calculates the normalized version of this vector and returns it.
+     * A normalized vector is a vector whose length equals 1.
+     *
+     * Normalizing a vector preserves its directionality while making the length (i.e. scale) of it 1.
+     *
+     * @example Normalize a vector.
+     * const myVector = new Vector2(1, 2);
+     * const normalized = myVector.normalize();
+     *
+     * os.toast(`Vector: ${myVector}, Normalized: ${normalized}`);
+     */
+    normalize(): Vector2;
+    /**
+     * Negates each component of this vector and returns a new vector that contains the result.
+     *
+     * @example Negate a vector.
+     * const myVector = new Vector2(1, 2);
+     * const negated = myVector.negate();
+     *
+     * os.toast(`Vector: ${myVector}, Negated: ${negated}`);
+     */
+    negate(): Vector2;
+    /**
+     * Converts this vector to a human-readable string representation.
+     *
+     * @example Get a string of a vector.
+     * const myVector = new Vector2(1, 2);
+     * const vectorString = myVector.toString();
+     *
+     * os.toast('My Vector: ' + vectorString);
+     */
+    toString(): string;
+    /**
+     * Determines if this vector equals the other vector.
+     * @param other The other vector.
+     *
+     * @example Determine if two vectors represent the same value.
+     * const first = new Vector2(1, 2);
+     * const second = new Vector2(3, 4);
+     * const third = new Vector2(1, 2);
+     *
+     * os.toast(`first == second: ${first.equals(second)}; first == third: ${first.equals(third)}`)
+     */
+    equals(other: Vector2): boolean;
+}
+//# sourceMappingURL=Vector2.d.ts.map