Packagejp.naggg.effects
Classpublic class StageCapture
InheritanceStageCapture Inheritance flash.display.Sprite

再生中のステージのキャプチャ、Bitmap、BitmapData を所有する表示オブジェクトです. Sprite を継承しているのは、マウス判定を有効としているためで、 たとえば、ステージをキャプチャした一時停止状態を作る際に、 root の最上部に addChild することで画面全体のマウスを殺すことができます.

View the examples



Public Properties
 PropertyDefined By
  bitmapData : BitmapData
[read-only] 現在キャプチャされている BitmapData です.キャプチャされていなければ null を返します. 事前に clone() により複製されているので、この BitmapData に変更を加えても本体には影響はありません.
StageCapture
  captureOnResize : Boolean = true
ステージリサイズ時にキャプチャを行うか
StageCapture
Public Methods
 MethodDefined By
  
StageCapture(autoCapture:Boolean = false, autoCaptureRoot:Sprite = null)
コンストラクタ.
StageCapture
  
capture(rootObject:DisplayObject = null):void
現在表示されているステージのキャプチャを取ります. 生成された StageCapture インスタンスが表示リストに入っているか分からないのでらないので、 root 及び stage を識別するために root を引数で渡してやる必要があります. 指定しない場合は、自身の root プロパティからになりますが、その場合、エラーが発生することもあります. また、この動作により、直前のキャプチャ画像は破棄されます.
StageCapture
  
dispose():void
ビットマップデータを破棄してメモリを軽くします.
StageCapture
  
toString():String
[override]
StageCapture
Property Detail
bitmapDataproperty
bitmapData:BitmapData  [read-only]

現在キャプチャされている BitmapData です.キャプチャされていなければ null を返します. 事前に clone() により複製されているので、この BitmapData に変更を加えても本体には影響はありません.


Implementation
    public function get bitmapData():BitmapData
captureOnResizeproperty 
public var captureOnResize:Boolean = true

ステージリサイズ時にキャプチャを行うか

Constructor Detail
StageCapture()Constructor
public function StageCapture(autoCapture:Boolean = false, autoCaptureRoot:Sprite = null)

コンストラクタ.

Parameters
autoCapture:Boolean (default = false) — インスタンス生成時に自動でステージキャプチャを行うかのフラグです. その場合、第2引数で root を指定する必要があります.
 
autoCaptureRoot:Sprite (default = null) — autoCapture で true が指定された場合、 ここで設定された root と stage からキャプチャを行います. これは、インスタンス生成時に表示リストに加わっていない場合があるからです.
Method Detail
capture()method
public function capture(rootObject:DisplayObject = null):void

現在表示されているステージのキャプチャを取ります. 生成された StageCapture インスタンスが表示リストに入っているか分からないのでらないので、 root 及び stage を識別するために root を引数で渡してやる必要があります. 指定しない場合は、自身の root プロパティからになりますが、その場合、エラーが発生することもあります. また、この動作により、直前のキャプチャ画像は破棄されます.

Parameters

rootObject:DisplayObject (default = null) — そのドキュメントの root にあたる Sprite または MovieClip です. 何も指定がない場合、自身の配置されている root になります.

dispose()method 
public function dispose():void

ビットマップデータを破棄してメモリを軽くします.

toString()method 
override public function toString():String

Returns
String
Examples