Layer.setClip

機能/意味

描画クリップ矩形の設定

タイプ

Layerクラスのメソッド

構文

setClip(left, top, width=void, height=void)

引数

left	描画クリップ矩形の ( レイヤの画像座標での ) 左端位置をピクセル単位で指定します。 　この値は Layer.clipLeft プロパティでも取得や設定ができます。
top	描画クリップ矩形の ( レイヤの画像座標での ) 上端位置をピクセル単位で指定します。 　この値は Layer.clipTop プロパティでも取得や設定ができます。
width	描画クリップ矩形の横幅をピクセル単位で指定します。 　この値は Layer.clipWidth プロパティでも取得や設定ができます。
height	描画クリップ矩形の縦幅をピクセル単位で指定します。 　この値は Layer.clipHeight プロパティでも取得や設定ができます。

戻り値

なし (void)

説明

　レイヤの描画クリップ矩形を設定します。
　レイヤに対する描画は、この描画クリップ矩形内に制限されます ( 矩形外にはみ出た部分は 描画されません )。ただし、Layer.flipLR や Layer.flipUD のように 描画クリップ矩形の影響を受けないメソッドもあります。
　初期値は、クリップ矩形はレイヤ画像領域全体に設定されています ( レイヤ全面 に描画する事ができます )。
　描画クリップ矩形は、画像読み込みや画像サイズが変更されたり、レイヤの表示タイプが 変更されると初期値に戻ります。
　また、このメソッドを引数なしで呼び出すと、描画クリップ矩形を初期値に戻すことができます。