typescript-closure-tools/index/closure-library/closure/goog/math/rect.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="./box.d.ts" />
/// <reference path="./coordinate.d.ts" />
/// <reference path="./size.d.ts" />

declare module goog.math {

    class Rect extends Rect__Class { }
    /** Fake class which should be extended to avoid inheriting static properties */
    class Rect__Class  { 
    
            /**
             * Class for representing rectangular regions.
             * @param {number} x Left.
             * @param {number} y Top.
             * @param {number} w Width.
             * @param {number} h Height.
             * @constructor
             */
            constructor(x: number, y: number, w: number, h: number);
    
            /** @type {number} */
            left: number;
    
            /** @type {number} */
            top: number;
    
            /** @type {number} */
            width: number;
    
            /** @type {number} */
            height: number;
    
            /**
             * @return {!goog.math.Rect} A new copy of this Rectangle.
             */
            clone(): goog.math.Rect;
    
            /**
             * Returns a new Box object with the same position and dimensions as this
             * rectangle.
             * @return {!goog.math.Box} A new Box representation of this Rectangle.
             */
            toBox(): goog.math.Box;
    
            /**
             * Computes the intersection of this rectangle and the rectangle parameter.  If
             * there is no intersection, returns false and leaves this rectangle as is.
             * @param {goog.math.Rect} rect A Rectangle.
             * @return {boolean} True iff this rectangle intersects with the parameter.
             */
            intersection(rect: goog.math.Rect): boolean;
    
            /**
             * Returns whether a rectangle intersects this rectangle.
             * @param {goog.math.Rect} rect A rectangle.
             * @return {boolean} Whether rect intersects this rectangle.
             */
            intersects(rect: goog.math.Rect): boolean;
    
            /**
             * Computes the difference regions between this rectangle and {@code rect}. The
             * return value is an array of 0 to 4 rectangles defining the remaining regions
             * of this rectangle after the other has been subtracted.
             * @param {goog.math.Rect} rect A Rectangle.
             * @return {!Array.<!goog.math.Rect>} An array with 0 to 4 rectangles which
             *     together define the difference area of rectangle a minus rectangle b.
             */
            difference(rect: goog.math.Rect): goog.math.Rect[];
    
            /**
             * Expand this rectangle to also include the area of the given rectangle.
             * @param {goog.math.Rect} rect The other rectangle.
             */
            boundingRect(rect: goog.math.Rect): void;
    
            /**
             * Tests whether this rectangle entirely contains another rectangle or
             * coordinate.
             *
             * @param {goog.math.Rect|goog.math.Coordinate} another The rectangle or
             *     coordinate to test for containment.
             * @return {boolean} Whether this rectangle contains given rectangle or
             *     coordinate.
             */
            contains(another: goog.math.Rect|goog.math.Coordinate): boolean;
    
            /**
             * @param {!goog.math.Coordinate} point A coordinate.
             * @return {number} The squared distance between the point and the closest
             *     point inside the rectangle. Returns 0 if the point is inside the
             *     rectangle.
             */
            squaredDistance(point: goog.math.Coordinate): number;
    
            /**
             * @param {!goog.math.Coordinate} point A coordinate.
             * @return {number} The distance between the point and the closest point
             *     inside the rectangle. Returns 0 if the point is inside the rectangle.
             */
            distance(point: goog.math.Coordinate): number;
    
            /**
             * @return {!goog.math.Size} The size of this rectangle.
             */
            getSize(): goog.math.Size;
    
            /**
             * @return {!goog.math.Coordinate} A new coordinate for the top-left corner of
             *     the rectangle.
             */
            getTopLeft(): goog.math.Coordinate;
    
            /**
             * @return {!goog.math.Coordinate} A new coordinate for the center of the
             *     rectangle.
             */
            getCenter(): goog.math.Coordinate;
    
            /**
             * @return {!goog.math.Coordinate} A new coordinate for the bottom-right corner
             *     of the rectangle.
             */
            getBottomRight(): goog.math.Coordinate;
    
            /**
             * Rounds the fields to the next larger integer values.
             * @return {!goog.math.Rect} This rectangle with ceil'd fields.
             */
            ceil(): goog.math.Rect;
    
            /**
             * Rounds the fields to the next smaller integer values.
             * @return {!goog.math.Rect} This rectangle with floored fields.
             */
            floor(): goog.math.Rect;
    
            /**
             * Rounds the fields to nearest integer values.
             * @return {!goog.math.Rect} This rectangle with rounded fields.
             */
            round(): goog.math.Rect;
    
            /**
             * Translates this rectangle by the given offsets. If a
             * {@code goog.math.Coordinate} is given, then the left and top values are
             * translated by the coordinate's x and y values. Otherwise, top and left are
             * translated by {@code tx} and {@code opt_ty} respectively.
             * @param {number|goog.math.Coordinate} tx The value to translate left by or the
             *     the coordinate to translate this rect by.
             * @param {number=} opt_ty The value to translate top by.
             * @return {!goog.math.Rect} This rectangle after translating.
             */
            translate(tx: number|goog.math.Coordinate, opt_ty?: number): goog.math.Rect;
    
            /**
             * Scales this rectangle by the given scale factors. The left and width values
             * are scaled by {@code sx} and the top and height values are scaled by
             * {@code opt_sy}.  If {@code opt_sy} is not given, then all fields are scaled
             * by {@code sx}.
             * @param {number} sx The scale factor to use for the x dimension.
             * @param {number=} opt_sy The scale factor to use for the y dimension.
             * @return {!goog.math.Rect} This rectangle after scaling.
             */
            scale(sx: number, opt_sy?: number): goog.math.Rect;
    } 
    
}

declare module goog.math.Rect {

    /**
     * Creates a new Rect object with the same position and dimensions as a given
     * Box.  Note that this is only the inverse of toBox if left/top are defined.
     * @param {goog.math.Box} box A box.
     * @return {!goog.math.Rect} A new Rect initialized with the box's position
     *     and size.
     */
    function createFromBox(box: goog.math.Box): goog.math.Rect;

    /**
     * Compares rectangles for equality.
     * @param {goog.math.Rect} a A Rectangle.
     * @param {goog.math.Rect} b A Rectangle.
     * @return {boolean} True iff the rectangles have the same left, top, width,
     *     and height, or if both are null.
     */
    function equals(a: goog.math.Rect, b: goog.math.Rect): boolean;

    /**
     * Returns the intersection of two rectangles. Two rectangles intersect if they
     * touch at all, for example, two zero width and height rectangles would
     * intersect if they had the same top and left.
     * @param {goog.math.Rect} a A Rectangle.
     * @param {goog.math.Rect} b A Rectangle.
     * @return {goog.math.Rect} A new intersection rect (even if width and height
     *     are 0), or null if there is no intersection.
     */
    function intersection(a: goog.math.Rect, b: goog.math.Rect): goog.math.Rect;

    /**
     * Returns whether two rectangles intersect. Two rectangles intersect if they
     * touch at all, for example, two zero width and height rectangles would
     * intersect if they had the same top and left.
     * @param {goog.math.Rect} a A Rectangle.
     * @param {goog.math.Rect} b A Rectangle.
     * @return {boolean} Whether a and b intersect.
     */
    function intersects(a: goog.math.Rect, b: goog.math.Rect): boolean;

    /**
     * Computes the difference regions between two rectangles. The return value is
     * an array of 0 to 4 rectangles defining the remaining regions of the first
     * rectangle after the second has been subtracted.
     * @param {goog.math.Rect} a A Rectangle.
     * @param {goog.math.Rect} b A Rectangle.
     * @return {!Array.<!goog.math.Rect>} An array with 0 to 4 rectangles which
     *     together define the difference area of rectangle a minus rectangle b.
     */
    function difference(a: goog.math.Rect, b: goog.math.Rect): goog.math.Rect[];

    /**
     * Returns a new rectangle which completely contains both input rectangles.
     * @param {goog.math.Rect} a A rectangle.
     * @param {goog.math.Rect} b A rectangle.
     * @return {goog.math.Rect} A new bounding rect, or null if either rect is
     *     null.
     */
    function boundingRect(a: goog.math.Rect, b: goog.math.Rect): goog.math.Rect;
}