UNPKG

laya-coreui-es

Version:

laya核心库、ui库es版本,剔除了媒体、TTF等功能。基于 LayaAir-release_2.12.0 修改

119 lines (118 loc) 5.88 kB
/** * <p><code>Rectangle</code> 对象是按其位置(由它左上角的点 (x, y) 确定)以及宽度和高度定义的区域。</p> * <p>Rectangle 类的 x、y、width 和 height 属性相互独立;更改一个属性的值不会影响其他属性。</p> */ export declare class Rectangle { /**@private 全局空的矩形区域x=0,y=0,width=0,height=0,不允许修改此对象内容*/ static EMPTY: Rectangle; /**全局临时的矩形区域,此对象用于全局复用,以减少对象创建*/ static TEMP: Rectangle; /** @private */ private static _temB; /** @private */ private static _temA; /** 矩形左上角的 X 轴坐标。*/ x: number; /** 矩形左上角的 Y 轴坐标。*/ y: number; /** 矩形的宽度。*/ width: number; /** 矩形的高度。*/ height: number; /** * 创建一个 <code>Rectangle</code> 对象。 * @param x 矩形左上角的 X 轴坐标。 * @param y 矩形左上角的 Y 轴坐标。 * @param width 矩形的宽度。 * @param height 矩形的高度。 */ constructor(x?: number, y?: number, width?: number, height?: number); /** 此矩形右侧的 X 轴坐标。 x 和 width 属性的和。*/ get right(): number; /** 此矩形底端的 Y 轴坐标。y 和 height 属性的和。*/ get bottom(): number; /** * 将 Rectangle 的属性设置为指定值。 * @param x x 矩形左上角的 X 轴坐标。 * @param y x 矩形左上角的 Y 轴坐标。 * @param width 矩形的宽度。 * @param height 矩形的高。 * @return 返回属性值修改后的矩形对象本身。 */ setTo(x: number, y: number, width: number, height: number): Rectangle; /** * 重置 */ reset(): Rectangle; /** * 回收 */ recover(): void; /** * 创建 */ static create(): Rectangle; /** * 复制 source 对象的属性值到此矩形对象中。 * @param sourceRect 源 Rectangle 对象。 * @return 返回属性值修改后的矩形对象本身。 */ copyFrom(source: Rectangle): Rectangle; /** * 确定由此 Rectangle 对象定义的矩形区域内是否包含指定的点。 * @param x 点的 X 轴坐标值(水平位置)。 * @param y 点的 Y 轴坐标值(垂直位置)。 * @return 如果 Rectangle 对象包含指定的点,则值为 true;否则为 false。 */ contains(x: number, y: number): boolean; /** * 确定在 rect 参数中指定的对象是否与此 Rectangle 对象相交。此方法检查指定的 Rectangle 对象的 x、y、width 和 height 属性,以查看它是否与此 Rectangle 对象相交。 * @param rect Rectangle 对象。 * @return 如果传入的矩形对象与此对象相交,则返回 true 值,否则返回 false。 */ intersects(rect: Rectangle): boolean; /** * 如果在 rect 参数中指定的 Rectangle 对象与此 Rectangle 对象相交,则返回交集区域作为 Rectangle 对象。如果矩形不相交,则此方法返回null。 * @param rect 待比较的矩形区域。 * @param out (可选)待输出的矩形区域。如果为空则创建一个新的。建议:尽量复用对象,减少对象创建消耗。 * @return 返回相交的矩形区域对象。 */ intersection(rect: Rectangle, out?: Rectangle | null): Rectangle | null; /** * <p>矩形联合,通过填充两个矩形之间的水平和垂直空间,将这两个矩形组合在一起以创建一个新的 Rectangle 对象。</p> * <p>注意:union() 方法忽略高度或宽度值为 0 的矩形,如:var rect2:Rectangle = new Rectangle(300,300,50,0);</p> * @param 要添加到此 Rectangle 对象的 Rectangle 对象。 * @param out 用于存储输出结果的矩形对象。如果为空,则创建一个新的。建议:尽量复用对象,减少对象创建消耗。Rectangle.TEMP对象用于对象复用。 * @return 充当两个矩形的联合的新 Rectangle 对象。 */ union(source: Rectangle, out?: Rectangle | null): Rectangle; /** * 返回一个 Rectangle 对象,其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。 * @param out (可选)用于存储结果的矩形对象。如果为空,则创建一个新的。建议:尽量复用对象,减少对象创建消耗。。Rectangle.TEMP对象用于对象复用。 * @return Rectangle 对象,其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。 */ clone(out?: Rectangle | null): Rectangle; /** * 当前 Rectangle 对象的水平位置 x 和垂直位置 y 以及高度 width 和宽度 height 以逗号连接成的字符串。 */ toString(): string; /** * 检测传入的 Rectangle 对象的属性是否与当前 Rectangle 对象的属性 x、y、width、height 属性值都相等。 * @param rect 待比较的 Rectangle 对象。 * @return 如果判断的属性都相等,则返回 true ,否则返回 false。 */ equals(rect: Rectangle): boolean; /** * <p>为当前矩形对象加一个点,以使当前矩形扩展为包含当前矩形和此点的最小矩形。</p> * <p>此方法会修改本对象。</p> * @param x 点的 X 坐标。 * @param y 点的 Y 坐标。 * @return 返回此 Rectangle 对象。 */ addPoint(x: number, y: number): Rectangle; /** * 确定此 Rectangle 对象是否为空。 * @return 如果 Rectangle 对象的宽度或高度小于等于 0,则返回 true 值,否则返回 false。 */ isEmpty(): boolean; }