包 com.supermap.web.core
类 public class Rectangle2D
继承 Rectangle2D Inheritance Object

矩形.

用于定义具有实际地理坐标的矩形范围，可用来表示几何对象的最小外接矩形、地图窗口的可视范围、数据集的范围等。
。


公共属性
  属性 定义方
    bbox : String
获取或设置矩形对象的地理范围。
 Rectangle2D
    bottom : Number
[read-only] 获取矩形对象的下边界值。
 Rectangle2D
    bottomLeft : Point2D
[read-only] 获取矩形对象的左下角点坐标。
 Rectangle2D
    center : Point2D
[read-only] 获取矩形对象的中心点。
 Rectangle2D
    height : Number
[read-only] 获取矩形对象的高度。
 Rectangle2D
    left : Number
[read-only] 获取矩形对象的左边界值。
 Rectangle2D
    right : Number
[read-only] 获取矩形对象的右边界值。
 Rectangle2D
    top : Number
[read-only] 获取矩形对象的上边界值。
 Rectangle2D
    topRight : Point2D
[read-only] 获取矩形对象的右上角点坐标。
 Rectangle2D
    width : Number
[read-only] 获取矩形对象的宽度。
 Rectangle2D
公共方法
  方法 定义方
   
Rectangle2D(left:Number = 0.0, bottom:Number = 0.0, right:Number = 0.0, top:Number = 0.0)
初始化（ Rectangle2D ）的新实例.
 Rectangle2D
   
centerAt(x:Number, y:Number):Rectangle2D
将 Rectangle2D 对象的中心移至指定的坐标。
 Rectangle2D
   
centerAtPoint(pnt2D:Point2D):Rectangle2D
将 Rectangle2D 对象的中心移至指定的点。
 Rectangle2D
   
clone():Rectangle2D
克隆矩形对象.
 Rectangle2D
   
contains(dx:Number, dy:Number):Boolean
此方法与 Rectangle2D.containsPoint() 方法类似，只不过它采用的是 Point2D 对象坐标值 x、y 作为参数。
 Rectangle2D
   
containsPoint(pnt2D:Point2D):Boolean
判断指定的 Point2D 对象是否在当前 Rectangle2D 对象的边界范围内。
 Rectangle2D
   
containsRect(rect2D:Rectangle2D):Boolean
判断指定的 Rectangle2D 对象是否在当前 Rectangle2D 对象的边界范围内。
 Rectangle2D
   
createFromXYWidthHeight(x:Number, y:Number, width:Number, height:Number):Rectangle2D
[static] 根据指定的左下角点坐标、宽度、高度创建新的 Rectangle2D 对象。此方法为静态类型，可以由类名直接调用。
 Rectangle2D
   
equals(rect2D:Rectangle2D):Boolean
判断指定的 Rectangle2D 类型矩形对象是否与当前矩形对象具有相同坐标值。
 Rectangle2D
   
expand(factor:Number):Rectangle2D
根据增大因子增加 Rectangle2D 对象的大小。即保持 Rectangle2D 对象的中心点不变，
 Rectangle2D
   
inflate(dx:Number, dy:Number):Rectangle2D
按指定量增加 Rectangle2D 对象的大小。即保持 Rectangle2D 对象的中心点不变，使用 dx 值横向增加它的大小，使用 dy 值纵向增加它的大小。
 Rectangle2D
   
inflatePoint(pnt2D:Point2D):Rectangle2D
增加 Rectangle2D 对象的大小。此方法与 Rectangle2D.inflate() 方法类似，只不过它采用（ Point2D ）对象作为参数。
 Rectangle2D
   
intersection(rect2D:Rectangle2D):Rectangle2D
获取指定的 Rectangle2D 对象与当前 Rectangle2D 对象的交集.
 Rectangle2D
   
intersects(rect2D:Rectangle2D):Boolean
判断指定的 Rectangle2D 对象与当前 Rectangle2D 对象是否有交集。
 Rectangle2D
   
isEmpty():Boolean
判断矩形对象是否为空。
 Rectangle2D
   
offset(dx:Number, dy:Number):Rectangle2D
根据指定偏移量移动 Rectangle2D 对象。
 Rectangle2D
   
offsetPoint(pnt2D:Point2D):Rectangle2D
根据坐标点移动 Rectangle2D 对象。 即以点的坐标值为偏移量。
 Rectangle2D
   
toString():String
将 Rectangle2D 对象转化成规定字符串表示形式。
 Rectangle2D
   
union(rect2D:Rectangle2D):Rectangle2D
获取指定的 Rectangle2D 对象与当前 Rectangle2D 对象的最小外接矩形.
 Rectangle2D
   
unionPoint(pnt2D:Point2D):Rectangle2D
根据指定的 Point2D 对象与当前的 Rectangle2D 对象创建新的矩形对象.
 Rectangle2D
   
unionXY(x:Number, y:Number):Rectangle2D
此方法与 Rectangle2D.unionPoint() 方法类似，只不过它采用的是 Point2D 对象坐标值 x、y 作为参数.
 Rectangle2D
   
update(left:Number, bottom:Number, right:Number, top:Number):void
更新矩形对象。即重新设置矩形的边界范围。
 Rectangle2D
   
within(rect2D:Rectangle2D):Boolean
判断当前 Rectangle2D 对象是否在指定的 Rectangle2D 对象的边界范围内。
 Rectangle2D
属性详细信息
bbox 属性
bbox:String

获取或设置矩形对象的地理范围。


Implementation
    public function get bbox():String
    public function set bbox(value:String):void
bottom 属性  
bottom:Number  [read-only]

获取矩形对象的下边界值。


Implementation
    public function get bottom():Number
bottomLeft 属性  
bottomLeft:Point2D  [read-only]

获取矩形对象的左下角点坐标。


Implementation
    public function get bottomLeft():Point2D
center 属性  
center:Point2D  [read-only]

获取矩形对象的中心点。


Implementation
    public function get center():Point2D
height 属性  
height:Number  [read-only]

获取矩形对象的高度。


Implementation
    public function get height():Number
left 属性  
left:Number  [read-only]

获取矩形对象的左边界值。


Implementation
    public function get left():Number
right 属性  
right:Number  [read-only]

获取矩形对象的右边界值。


Implementation
    public function get right():Number
top 属性  
top:Number  [read-only]

获取矩形对象的上边界值。


Implementation
    public function get top():Number
topRight 属性  
topRight:Point2D  [read-only]

获取矩形对象的右上角点坐标。


Implementation
    public function get topRight():Point2D
width 属性  
width:Number  [read-only]

获取矩形对象的宽度。


Implementation
    public function get width():Number
构造函数详细信息
Rectangle2D () 构造函数
public function Rectangle2D(left:Number = 0.0, bottom:Number = 0.0, right:Number = 0.0, top:Number = 0.0)

初始化（ Rectangle2D ）的新实例. 初始化该类需要四个参数，分别为：左边界（left）、下边界（bottom）、右边界（right）、上边界（top）。其中 right - left 、top - bottom 必须大于等 0，否则就会抛出异常。
。

参数
left:Number (default = 0.0)
 
bottom:Number (default = 0.0)
 
right:Number (default = 0.0)
 
top:Number (default = 0.0)
方法详细描述
centerAt () 方法
public function centerAt(x:Number, y:Number):Rectangle2D

将 Rectangle2D 对象的中心移至指定的坐标。

参数

x:Number — 指定的 x 坐标。
 
y:Number — 指定的 y 坐标。

返回
Rectangle2D — 返回移动后的 Rectangle2D 对象。
centerAtPoint () 方法  
public function centerAtPoint(pnt2D:Point2D):Rectangle2D

将 Rectangle2D 对象的中心移至指定的点。

参数

pnt2D:Point2D — 指定的坐标点。

返回
Rectangle2D — 返回移动后的 Rectangle2D 对象。
clone () 方法  
public function clone():Rectangle2D

克隆矩形对象. 克隆与复制的区别在于，克隆要创建一个新的与原对象一样的对象；而复制则是将原对象中的值复制到现在的对象中，不需要重新创建一个对象。

返回
Rectangle2D — 返回克隆后产生的新的矩形对象。
contains () 方法  
public function contains(dx:Number, dy:Number):Boolean

此方法与 Rectangle2D.containsPoint() 方法类似，只不过它采用的是 Point2D 对象坐标值 x、y 作为参数。

参数

dx:Number — 横向坐标值。
 
dy:Number — 纵向坐标值。

返回
Boolean — 若由指定的 x、y 确定的点在 Rectangle2D 范围内（包括在边界上），则返回 true；否则返回 false。
containsPoint () 方法  
public function containsPoint(pnt2D:Point2D):Boolean

判断指定的 Point2D 对象是否在当前 Rectangle2D 对象的边界范围内。

参数

pnt2D:Point2D — 指定的 Point2D 对象。

返回
Boolean — 若指定的 Rectangle2D 对象在当前 Rectangle2D 对象的边界范围内，则返回 true；否则，返回false。
containsRect () 方法  
public function containsRect(rect2D:Rectangle2D):Boolean

判断指定的 Rectangle2D 对象是否在当前 Rectangle2D 对象的边界范围内。

参数

rect2D:Rectangle2D — 指定的 Rectangle2D 对象。

返回
Boolean — 若指定的 Rectangle2D 对象在当前 Rectangle2D 对象的边界范围内，则返回 true；否则，返回false。
createFromXYWidthHeight () 方法  
public static function createFromXYWidthHeight(x:Number, y:Number, width:Number, height:Number):Rectangle2D

根据指定的左下角点坐标、宽度、高度创建新的 Rectangle2D 对象。此方法为静态类型，可以由类名直接调用。

参数

x:Number — 左下角点的横坐标。
 
y:Number — 左正角点的纵坐标。
 
width:Number — 指定的宽度。
 
height:Number — 指定的高度。

返回
Rectangle2D — 返回新创建的 Rectangle2D 对象。
equals () 方法  
public function equals(rect2D:Rectangle2D):Boolean

判断指定的 Rectangle2D 类型矩形对象是否与当前矩形对象具有相同坐标值。

参数

rect2D:Rectangle2D — 当前指定的矩形对象。

返回
Boolean — 若相等则返回 true，否则，返回 false。
expand () 方法  
public function expand(factor:Number):Rectangle2D

根据增大因子增加 Rectangle2D 对象的大小。即保持 Rectangle2D 对象的中心点不变，

参数

factor:Number — 增大因子。以下等式用于将增大因子

返回
Rectangle2D — 返回拉伸后的 Rectangle2D 对象。
inflate () 方法  
public function inflate(dx:Number, dy:Number):Rectangle2D

按指定量增加 Rectangle2D 对象的大小。即保持 Rectangle2D 对象的中心点不变，使用 dx 值横向增加它的大小，使用 dy 值纵向增加它的大小。

参数

dx:Number — 横向增加量。
 
dy:Number — 纵向增加量。

返回
Rectangle2D — 返回大小改变后的 Rectangle2D 对象。
inflatePoint () 方法  
public function inflatePoint(pnt2D:Point2D):Rectangle2D

增加 Rectangle2D 对象的大小。此方法与 Rectangle2D.inflate() 方法类似，只不过它采用（ Point2D ）对象作为参数。

参数

pnt2D:Point2D — 指定的坐标点。

返回
Rectangle2D — 返回大小改变后的 Rectangle2D 对象。
intersection () 方法  
public function intersection(rect2D:Rectangle2D):Rectangle2D

获取指定的 Rectangle2D 对象与当前 Rectangle2D 对象的交集.

参数

rect2D:Rectangle2D — 指定的 Rectangle2D 对象。

返回
Rectangle2D — 返回两个对象的交集（ Rectangle2D 类型）。intersection.png
intersects () 方法  
public function intersects(rect2D:Rectangle2D):Boolean

判断指定的 Rectangle2D 对象与当前 Rectangle2D 对象是否有交集。

参数

rect2D:Rectangle2D — 指定的 Rectangle2D 对象。

返回
Boolean — 若有交集则返回 true；否则，返回 false。
isEmpty () 方法  
public function isEmpty():Boolean

判断矩形对象是否为空。

返回
Boolean — 返回克隆后产生的新的矩形对象。
offset () 方法  
public function offset(dx:Number, dy:Number):Rectangle2D

根据指定偏移量移动 Rectangle2D 对象。

参数

dx:Number — 横向偏移量。
 
dy:Number — 纵向偏移量。

返回
Rectangle2D — 返回移动后的 Rectangle2D 对象。
offsetPoint () 方法  
public function offsetPoint(pnt2D:Point2D):Rectangle2D

根据坐标点移动 Rectangle2D 对象。 即以点的坐标值为偏移量。

参数

pnt2D:Point2D — 指定的坐标点。

返回
Rectangle2D — 返回移动后的 Rectangle2D 对象。
toString () 方法  
public function toString():String

将 Rectangle2D 对象转化成规定字符串表示形式。

返回
String — 以字符串的形式返回 Rectangle2D 对象，格式为：（左，下，右，上）。
union () 方法  
public function union(rect2D:Rectangle2D):Rectangle2D

获取指定的 Rectangle2D 对象与当前 Rectangle2D 对象的最小外接矩形.

参数

rect2D:Rectangle2D — 指定的 Rectangle2D 对象。

返回
Rectangle2D — 最小外接矩形。
unionPoint () 方法  
public function unionPoint(pnt2D:Point2D):Rectangle2D

根据指定的 Point2D 对象与当前的 Rectangle2D 对象创建新的矩形对象.

参数

pnt2D:Point2D — 指定的 Point2D 对象。

返回
Rectangle2D — 返回新创建的矩形对象。
unionXY () 方法  
public function unionXY(x:Number, y:Number):Rectangle2D

此方法与 Rectangle2D.unionPoint() 方法类似，只不过它采用的是 Point2D 对象坐标值 x、y 作为参数.

参数

x:Number — 横向坐标值。
 
y:Number — 纵向坐标值。

返回
Rectangle2D — 返回新创建的矩形对象。
update () 方法  
public function update(left:Number, bottom:Number, right:Number, top:Number):void

更新矩形对象。即重新设置矩形的边界范围。

参数

left:Number — 左边界。
 
bottom:Number — 下边界。
 
right:Number — 右边界。
 
top:Number — 上边界。

within () 方法  
public function within(rect2D:Rectangle2D):Boolean

判断当前 Rectangle2D 对象是否在指定的 Rectangle2D 对象的边界范围内。

参数

rect2D:Rectangle2D — 指定的 Rectangle2D 对象。

返回
Boolean — 若当前 Rectangle2D 对象在指定的 Rectangle2D 对象的边界范围内，则返回 true；否则，返回false。




Wed Dec 23 2015, 12:01 AM +08:00