typescript-closure-tools/index/closure-library/closure/goog/vec/vec2.d.ts

Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files

/// <reference path="../../../globals.d.ts" />
/// <reference path="./vec.d.ts" />

declare module goog.vec.Vec2 {

    /** @typedef {goog.vec.Float32} */
    type Float32 = goog.vec.Float32;

    /** @typedef {goog.vec.Float64} */
    type Float64 = goog.vec.Float64;

    /** @typedef {goog.vec.Number} */
    type Number = goog.vec.Number;

    /** @typedef {goog.vec.AnyType} */
    type AnyType = goog.vec.AnyType;

    /**
     * Creates a 2 element vector of Float32. The array is initialized to zero.
     *
     * @return {!goog.vec.Vec2.Float32} The new 2 element array.
     */
    function createFloat32(): goog.vec.Vec2.Float32;

    /**
     * Creates a 2 element vector of Float64. The array is initialized to zero.
     *
     * @return {!goog.vec.Vec2.Float64} The new 2 element array.
     */
    function createFloat64(): goog.vec.Vec2.Float64;

    /**
     * Creates a 2 element vector of Number. The array is initialized to zero.
     *
     * @return {!goog.vec.Vec2.Number} The new 2 element array.
     */
    function createNumber(): goog.vec.Vec2.Number;

    /**
     * Creates a new 2 element FLoat32 vector initialized with the value from the
     * given array.
     *
     * @param {goog.vec.Vec2.AnyType} vec The source 2 element array.
     * @return {!goog.vec.Vec2.Float32} The new 2 element array.
     */
    function createFloat32FromArray(vec: goog.vec.Vec2.AnyType): goog.vec.Vec2.Float32;

    /**
     * Creates a new 2 element Float32 vector initialized with the supplied values.
     *
     * @param {number} vec0 The value for element at index 0.
     * @param {number} vec1 The value for element at index 1.
     * @return {!goog.vec.Vec2.Float32} The new vector.
     */
    function createFloat32FromValues(vec0: number, vec1: number): goog.vec.Vec2.Float32;

    /**
     * Creates a clone of the given 2 element Float32 vector.
     *
     * @param {goog.vec.Vec2.Float32} vec The source 2 element vector.
     * @return {!goog.vec.Vec2.Float32} The new cloned vector.
     */
    function cloneFloat32(vec: goog.vec.Vec2.Float32): goog.vec.Vec2.Float32;

    /**
     * Creates a new 2 element Float64 vector initialized with the value from the
     * given array.
     *
     * @param {goog.vec.Vec2.AnyType} vec The source 2 element array.
     * @return {!goog.vec.Vec2.Float64} The new 2 element array.
     */
    function createFloat64FromArray(vec: goog.vec.Vec2.AnyType): goog.vec.Vec2.Float64;

    /**
    * Creates a new 2 element Float64 vector initialized with the supplied values.
    *
    * @param {number} vec0 The value for element at index 0.
    * @param {number} vec1 The value for element at index 1.
    * @return {!goog.vec.Vec2.Float64} The new vector.
    */
    function createFloat64FromValues(vec0: number, vec1: number): goog.vec.Vec2.Float64;

    /**
     * Creates a clone of the given 2 element vector.
     *
     * @param {goog.vec.Vec2.Float64} vec The source 2 element vector.
     * @return {!goog.vec.Vec2.Float64} The new cloned vector.
     */
    function cloneFloat64(vec: goog.vec.Vec2.Float64): goog.vec.Vec2.Float64;

    /**
     * Initializes the vector with the given values.
     *
     * @param {goog.vec.Vec2.AnyType} vec The vector to receive the values.
     * @param {number} vec0 The value for element at index 0.
     * @param {number} vec1 The value for element at index 1.
     * @return {!goog.vec.Vec2.AnyType} Return vec so that operations can be
     *     chained together.
     */
    function setFromValues(vec: goog.vec.Vec2.AnyType, vec0: number, vec1: number): goog.vec.Vec2.AnyType;

    /**
     * Initializes the vector with the given array of values.
     *
     * @param {goog.vec.Vec2.AnyType} vec The vector to receive the
     *     values.
     * @param {goog.vec.Vec2.AnyType} values The array of values.
     * @return {!goog.vec.Vec2.AnyType} Return vec so that operations can be
     *     chained together.
     */
    function setFromArray(vec: goog.vec.Vec2.AnyType, values: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Performs a component-wise addition of vec0 and vec1 together storing the
     * result into resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The first addend.
     * @param {goog.vec.Vec2.AnyType} vec1 The second addend.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to
     *     receive the result. May be vec0 or vec1.
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function add(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Performs a component-wise subtraction of vec1 from vec0 storing the
     * result into resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The minuend.
     * @param {goog.vec.Vec2.AnyType} vec1 The subtrahend.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to
     *     receive the result. May be vec0 or vec1.
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function subtract(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Negates vec0, storing the result into resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The vector to negate.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to
     *     receive the result. May be vec0.
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function negate(vec0: goog.vec.Vec2.AnyType, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Takes the absolute value of each component of vec0 storing the result in
     * resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The source vector.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to receive the result.
     *     May be vec0.
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function abs(vec0: goog.vec.Vec2.AnyType, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Multiplies each component of vec0 with scalar storing the product into
     * resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The source vector.
     * @param {number} scalar The value to multiply with each component of vec0.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to
     *     receive the result. May be vec0.
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function scale(vec0: goog.vec.Vec2.AnyType, scalar: number, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Returns the magnitudeSquared of the given vector.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The vector.
     * @return {number} The magnitude of the vector.
     */
    function magnitudeSquared(vec0: goog.vec.Vec2.AnyType): number;

    /**
     * Returns the magnitude of the given vector.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The vector.
     * @return {number} The magnitude of the vector.
     */
    function magnitude(vec0: goog.vec.Vec2.AnyType): number;

    /**
     * Normalizes the given vector storing the result into resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The vector to normalize.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to
     *     receive the result. May be vec0.
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function normalize(vec0: goog.vec.Vec2.AnyType, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Returns the scalar product of vectors vec0 and vec1.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The first vector.
     * @param {goog.vec.Vec2.AnyType} vec1 The second vector.
     * @return {number} The scalar product.
     */
    function dot(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType): number;

    /**
     * Returns the squared distance between two points.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 First point.
     * @param {goog.vec.Vec2.AnyType} vec1 Second point.
     * @return {number} The squared distance between the points.
     */
    function distanceSquared(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType): number;

    /**
     * Returns the distance between two points.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 First point.
     * @param {goog.vec.Vec2.AnyType} vec1 Second point.
     * @return {number} The distance between the points.
     */
    function distance(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType): number;

    /**
     * Returns a unit vector pointing from one point to another.
     * If the input points are equal then the result will be all zeros.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 Origin point.
     * @param {goog.vec.Vec2.AnyType} vec1 Target point.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to receive the
     *     results (may be vec0 or vec1).
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function direction(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Linearly interpolate from vec0 to vec1 according to f. The value of f should
     * be in the range [0..1] otherwise the results are undefined.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The first vector.
     * @param {goog.vec.Vec2.AnyType} vec1 The second vector.
     * @param {number} f The interpolation factor.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to receive the
     *     results (may be vec0 or vec1).
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function lerp(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType, f: number, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Compares the components of vec0 with the components of another vector or
     * scalar, storing the larger values in resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The source vector.
     * @param {goog.vec.Vec2.AnyType|number} limit The limit vector or scalar.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to receive the
     *     results (may be vec0 or limit).
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function max(vec0: goog.vec.Vec2.AnyType, limit: goog.vec.Vec2.AnyType|number, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Compares the components of vec0 with the components of another vector or
     * scalar, storing the smaller values in resultVec.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The source vector.
     * @param {goog.vec.Vec2.AnyType|number} limit The limit vector or scalar.
     * @param {goog.vec.Vec2.AnyType} resultVec The vector to receive the
     *     results (may be vec0 or limit).
     * @return {!goog.vec.Vec2.AnyType} Return resultVec so that operations can be
     *     chained together.
     */
    function min(vec0: goog.vec.Vec2.AnyType, limit: goog.vec.Vec2.AnyType|number, resultVec: goog.vec.Vec2.AnyType): goog.vec.Vec2.AnyType;

    /**
     * Returns true if the components of vec0 are equal to the components of vec1.
     *
     * @param {goog.vec.Vec2.AnyType} vec0 The first vector.
     * @param {goog.vec.Vec2.AnyType} vec1 The second vector.
     * @return {boolean} True if the vectors are equal, false otherwise.
     */
    function equals(vec0: goog.vec.Vec2.AnyType, vec1: goog.vec.Vec2.AnyType): boolean;
}