| Package | laya.maths |
| Class | public class Rectangle |
| Inheritance | Rectangle Object |
Rectangle 对象是按其位置(由它左上角的点 (x, y) 确定)以及宽度和高度定义的区域。
Rectangle 类的 x、y、width 和 height 属性相互独立;更改一个属性的值不会影响其他属性。
| Property | Defined By | ||
|---|---|---|---|
| bottom : Number [read-only] 此矩形底端的 Y 轴坐标。y 和 height 属性的和。 | Rectangle | ||
| height : Number 矩形的高度。 | Rectangle | ||
| right : Number [read-only] 此矩形右侧的 X 轴坐标。 x 和 width 属性的和。 | Rectangle | ||
| width : Number 矩形的宽度。 | Rectangle | ||
| x : Number 矩形左上角的 X 轴坐标。 | Rectangle | ||
| y : Number 矩形左上角的 Y 轴坐标。 | Rectangle | ||
| Method | Defined By | ||
|---|---|---|---|
Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)
创建一个 Rectangle 对象。
| Rectangle | ||
为当前矩形对象加一个点,以使当前矩形扩展为包含当前矩形和此点的最小矩形。
此方法会修改本对象。
| Rectangle | ||
返回一个 Rectangle 对象,其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。
| Rectangle | ||
contains(x:Number, y:Number):Boolean
确定由此 Rectangle 对象定义的矩形区域内是否包含指定的点。
| Rectangle | ||
复制 source 对象的属性值到此矩形对象中。
| Rectangle | ||
检测传入的 Rectangle 对象的属性是否与当前 Rectangle 对象的属性 x、y、width、height 属性值都相等。
| Rectangle | ||
如果在 rect 参数中指定的 Rectangle 对象与此 Rectangle 对象相交,则返回交集区域作为 Rectangle 对象。如果矩形不相交,则此方法返回null。
| Rectangle | ||
intersects(rect:Rectangle):Boolean
确定在 rect 参数中指定的对象是否与此 Rectangle 对象相交。此方法检查指定的 Rectangle 对象的 x、y、width 和 height 属性,以查看它是否与此 Rectangle 对象相交。
| Rectangle | ||
isEmpty():Boolean
确定此 Rectangle 对象是否为空。
| Rectangle | ||
将 Rectangle 的属性设置为指定值。
| Rectangle | ||
toString():String
当前 Rectangle 对象的水平位置 x 和垂直位置 y 以及高度 width 和宽度 height 以逗号连接成的字符串。
| Rectangle | ||
矩形联合,通过填充两个矩形之间的水平和垂直空间,将这两个矩形组合在一起以创建一个新的 Rectangle 对象。
注意:union() 方法忽略高度或宽度值为 0 的矩形,如:var rect2:Rectangle = new Rectangle(300,300,50,0);
| Rectangle | ||
| bottom | property |
bottom:Number [read-only] 此矩形底端的 Y 轴坐标。y 和 height 属性的和。
public function get bottom():Number| height | property |
public var height:Number矩形的高度。
| right | property |
right:Number [read-only] 此矩形右侧的 X 轴坐标。 x 和 width 属性的和。
public function get right():Number| width | property |
public var width:Number矩形的宽度。
| x | property |
public var x:Number矩形左上角的 X 轴坐标。
| y | property |
public var y:Number矩形左上角的 Y 轴坐标。
| Rectangle | () | Constructor |
public function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)
创建一个 Rectangle 对象。
x:Number (default = 0) — 矩形左上角的 X 轴坐标。
| |
y:Number (default = 0) — 矩形左上角的 Y 轴坐标。
| |
width:Number (default = 0) — 矩形的宽度。
| |
height:Number (default = 0) — 矩形的高度。
|
| addPoint | () | method |
public function addPoint(x:Number, y:Number):Rectangle
为当前矩形对象加一个点,以使当前矩形扩展为包含当前矩形和此点的最小矩形。
此方法会修改本对象。
Parameters
x:Number — 点的 X 坐标。
| |
y:Number — 点的 Y 坐标。
|
Rectangle — 返回此 Rectangle 对象。
|
| clone | () | method |
public function clone(out:Rectangle = null):Rectangle返回一个 Rectangle 对象,其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。
Parameters
out:Rectangle (default = null) — (可选)用于存储结果的矩形对象。如果为空,则创建一个新的。建议:尽量复用对象,减少对象创建消耗。。Rectangle.TEMP对象用于对象复用。
|
Rectangle — Rectangle 对象,其 x、y、width 和 height 属性的值与当前 Rectangle 对象的对应值相同。
|
| contains | () | method |
public function contains(x:Number, y:Number):Boolean确定由此 Rectangle 对象定义的矩形区域内是否包含指定的点。
Parameters
x:Number — 点的 X 轴坐标值(水平位置)。
| |
y:Number — 点的 Y 轴坐标值(垂直位置)。
|
Boolean — 如果 Rectangle 对象包含指定的点,则值为 true;否则为 false。
|
| copyFrom | () | method |
public function copyFrom(source:Rectangle):Rectangle复制 source 对象的属性值到此矩形对象中。
Parameters
source:Rectangle — 源 Rectangle 对象。
|
Rectangle — 返回属性值修改后的矩形对象本身。
|
| equals | () | method |
public function equals(rect:Rectangle):Boolean检测传入的 Rectangle 对象的属性是否与当前 Rectangle 对象的属性 x、y、width、height 属性值都相等。
Parameters
rect:Rectangle — 待比较的 Rectangle 对象。
|
Boolean — 如果判断的属性都相等,则返回 true ,否则返回 false。
|
| intersection | () | method |
public function intersection(rect:Rectangle, out:Rectangle = null):Rectangle如果在 rect 参数中指定的 Rectangle 对象与此 Rectangle 对象相交,则返回交集区域作为 Rectangle 对象。如果矩形不相交,则此方法返回null。
Parameters
rect:Rectangle — 待比较的矩形区域。
| |
out:Rectangle (default = null) — (可选)待输出的矩形区域。如果为空则创建一个新的。建议:尽量复用对象,减少对象创建消耗。
|
Rectangle — 返回相交的矩形区域对象。
|
| intersects | () | method |
public function intersects(rect:Rectangle):Boolean确定在 rect 参数中指定的对象是否与此 Rectangle 对象相交。此方法检查指定的 Rectangle 对象的 x、y、width 和 height 属性,以查看它是否与此 Rectangle 对象相交。
Parameters
rect:Rectangle — Rectangle 对象。
|
Boolean — 如果传入的矩形对象与此对象相交,则返回 true 值,否则返回 false。
|
| isEmpty | () | method |
public function isEmpty():Boolean确定此 Rectangle 对象是否为空。
ReturnsBoolean — 如果 Rectangle 对象的宽度或高度小于等于 0,则返回 true 值,否则返回 false。
|
| setTo | () | method |
public function setTo(x:Number, y:Number, width:Number, height:Number):Rectangle将 Rectangle 的属性设置为指定值。
Parameters
x:Number — x 矩形左上角的 X 轴坐标。
| |
y:Number — x 矩形左上角的 Y 轴坐标。
| |
width:Number — 矩形的宽度。
| |
height:Number — 矩形的高。
|
Rectangle — 返回属性值修改后的矩形对象本身。
|
| toString | () | method |
public function toString():String当前 Rectangle 对象的水平位置 x 和垂直位置 y 以及高度 width 和宽度 height 以逗号连接成的字符串。
ReturnsString |
| union | () | method |
public function union(source:Rectangle, out:Rectangle = null):Rectangle
矩形联合,通过填充两个矩形之间的水平和垂直空间,将这两个矩形组合在一起以创建一个新的 Rectangle 对象。
注意:union() 方法忽略高度或宽度值为 0 的矩形,如:var rect2:Rectangle = new Rectangle(300,300,50,0);
Parameters
source:Rectangle — Rectangle 对象的 Rectangle 对象。
| |
out:Rectangle (default = null) — 用于存储输出结果的矩形对象。如果为空,则创建一个新的。建议:尽量复用对象,减少对象创建消耗。Rectangle.TEMP对象用于对象复用。
|
Rectangle — 充当两个矩形的联合的新 Rectangle 对象。
|
| TEMP | Constant |
public static const TEMP:Rectangle全局临时的矩形区域,此对象用于全局复用,以减少对象创建