パッケージflash.geom
public class Rectangle
継承Rectangle Inheritance Object
SubclassesRoundedRectangle

Rectangle オブジェクトは、その位置 (左上隅のポイント (x, y) で示される)、および幅と高さで定義される領域です。

Rectangle クラスの xywidth、および height の各プロパティは、互いに独立しているため、あるプロパティの値を変更しても、他のプロパティに影響はありません。ただし、right プロパティと bottom プロパティはこれら 4 つのプロパティと不可分に関連しています。たとえば、right プロパティの値を変更すると width プロパティの値も変更されます。bottom プロパティの値を変更すると、height プロパティの値も変更されます。

次のメソッドおよびプロパティでは、Rectangle オブジェクトを使用します。

Rectangle オブジェクトを作成するには、new Rectangle() コンストラクタを使用します。

メモ:Rectangle クラスは矩形シェイプの表示オブジェクトを定義しません。矩形シェイプオブジェクトを画面上に描画するには、Graphics クラスの drawRect() メソッドを使用します。

例の表示

関連項目

flash.display.DisplayObject.scrollRect
flash.display.BitmapData
flash.display.DisplayObject
flash.text.TextField.getCharBoundaries()
flash.geom.Transform.pixelBounds
flash.display.Sprite.startDrag()
flash.printing.PrintJob.addPage()
Rectangle オブジェクトの使用
サイズ、拡大率、用紙の向きの設定


パブリックプロパティ
 プロパティ定義
  bottom : Number
y プロパティと height プロパティの合計です。
Rectangle
  bottomRight : Point
Rectangle オブジェクトの右下隅の位置で、そのポイントの right プロパティと bottom プロパティの値で決まります。
Rectangle
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  height : Number
矩形の高さ (ピクセル単位) です。
Rectangle
  left : Number
矩形の左上隅の x 座標です。
Rectangle
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  right : Number
x プロパティと width プロパティの合計です。
Rectangle
  size : Point
Rectangle オブジェクトのサイズで、width プロパティと height プロパティの値を持つ Point オブジェクトとして表現されます。
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 パラメータで指定され、width パラメータと height パラメータが指定された新しい Rectangle オブジェクトを作成します。
Rectangle
  clone():Rectangle
元の Rectangle オブジェクトと xywidth、および height の各プロパティの値が同じである、新しい Rectangle オブジェクトを返します。
Rectangle
  contains(x:Number, y:Number):Boolean
指定されたポイントがこの Rectangle オブジェクトで定義される矩形領域内にあるかどうかを判別します。
Rectangle
  containsPoint(point:Point):Boolean
指定されたポイントがこの Rectangle オブジェクトで定義される矩形領域内にあるかどうかを判別します。
Rectangle
  containsRect(rect:Rectangle):Boolean
rect パラメータで指定された Rectangle オブジェクトがこの Rectangle オブジェクト内にあるかどうかを判別します。
Rectangle
  equals(toCompare:Rectangle):Boolean
toCompare パラメータで指定されたオブジェクトがこの Rectangle オブジェクトと等しいかどうかを判別します。
Rectangle
 InheritedhasOwnProperty(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
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  offset(dx:Number, dy:Number):void
左上隅で決まる Rectangle オブジェクトの位置を、指定された量だけ調整します。
Rectangle
  offsetPoint(point:Point):void
Point オブジェクトをパラメータとして使用して、Rectangle オブジェクトの位置を調整します。
Rectangle
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
  setEmpty():void
Rectangle オブジェクトのすべてのプロパティを 0 に設定します。
Rectangle
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  toString():String
Rectangle オブジェクトの水平位置と垂直位置、および幅と高さをリストするストリングを作成して返します。
Rectangle
  union(toUnion:Rectangle):Rectangle
2 つの矩形間の水平と垂直の空間を塗りつぶすことにより、2 つの矩形を加算して新しい Rectangle オブジェクトを作成します。
Rectangle
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
プロパティの詳細
bottomプロパティ
bottom:Number  [read-write]

y プロパティと height プロパティの合計です。

実装
    public function get bottom():Number
    public function set bottom(value:Number):void

関連項目

bottomRightプロパティ 
bottomRight:Point  [read-write]

Rectangle オブジェクトの右下隅の位置で、そのポイントの right プロパティと bottom プロパティの値で決まります。

実装
    public function get bottomRight():Point
    public function set bottomRight(value:Point):void

関連項目

heightプロパティ 
public var height:Number

矩形の高さ (ピクセル単位) です。Rectangle オブジェクトの height の値を変更しても、xy、および width の各プロパティに影響はありません。

関連項目

leftプロパティ 
left:Number  [read-write]

矩形の左上隅の x 座標です。Rectangle オブジェクトの left プロパティを変更しても、y および height の各プロパティに影響はありません。ただし、これは width プロパティに影響しますが、x 値の変更は width プロパティに影響しません

left プロパティの値は、x プロパティの値と等価です。

実装
    public function get left():Number
    public function set left(value:Number):void

関連項目

rightプロパティ 
right:Number  [read-write]

x プロパティと width プロパティの合計です。

実装
    public function get right():Number
    public function set right(value:Number):void

関連項目

sizeプロパティ 
size:Point  [read-write]

Rectangle オブジェクトのサイズで、width プロパティと height プロパティの値を持つ Point オブジェクトとして表現されます。

実装
    public function get size():Point
    public function set size(value:Point):void

関連項目

topプロパティ 
top:Number  [read-write]

矩形の左上隅の y 座標です。Rectangle オブジェクトの top プロパティ値を変更しても、x および width の各プロパティに影響はありません。ただし、これは height プロパティに影響しますが、y 値の変更は height プロパティに影響しません

top プロパティの値は、y プロパティの値と等価です。

実装
    public function get top():Number
    public function set top(value:Number):void

関連項目

topLeftプロパティ 
topLeft:Point  [read-write]

Rectangle オブジェクトの左上隅の位置で、そのポイントの x 座標と y 座標で決まります。

実装
    public function get topLeft():Point
    public function set topLeft(value:Point):void

関連項目

widthプロパティ 
public var width:Number

矩形の幅 (ピクセル単位) です。Rectangle オブジェクトの width の値を変更しても、xy、および height の各プロパティに影響はありません。

関連項目

xプロパティ 
public var x:Number

矩形の左上隅の x 座標です。Rectangle オブジェクトの x プロパティ値を変更しても、ywidth、および height の各プロパティに影響はありません。

x プロパティの値は、left プロパティの値と等価です。

関連項目

yプロパティ 
public var y:Number

矩形の左上隅の y 座標です。Rectangle オブジェクトの y プロパティ値を変更しても、xwidth、および height の各プロパティに影響はありません。

y プロパティの値は、top プロパティの値と等価です。

関連項目

コンストラクタの詳細
Rectangle()コンストラクタ
public 関数 Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)

左上隅が x パラメータと y パラメータで指定され、width パラメータと height パラメータが指定された新しい Rectangle オブジェクトを作成します。パラメータなしでこの関数を呼び出すと、xywidth、および height の各プロパティが 0 に設定された矩形が作成されます。

パラメータ
x:Number (default = 0) — 矩形の左上隅の x 座標です。
 
y:Number (default = 0) — 矩形の左上隅の y 座標です。
 
width:Number (default = 0) — 矩形の幅 (ピクセル単位) です。
 
height:Number (default = 0) — 矩形の高さ (ピクセル単位) です。

関連項目

メソッドの詳細
clone()メソッド
public function clone():Rectangle

元の Rectangle オブジェクトと xywidth、および height の各プロパティの値が同じである、新しい Rectangle オブジェクトを返します。

戻り値
Rectangle — 元の Rectangle オブジェクトと xywidth、および height の各プロパティの値が同じである、新しい Rectangle オブジェクトです。

関連項目

contains()メソッド 
public function contains(x:Number, y:Number):Boolean

指定されたポイントがこの Rectangle オブジェクトで定義される矩形領域内にあるかどうかを判別します。

パラメータ
x:Number — ポイントの x 座標 (水平位置) です。
 
y:Number — ポイントの y 座標 (垂直位置) です。

戻り値
Boolean — Rectangle オブジェクトに指定されたオブジェクトが含まれる場合は true を返します。含まれない場合は false を返します。

関連項目

containsPoint()メソッド 
public function containsPoint(point:Point):Boolean

指定されたポイントがこの Rectangle オブジェクトで定義される矩形領域内にあるかどうかを判別します。このメソッドは、Point オブジェクトをパラメータとして使用することを除けば、Rectangle.contains() メソッドと似ています。

パラメータ
point:Pointx および y の値で表されるポイントです。

戻り値
Boolean — Rectangle オブジェクトに指定されたオブジェクトが含まれる場合は true を返します。含まれない場合は false を返します。

関連項目

containsRect()メソッド 
public function containsRect(rect:Rectangle):Boolean

rect パラメータで指定された Rectangle オブジェクトがこの Rectangle オブジェクト内にあるかどうかを判別します。2 番目の Rectangle オブジェクトが最初の Rectangle オブジェクトの境界内に完全に収まる場合、最初の Rectangle オブジェクトは 2 番目の Rectangle オブジェクトを包含していると言います。

パラメータ
rect:Rectangle — チェック対象の Rectangle オブジェクトです。

戻り値
Boolean — 指定した Rectangle オブジェクトがこの Rectangle オブジェクトに含まれる場合は true を返します。含まれない場合は false を返します。
equals()メソッド 
public function equals(toCompare:Rectangle):Boolean

toCompare パラメータで指定されたオブジェクトがこの Rectangle オブジェクトと等しいかどうかを判別します。このメソッドは、オブジェクトの xywidth、および height の各プロパティを、この Rectangle オブジェクトの同じプロパティと比較します。

パラメータ
toCompare:Rectangle — この Rectangle オブジェクトと比較する矩形です。

戻り値
Boolean — オブジェクトの xywidth、および height の各プロパティの値がこの Rectangle オブジェクトと等しい場合は true を返します。等しくない場合は false を返します。

関連項目

inflate()メソッド 
public function inflate(dx:Number, dy:Number):void

Rectangle オブジェクトのサイズを、指定された量 (ピクセル単位) だけ大きくします。Rectangle オブジェクトの中心点は変わりませんが、サイズは dx 値に応じて左右に大きくなり、dy 値に応じて上下に大きくなります。

パラメータ
dx:Number — Rectangle オブジェクトの左右に加わる値です。次の等式を使用して、矩形の新しい幅と位置が計算されます。
 x -= dx;
 width += 2 * dx;
 
 
dy:Number — Rectangle オブジェクトの上下に加わる値です。次の等式を使用して、矩形の新しい高さと位置が計算されます。
 y -= dy;
 height += 2 * dy;
 

関連項目

inflatePoint()メソッド 
public function inflatePoint(point:Point):void

Rectangle オブジェクトのサイズを大きくします。このメソッドは、Point オブジェクトをパラメータとして使用することを除けば、Rectangle.inflate() メソッドと似ています。

次の 2 つのコード例の結果は同じになります。

  rect1=new flash.geom.Rectangle(0,0,2,5);
  rect1.inflate(2,2)
  
  rect1=new flash.geom.Rectangle(0,0,2,5);
  pt1=new flash.geom.Point(2,2);
  rect1.inflatePoint(pt1)
  
パラメータ
point:Point — この Point オブジェクトの x プロパティは、Rectangle オブジェクトの水平方向のサイズを大きくするために使用します。y プロパティは、Rectangle オブジェクトの垂直方向のサイズを大きくするために使用します。

関連項目

intersection()メソッド 
public function intersection(toIntersect:Rectangle):Rectangle

toIntersect パラメータで指定された Rectangle オブジェクトがこの Rectangle オブジェクトと交差する場合に、交差領域を Rectangle オブジェクトとして返します。矩形が交差しない場合、このメソッドは、プロパティが 0 に設定された空の Rectangle オブジェクトを返します。

パラメータ
toIntersect:Rectangle — この Rectangle オブジェクトと交差するかどうかを調べる対象の Rectangle オブジェクトです。

戻り値
Rectangle — 交差領域と等しい Rectangle オブジェクトです。矩形が交差しない場合、このメソッドは xywidth、および height の各プロパティが 0 に設定された空の Rectangle オブジェクトを返します。

関連項目

intersects()メソッド 
public function intersects(toIntersect:Rectangle):Boolean

toIntersect パラメータで指定されたオブジェクトがこの Rectangle オブジェクトと交差するかどうかを判別します。このメソッドは、指定された Rectangle オブジェクトの xywidth、および height の各プロパティをチェックして、この Rectangle オブジェクトと交差するかどうかを調べます。

パラメータ
toIntersect:Rectangle — この Rectangle オブジェクトと比較する Rectangle オブジェクトです。

戻り値
Boolean — 指定されたオブジェクトがこの Rectangle オブジェクトと交差する場合は true を返します。交差しない場合は false を返します。

関連項目

isEmpty()メソッド 
public function isEmpty():Boolean

この Rectangle オブジェクトが空かどうかを判別します。

戻り値
Boolean — Rectangle オブジェクトの幅と高さが 0 以下の場合は true を返します。それ以外の場合は false を返します。
offset()メソッド 
public function offset(dx:Number, dy:Number):void

左上隅で決まる Rectangle オブジェクトの位置を、指定された量だけ調整します。

パラメータ
dx:Number — Rectangle オブジェクトの x 値をこの量だけ移動します。
 
dy:Number — Rectangle オブジェクトの y 値をこの量だけ移動します。

関連項目

offsetPoint()メソッド 
public function offsetPoint(point:Point):void

Point オブジェクトをパラメータとして使用して、Rectangle オブジェクトの位置を調整します。このメソッドは、Point オブジェクトをパラメータとして使用することを除けば、Rectangle.offset() メソッドと似ています。

パラメータ
point:Point — この Rectangle オブジェクトをオフセットするための Point オブジェクトです。

関連項目

setEmpty()メソッド 
public function setEmpty():void

Rectangle オブジェクトのすべてのプロパティを 0 に設定します。その幅または高さが 0 以下の場合、Rectangle オブジェクトは空です。

このメソッドは、xywidth、および height の各プロパティの値を 0 に設定します。

関連項目

toString()メソッド 
public function toString():String

Rectangle オブジェクトの水平位置と垂直位置、および幅と高さをリストするストリングを作成して返します。

戻り値
String — Rectangle オブジェクトの次の各プロパティの値を列挙するストリングです。xywidth、および height です。

関連項目

union()メソッド 
public function union(toUnion:Rectangle):Rectangle

2 つの矩形間の水平と垂直の空間を塗りつぶすことにより、2 つの矩形を加算して新しい Rectangle オブジェクトを作成します。

パラメータ
toUnion:Rectangle — この Rectangle オブジェクトに追加する Rectangle オブジェクトです。

戻り値
Rectangle — 2 つの矩形の和集合である新しい Rectangle オブジェクトです。

関連項目


次の例では、RectangleExample クラスを使用して新しい 3 つの Rectangle オブジェクトを さまざまな x 座標、y 座標、高さ、幅で作成します。 また trace() メソッドを使用して、Rectangle インスタンスが正常に作成されたことを確認します。次に、ブール型 変数 isContained が、 containsRect() メソッドの呼び出し結果に割り当てられます。 このメソッドは、2 番目の矩形が 3 番目の矩形を完全には囲んでいないことを判別します。
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
        }
    }
}