Rect¶
Rect クラスは、矩形情報を保持するクラスです。
メンバー一覧¶
コンストラクタ¶
プロパティ¶
メソッド¶
Rect¶
コンストラクタ
解説
Rect オブジェクトの構築
Rect クラスのオブジェクトを構築します。
Rect¶
コンストラクタ
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
left |
|
左端を指定します。 |
top |
|
上端を指定します。 |
right |
|
右端を指定します。 |
bottom |
|
下端を指定します。 |
解説
Rect オブジェクトの構築
Rect クラスのオブジェクトを指定の大きさで構築します。
Rect¶
コンストラクタ
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
src |
|
Rect オブジェトを指定します。 |
解説
Rect オブジェクトの構築
Rect クラスのオブジェクトを Rect オブジェクトから構築します。
width¶
プロパティ \ アクセス: r/w
解説
矩形横幅
矩形の横幅を指定します。
値を設定することもできます。
関連: Rect.setSize
height¶
プロパティ \ アクセス: r/w
解説
矩形縦幅
矩形の縦幅を指定します。
値を設定することもできます。
関連: Rect.setSize
left¶
プロパティ \ アクセス: r/w
解説
矩形左端
矩形の左端を指定します。
値を設定することもできます。
関連: Rect.setOffset
top¶
プロパティ \ アクセス: r/w
解説
矩形上端
矩形の上端を指定します。
値を設定することもできます。
関連: Rect.setOffset
right¶
プロパティ \ アクセス: r/w
解説
矩形右端
矩形の右端を指定します。
値を設定することもできます。
bottom¶
プロパティ \ アクセス: r/w
解説
矩形下端
矩形の下端を指定します。
値を設定することもできます。
nativeArray¶
プロパティ \ アクセス: r
解説
矩形バッファポインタ
矩形の座標配列へのポインタを表します。
このプロパティは、プラグインなどのために座標配列バッファへの直接のアクセスの手段を提供する ためにあります。
整数型で返されますが、プラグインなどでは適切な型 ( int[4] 等 ) にキャストして使って ください。
setSize¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
width |
|
矩形の横幅を指定します。 この値は Rect.width プロパティでも取得や設定ができます。 |
height |
|
矩形の縦幅を指定します。 この値は Rect.height プロパティでも取得や設定ができます。 |
解説
矩形サイズの設定
矩形サイズを指定します。
setOffset¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
x |
|
矩形の X 座標値を指定します。 この値は Rect.left プロパティでも取得や設定ができます。 |
y |
|
矩形の Y 座標値を指定します。 この値は Rect.top プロパティでも取得や設定ができます。 |
解説
矩形位置の設定
矩形位置の設定を行います。
addOffset¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
x |
|
矩形の横移動量を指定します。 |
y |
|
矩形の縦移動量を指定します。 |
解説
矩形位置の設定
矩形位置を移動します。
指定された x, y 値分矩形が移動します。
clear¶
メソッド
解説
矩形情報をクリアします
矩形の各位置情報をゼロクリアします。
set¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
left |
|
左端を指定します。 |
top |
|
上端を指定します。 |
right |
|
右端を指定します。 |
bottom |
|
下端を指定します。 |
解説
矩形座標の設定
指定の大きさに矩形を設定します。
isEmpty¶
メソッド
戻り値
領域の有無
解説
矩形内部があるかどうか
矩形が幅と高さを持っているかどうか確認します。
どちらか一方でも0以下の場合 true が返ります。
clip¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
r |
|
クリッピングする矩形オブジェクトを指定します。 |
戻り値
クリッピング実施有無
解説
矩形のクリッピング
矩形のクリッピングを指定の矩形で行います。
矩形が空にならない場合のみクリッピングは行われます。
空になってしまう場合は false が返り、クリッピングは行われません。
関連: Rect.isEmpty
union¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
r |
|
合成する矩形オブジェクトを指定します。 |
戻り値
合成実施有無
解説
矩形の合成
指定の矩形オブジェクトで矩形を拡張します。
指定の矩形オブジェクトの 4辺値で矩形サイズが広がる方向で大きい値が対象矩形の値となります。
対象矩形が空でない場合のみ実行され、空の場合は行われず、false を返します。
関連: Rect.isEmpty
intersects¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
r |
|
交差判定する矩形オブジェクトを指定します。 |
戻り値
交差有無
解説
矩形の交差判定
指定の矩形オブジェクトと交差するか判定します。
交差する場合 true が返ります。
included¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
r |
|
内包判定する矩形オブジェクトを指定します。 |
戻り値
内包有無
解説
矩形内包判定
指定の矩形オブジェクトを内包するか判定します。
内包する場合 true が返ります。
1辺でも外に出ていると内包していないと判定されます。
includedPos¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
x |
|
判定するX軸座標値を指定します。 |
y |
|
判定するY軸座標値を指定します。 |
戻り値
内包有無
解説
矩形内包判定
指定の位置を内包するか判定します。
内包する場合 true が返ります。
right, bottom は含まない範囲で判定されます。
equal¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
r |
|
判定する矩形オブジェクトを指定します。 |
戻り値
同じかどうか
解説
同一判定
矩形が同じかどうか判定します。
同じ場合 true が返ります。
比較は4辺の値で行われます。