Rectangle

套件	flash.geom
類別	public class Rectangle
繼承	Rectangle Object
子類別	RoundedRectangle

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

Rectangle 物件是由它的位置所定義的區域，並且是由它左上角的點 (x, y) 以及它的寬度及高度來表示。

Rectangle 類別的 x、y、width 和 height 屬性都是互相獨立的，因此變更其中任何一個屬性的值並不會對其他屬性造成影響。不過，right 和 bottom 屬性則與這四個屬性完全相關。例如，如果變更了 right 屬性值，width 屬性值就會變更；如果變更了 bottom 屬性值，height 屬性值就會變更。

下列方法和屬性都會使用 Rectangle 物件：

BitmapData 類別的 applyFilter()、colorTransform()、copyChannel()、copyPixels()、draw()、fillRect()、generateFilterRect()、getColorBoundsRect()、getPixels()、merge()、paletteMap()、pixelDisolve()、setPixels() 和 threshold() 方法以及 rect 屬性
DisplayObject 類別的 getBounds() 和 getRect() 方法以及 scrollRect 和 scale9Grid 屬性
TextField 類別的 getCharBoundaries() 方法
Transform 類別的 pixelBounds 屬性
Sprite 類別之 startDrag() 方法的 bounds 參數
PrintJob 類別之 addPage() 方法的 printArea 參數

您可以使用 new Rectangle() 建構函式來建立 Rectangle 物件。

注意：Rectangle 類別不會定義矩形的 Shape 顯示物件。若要在畫面上繪製矩形 Shape 物件，請使用 Graphics 類別的 drawRect() 方法。

檢視範例

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		bottom : Number y 和 height 屬性的總和。	Rectangle
		bottomRight : Point Rectangle 物件右下角的位置，這個位置會以 right 和 bottom 屬性值來決定。	Rectangle
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		height : Number 矩形的高度，以像素為單位。	Rectangle
		left : Number 矩形左上角的 x 座標。	Rectangle
		right : Number x 和 width 屬性的總和。	Rectangle
		size : Point Rectangle 物件的大小，以 Point 物件的 width 和 height 屬性值來表示。	Rectangle
		top : Number 矩形左上角的 y 座標。	Rectangle
		topLeft : Point Rectangle 物件左上角的位置，這個位置會以該點的 x 及 y 值來決定。	Rectangle
		width : Number 矩形的寬度，以像素為單位。	Rectangle
		x : Number 矩形左上角的 x 座標。	Rectangle
		y : Number 矩形左上角的 y 座標。	Rectangle

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0) 會使用 x 和 y 參數指定之左上角以及指定的寬度和高度，建立新的 Rectangle 物件。	Rectangle
		clone():Rectangle 傳回新的 Rectangle 物件，該物件具有與原始 Rectangle 物件相同的 x、y、width 和 height 屬性值。	Rectangle
		contains(x:Number, y:Number):Boolean 決定指定的點是否包含在此 Rectangle 物件所定義的矩形區域中。	Rectangle
		containsPoint(point:Point):Boolean 決定指定的點是否包含在此 Rectangle 物件所定義的矩形區域中。	Rectangle
		containsRect(rect:Rectangle):Boolean 判斷 rect 參數指定的 Rectangle 物件是否包含在此 Rectangle 物件內。	Rectangle
		copyFrom(sourceRect:Rectangle):void 將來源 Rectangle 物件中的所有矩形資料複製到呼叫的 Rectangle 物件。	Rectangle
		equals(toCompare:Rectangle):Boolean 判斷在 toCompare 參數中指定的物件是否等於此 Rectangle 物件。	Rectangle
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		inflate(dx:Number, dy:Number):void 會以指定的量來增加 Rectangle 物件的大小 (以像素為單位)。	Rectangle
		inflatePoint(point:Point):void 增加 Rectangle 物件的大小。	Rectangle
		intersection(toIntersect:Rectangle):Rectangle 如果在 toIntersect 參數中指定的 Rectangle 物件與此 Rectangle 物件有交集，便以 Rectangle 物件的形式傳回交集區域。	Rectangle
		intersects(toIntersect:Rectangle):Boolean 判斷在 toIntersect 參數中指定的物件是否與此 Rectangle 物件有交集。	Rectangle
		isEmpty():Boolean 決定此 Rectangle 物件是否為空白。	Rectangle
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		offset(dx:Number, dy:Number):void 依照指定的數量調整 Rectangle 物件的位置 (以它的左上角為準)。	Rectangle
		offsetPoint(point:Point):void 使用 Point 物件做為參數來調整 Rectangle 物件的位置。	Rectangle
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		setEmpty():void 將 Rectangle 物件的所有屬性設為 0。	Rectangle
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void 將 Rectangle 的成員設定為指定值	Rectangle
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 建立並傳回一個字串，用來列出 Rectangle 物件的水平和垂直位置，以及寬度及高度。	Rectangle
		union(toUnion:Rectangle):Rectangle 透過同時新增兩個矩形，並且填滿兩個矩形之間的水平及垂直空間，建立新的 Rectangle 物件。	Rectangle
		valueOf():Object 會傳回指定之物件的基本值。	Object

屬性詳細資訊

bottom

屬性

bottom:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

y 和 height 屬性的總和。

顯示位置和度量屬性的矩形影像。

實作
public function get bottom():Number
public function set bottom(value:Number):void

相關 API 元素

y
height

bottomRight

屬性

bottomRight:Point

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

Rectangle 物件右下角的位置，這個位置會以 right 和 bottom 屬性值來決定。

顯示位置和度量屬性的矩形影像。

實作
public function get bottomRight():Point
public function set bottomRight(value:Point):void

相關 API 元素

flash.geom.Point

height

屬性

public var height:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

矩形的高度，以像素為單位。變更 Rectangle 物件的 height 值並不會對 x、y 和 width 屬性造成影響。

顯示位置和度量屬性的矩形影像。

相關 API 元素

x
y
height

left

屬性

left:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

矩形左上角的 x 座標。變更 Rectangle 物件的 left 屬性並不會對 y 和 height 屬性造成影響。不過，這樣做會影響 width 屬性，而變更 x 值則不會影響 width 屬性。

left 屬性值等於 x 屬性值。

顯示位置和度量屬性的矩形影像。

實作
public function get left():Number
public function set left(value:Number):void

相關 API 元素

x
y
width
height

right

屬性

right:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

x 和 width 屬性的總和。

顯示位置和度量屬性的矩形影像。

實作
public function get right():Number
public function set right(value:Number):void

相關 API 元素

x
width

size

屬性

size:Point

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

Rectangle 物件的大小，以 Point 物件 (內含 width 和 height 屬性的值) 來表示。

實作
public function get size():Point
public function set size(value:Point):void

相關 API 元素

flash.geom.Point

top

屬性

top:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

矩形左上角的 y 座標。變更 Rectangle 物件的 top 屬性並不會對 x 和 width 屬性造成影響。不過，這樣做會影響 height 屬性，而變更 y 值則不會影響 height 屬性。

top 屬性值等於 y 屬性值。

顯示位置和度量屬性的矩形影像。

實作
public function get top():Number
public function set top(value:Number):void

相關 API 元素

x
y
width
height

topLeft

屬性

topLeft:Point

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

Rectangle 物件左上角的位置，這個位置會以該點的 x 及 y 值來決定。

顯示位置和度量屬性的矩形影像。

實作
public function get topLeft():Point
public function set topLeft(value:Point):void

相關 API 元素

flash.geom.Point
x
y

width

屬性

public var width:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

矩形的寬度，以像素為單位。變更 Rectangle 物件的 width 值並不會對 x、y 和 height 屬性造成影響。

顯示位置和度量屬性的矩形影像。

相關 API 元素

x
y
height

x

屬性

public var x:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

矩形左上角的 x 座標。變更 Rectangle 物件的 x 屬性值並不會對 y、width 和 height 屬性造成影響。

x 屬性值等於 left 屬性值。

相關 API 元素

left

y

屬性

public var y:Number

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

矩形左上角的 y 座標。變更 Rectangle 物件的 y 屬性值並不會對 x、width 和 height 屬性造成影響。

y 屬性值等於 top 屬性值。

相關 API 元素

x
width
height
top

建構函式詳細資料

()

建構函式

public function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

會使用 x 和 y 參數指定之左上角以及指定的 width 和 height 參數，建立新的 Rectangle 物件。如果您在呼叫這個函數時沒有使用參數，則會建立 x、y、width 和 height 屬性都設為 0 的矩形。

參數

	`x:Number` (default = `0`) — 矩形左上角的 x 座標。

	`y:Number` (default = `0`) — 矩形左上角的 y 座標。

	`width:Number` (default = `0`) — 矩形的寬度，以像素為單位。

	`height:Number` (default = `0`) — 矩形的高度，以像素為單位。

相關 API 元素

x
y
width
height

方法詳細資訊

clone

()

方法

public function clone():Rectangle

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

會傳回新的 Rectangle 物件，該物件具有與原始 Rectangle 物件相同的 x、y、width 和 height 屬性值。

傳回值

Rectangle — 新的 Rectangle 物件，與原始 Rectangle 物件具有相同的 x、y、width 和 height 屬性值。

相關 API 元素

x
y
width
height

contains

()

方法

public function contains(x:Number, y:Number):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

決定指定的點是否包含在此 Rectangle 物件所定義的矩形區域中。

參數

	`x:Number` — 該點的 x 座標 (水平位置)。

	`y:Number` — 該點的 y 座標 (垂直位置)。

傳回值

Boolean — 如果 Rectangle 物件包含指定的點，則值為 true，否則為 false。

相關 API 元素

flash.geom.Point

containsPoint

()

方法

public function containsPoint(point:Point):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

決定指定的點是否包含在此 Rectangle 物件所定義的矩形區域中。這個方法與 Rectangle.contains() 方法類似，不同點在於它會使用 Point 物件做為參數。

參數

point:Point — 以 x 和 y 座標表示的點。

傳回值

Boolean — 如果 Rectangle 物件包含指定的點，則值為 true，否則為 false。

相關 API 元素

contains()
flash.geom.Point

containsRect

()

方法

public function containsRect(rect:Rectangle):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

會決定 rect 參數指定的 Rectangle 物件是否包含在此 Rectangle 物件內。如果第二個 Rectangle 物件完全位於第一個 Rectangle 物件的邊界裡，則可以說第一個 Rectangle 物件包含了第二個 Rectangle。

參數

rect:Rectangle — 要檢查的 Rectangle 物件。

傳回值

Boolean — 如果您指定的 Rectangle 物件包含在此 Rectangle 物件中，則值為 true，否則為 false。

copyFrom

()

方法

public function copyFrom(sourceRect:Rectangle):void

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 11, AIR 3.0, Flash Lite 4

將來源 Rectangle 物件中的所有矩形資料複製到呼叫的 Rectangle 物件。

參數

sourceRect:Rectangle — 從其中複製資料的 Rectangle 物件。

equals

()

方法

public function equals(toCompare:Rectangle):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

會決定在 toCompare 參數中指定的物件是否等於此 Rectangle 物件。這個方法會將某個物件的 x、y、width 和 height 屬性與此 Rectangle 物件的相同屬性進行比較。

參數

toCompare:Rectangle — 要與此 Rectangle 物件相比較的矩形。

傳回值

Boolean — 如果該物件的 x、y、width 和 height 屬性值與此 Rectangle 物件完全相同，則值為 true，否則為 false。

相關 API 元素

x
y
width
height

inflate

()

方法

public function inflate(dx:Number, dy:Number):void

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Player 9, Flash Lite 4

會以指定的量來增加 Rectangle 物件的大小 (以像素為單位)。 Rectangle 物件的中心點將會維持不變，而它的大小則會向左方和右方增加 dx，並向上方和下方增加 dy。

參數

	`dx:Number` — Rectangle 物件向左方和右方所要增加的值。下列方程式可用來計算矩形新的寬度和位置： x -= dx; width += 2 * dx;

	`dy:Number` — Rectangle 物件向上方和下方所要增加的值。下列方程式可用來計算矩形新的高度和位置： y -= dy; height += 2 * dy;

相關 API 元素

x
y

inflatePoint

()

方法

public function inflatePoint(point:Point):void

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

增加 Rectangle 物件的大小。這個方法與 Rectangle.inflate() 方法類似，不同點在於它會使用 Point 物件做為參數。

以下兩段程式碼範例將會產生相同的結果：

     var rect1:Rectangle = new Rectangle(0,0,2,5);
     rect1.inflate(2,2)

     var rect1:Rectangle = new Rectangle(0,0,2,5);
     var pt1:Point = new Point(2,2);
     rect1.inflatePoint(pt1)

參數

point:Point — 這個 Point 物件的 x 屬性是用來增加 Rectangle 物件的水平尺寸； y 屬性則是用來增加 Rectangle 物件的垂直尺寸。

相關 API 元素

flash.geom.Point

intersection

()

方法

public function intersection(toIntersect:Rectangle):Rectangle

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

如果在 toIntersect 參數中指定的 Rectangle 物件與此 Rectangle 物件有交集，便以 Rectangle 物件的形式傳回交集區域。如果這些矩形沒有交集，這個方法會傳回空白的 Rectangle 物件，而且它的屬性都會設為 0。

產生的交集矩形。

參數

toIntersect:Rectangle — 要比較的 Rectangle 物件，以檢查它是否與此 Rectangle 物件有交集。

傳回值

Rectangle — 與交集區域相等的 Rectangle 物件。如果這些矩形沒有交集，這個方法會傳回空白的 Rectangle 物件，也就是 x、y、width 和 height 屬性都設為 0 的矩形。

intersects

()

方法

public function intersects(toIntersect:Rectangle):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

會決定在 toIntersect 參數中指定的物件是否與此 Rectangle 物件交集。這個方法會檢查指定之 Rectangle 物件的 x、y、width 和 height 屬性，以查看它與這個 Rectangle 物件是否有交集。

參數

toIntersect:Rectangle — 要與此 Rectangle 物件比較的 Rectangle 物件。

傳回值

Boolean — 如果指定的物件與此 Rectangle 物件有交集，則值為 true，否則為 false。

相關 API 元素

x
y
width
height

isEmpty

()

方法

public function isEmpty():Boolean

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

決定此 Rectangle 物件是否為空白。

傳回值

Boolean — 如果 Rectangle 物件的寬度或高度小於或等於 0，則值為 true，否則為 false。

offset

()

方法

public function offset(dx:Number, dy:Number):void

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

依照指定的數量調整 Rectangle 物件的位置 (以它的左上角為準)。

參數

	`dx:Number` — 會根據這個量來移動 Rectangle 物件的 x 值。

	`dy:Number` — 會根據這個量來移動 Rectangle 物件的 y 值。

offsetPoint

()

方法

public function offsetPoint(point:Point):void

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

使用 Point 物件做為參數來調整 Rectangle 物件的位置。這個方法與 Rectangle.offset() 方法類似，不同點在於它會使用 Point 物件做為參數。

參數

point:Point — 用來偏移此 Rectangle 物件的 Point 物件。

相關 API 元素

flash.geom.Point

setEmpty

()

方法

public function setEmpty():void

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

將 Rectangle 物件的所有屬性設為 0。如果 Rectangle 物件的寬度或高度小於或等於 0，則該物件為空白。

這個方法會將 x、y、width 和 height 屬性的值都設為 0。

相關 API 元素

x
y
width
height

setTo

()

方法

public function setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 11, AIR 3.0, Flash Lite 4

將 Rectangle 的成員設定為指定值

參數

	`xa:Number` — 用來設定矩形的值。

	`ya:Number`

	`widtha:Number`

	`heighta:Number`

toString

()

方法

public function toString():String

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

建立並傳回一個字串，用來列出 Rectangle 物件的水平和垂直位置，以及寬度及高度。

傳回值

String — 字串，其中列出 Rectangle 物件之下列各個屬性的值：x、y、width 和 height。

相關 API 元素

x
y
width
height

union

()

方法

public function union(toUnion:Rectangle):Rectangle

語言版本:

ActionScript 3.0

執行階段版本:

AIR 1.0, Flash Player 9, Flash Lite 4

透過同時新增兩個矩形，並且填滿兩個矩形之間的水平及垂直空間，建立新的 Rectangle 物件。

產生的聯集矩形。

注意：union() 方法會忽略以 0 作為高度與寬度值的矩形，例如：var rect2:Rectangle = new Rectangle(300,300,50,0);

參數

toUnion:Rectangle — 要加入至此 Rectangle 物件的 Rectangle 物件。

傳回值

Rectangle — 聯集兩個矩形的新 Rectangle 物件。

範例如何使用本範例

RectangleExample.as

下列範例將使用 RectangleExample 類別在各個 x、y 座標上建立三個具有不同高度和寬度的新 Rectangle 物件，然後使用 trace() 方法來確認已經成功建立 Rectangle 實體。接著指定 Boolean 變數 isContained 做為呼叫 containsRect() 方法的結果，來判斷第二個矩形是否全部封閉第三個矩形。

package {
    import flash.display.Sprite;
    import flash.geom.Rectangle;

    public class RectangleExample extends Sprite {

        public function RectangleExample() {
            var firstRect:Rectangle = new Rectangle();
            trace(firstRect);  // (x=0, y=0, w=0, h=0)
            var secondRect:Rectangle = new Rectangle(1, 3, 11, 13);
            trace(secondRect); // (x=1, y=3, w=11, h=13)
            var thirdRect:Rectangle = new Rectangle(5, 8, 17, 19);
            trace(thirdRect);  // (x=5, y=8, w=17, h=19)
            var isContained:Boolean = secondRect.containsRect(thirdRect);
            trace(isContained); // false
        }
    }
}

法律聲明 | 線上隱私權政策

Rectangle - AS3

類別 x

bottom

bottomRight

height

left

right

size

top

topLeft

width

x

y

Rectangle

clone

contains

containsPoint

containsRect

copyFrom

equals

inflate

inflatePoint

intersection

intersects

isEmpty

offset

offsetPoint

setEmpty

setTo

toString

union