DisplacementMapFilter

パッケージ	spark.filters
クラス	public class DisplacementMapFilter
継承	DisplacementMapFilter BaseFilter EventDispatcher Object
実装	IBitmapFilter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

DisplacementMapFilter クラスは、指定された BitmapData オブジェクト（置き換えマップイメージと言います）のピクセル値を使用して、オブジェクトの置き換え（変位）を実行します。このフィルターを使用して、MovieClip、SimpleButton、TextField、Video オブジェクトなどの DisplayObject クラスから継承したオブジェクト、および BitmapData オブジェクトにワープ効果や斑点効果を適用できます。

フィルターの使用方法は、フィルターの適用先オブジェクトによって異なります。

表示オブジェクトにフィルターを適用する場合は、表示オブジェクトの filters プロパティを使用します。オブジェクトの filters プロパティを設定しても、オブジェクトは変更されません。filters プロパティをクリアすることにより、フィルターを取り消すことができます。
BitmapData オブジェクトにフィルターを適用するには、BitmapData.applyFilter() メソッドを使用します。BitmapData オブジェクトで applyFilter() を呼び出すことによって、ソース BitmapData オブジェクトとフィルターオブジェクトが取得され、フィルターを適用したイメージが生成されます。

表示オブジェクトにフィルターを適用すると、表示オブジェクトの cacheAsBitmap プロパティの値が true に設定されます。すべてのフィルターをクリアすると、cacheAsBitmap の元の値が復元されます。

このフィルターでは次の式を使用します。

dstPixel[x, y] = srcPixel[x + ((componentX(x, y) - 128) * scaleX) / 256, y + ((componentY(x, y) - 128) *scaleY) / 256)

componentX(x, y) は、componentX プロパティのカラー値を mapBitmap プロパティ（(x - mapPoint.x ,y - mapPoint.y)）から取得します。

フィルターで使用するマップイメージは、ステージの拡大 / 縮小率に一致するように拡大 / 縮小されます。オブジェクト自体を拡大 / 縮小する場合には拡大 / 縮小されません。

このフィルターはステージの拡大 / 縮小に対応していますが、通常の拡大 / 縮小、回転、傾斜には対応していません。オブジェクト自体を拡大 / 縮小する場合（scaleX と scaleY プロパティが 1.0 以外に設定されている場合）、フィルター効果は拡大 / 縮小されません。フィルターが拡大 / 縮小されるのは、ユーザーがステージをズームインする場合のみです。

MXML シンタックス expanded

MXML シンタックスを隠す

The <s:DisplacementMapFilter> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

 <s:DisplacementMapFilter 
   Properties
   alpha="0"
   color="0x000000"
   componentX="0"
   componentY="0"
   mapBitmap="null"
   mapPoint="null"
   mode="wrap"
   scaleX="0"
   scaleY="0"
 />

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		alpha : Number 範囲外置き換えの場合に使用するアルファ透明度値を指定します。	DisplacementMapFilter
		color : uint 範囲外置き換えの場合に使用する色を指定します。	DisplacementMapFilter
		componentX : uint x の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。	DisplacementMapFilter
		componentY : uint y の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。	DisplacementMapFilter
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		mapBitmap : BitmapData 置き換えマップデータが含まれる BitmapData オブジェクトです。	DisplacementMapFilter
		mapPoint : Point マップイメージの左上隅を基準としたターゲット表示オブジェクトの左上隅のオフセットが含まれる値です。	DisplacementMapFilter
		mode : String フィルターのモードです。	DisplacementMapFilter
		scaleX : Number マップ計算の x 置き換え結果を拡大 / 縮小する場合に使用する乗数です。	DisplacementMapFilter
		scaleY : Number マップ計算の y 置き換え結果を拡大 / 縮小する場合に使用する乗数です。	DisplacementMapFilter

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		DisplacementMapFilter(mapBitmap:BitmapData = null, mapPoint:Point = null, componentX:uint = 0, componentY:uint = 0, scaleX:Number = 0.0, scaleY:Number = 0.0, mode:String = "wrap", color:uint = 0, alpha:Number = 0.0) コンストラクターです。	DisplacementMapFilter
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		clone():BitmapFilter このフィルターオブジェクトのコピーを返します。	DisplacementMapFilter
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		notifyFilterChanged():void フィルターの変更時に変更イベントを伝播します。	BaseFilter
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	イベント		概要	定義元
		activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
		deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher

パブリック定数

継承されるパブリック定数を隠す

継承されるパブリック定数を表示

	定数		定義元

プロパティの詳細

alpha

プロパティ

alpha:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

範囲外置き換えの場合に使用するアルファ透明度値を指定します。0.0 ～ 1.0 に正規化した値を指定します。例えば、.25 を指定すると、透明度の値として 25% が設定されます。デフォルト値は 0 です。mode プロパティが DisplacementMapFilterMode.COLOR に設定されている場合は、このプロパティを使用します。

デフォルト値： 0。

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

color

プロパティ

color:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

範囲外置き換えの場合に使用する色を指定します。置き換えの有効範囲は 0.0 ～ 1.0 です。この値は、16 進数形式です。color のデフォルト値は 0 です。mode プロパティが DisplacementMapFilterMode.COLOR に設定されている場合は、このプロパティを使用します。

デフォルト値： 0x000000。

実装
public function get color():uint
public function set color(value:uint):void

componentX

プロパティ

componentX:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

x の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。指定できる値は、BitmapDataChannel 定数です。

BitmapDataChannel.ALPHA
BitmapDataChannel.BLUE
BitmapDataChannel.GREEN
BitmapDataChannel.RED

デフォルト値： 0, meaning no channel.。

実装
public function get componentX():uint
public function set componentX(value:uint):void

componentY

プロパティ

componentY:uint

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

y の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。指定できる値は、BitmapDataChannel 定数です。

BitmapDataChannel.ALPHA
BitmapDataChannel.BLUE
BitmapDataChannel.GREEN
BitmapDataChannel.RED

デフォルト値： 0, meaning no channel.。

実装
public function get componentY():uint
public function set componentY(value:uint):void

mapBitmap

プロパティ

mapBitmap:BitmapData

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

置き換えマップデータが含まれる BitmapData オブジェクトです。

デフォルト値： null。

実装
public function get mapBitmap():BitmapData
public function set mapBitmap(value:BitmapData):void

mapPoint

プロパティ

mapPoint:Point

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

マップイメージの左上隅を基準としたターゲット表示オブジェクトの左上隅のオフセットが含まれる値です。

デフォルト値： null。

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

mode

プロパティ

mode:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

フィルターのモードです。指定できる値は、DisplacementMapFilterMode 定数です。

DisplacementMapFilterMode.WRAP - 置き換え値をソースイメージの反対側で折り返します。
DisplacementMapFilterMode.CLAMP - 置き換え値をソースイメージのエッジに固定します。
DisplacementMapFilterMode.IGNORE - 置き換え値が範囲外である場合、その置き換えを無視して、ソースピクセルを使用します。
DisplacementMapFilterMode.COLOR - 置き換え値がイメージの外にある場合、color プロパティと alpha プロパティの値を置き換えます。

デフォルト値： DisplacementMapFilterMode.WRAP。

実装
public function get mode():String
public function set mode(value:String):void

scaleX

プロパティ

scaleX:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

マップ計算の x 置き換え結果を拡大 / 縮小する場合に使用する乗数です。

デフォルト値： 0。

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

scaleY

プロパティ

scaleY:Number

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

マップ計算の y 置き換え結果を拡大 / 縮小する場合に使用する乗数です。

デフォルト値： 0。

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

コンストラクターの詳細

()

コンストラクター

public function DisplacementMapFilter(mapBitmap:BitmapData = null, mapPoint:Point = null, componentX:uint = 0, componentY:uint = 0, scaleX:Number = 0.0, scaleY:Number = 0.0, mode:String = "wrap", color:uint = 0, alpha:Number = 0.0)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクターです。

パラメーター

	`mapBitmap:BitmapData` (default = `null`) — 置き換えマップデータが含まれる BitmapData オブジェクトです。

	`mapPoint:Point` (default = `null`) — マップイメージの左上隅を基準としたターゲット表示オブジェクトの左上隅のオフセットが含まれる値です。

	`componentX:uint` (default = `0`) — x の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。指定できる値は、BitmapDataChannel 定数です。

	`componentY:uint` (default = `0`) — y の結果を変位させる場合にどのカラーチャンネルをマップイメージで使用するかを指定します。指定できる値は、BitmapDataChannel 定数です。

	`scaleX:Number` (default = `0.0`) — マップ計算の x 置き換え結果を拡大 / 縮小する場合に使用する乗数です。

	`scaleY:Number` (default = `0.0`) — マップ計算の y 置き換え結果を拡大 / 縮小する場合に使用する乗数です。

	`mode:String` (default = "`wrap`") — フィルターのモードです。指定できる値は、DisplacementMapFilterMode 定数です。

	`color:uint` (default = `0`) — 範囲外置き換えの場合に使用する色を指定します。置き換えの有効範囲は 0.0 ～ 1.0 です。このパラメーターは、`mode` を `DisplacementMapFilterMode.COLOR` に設定する場合に使用します。

	`alpha:Number` (default = `0.0`) — 範囲外置き換えの場合に使用するアルファ値を指定します。0.0 ～ 1.0 に正規化した値を指定します。例えば、.25 を指定すると、透明度の値として 25% が設定されます。このパラメーターは、`mode` を `DisplacementMapFilterMode.COLOR` に設定する場合に使用します。

clone

()

メソッド

public function clone():BitmapFilter

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

このフィルターオブジェクトのコピーを返します。

戻り値

BitmapFilter — 元のインスタンスと同じプロパティをすべて備えた新しい DisplacementMapFilter インスタンスです。

法律上の注意 | プライバシーポリシー

DisplacementMapFilter - AS3 Flex

クラス x

alpha

color

componentX

componentY

mapBitmap

mapPoint

mode

scaleX

scaleY

DisplacementMapFilter

clone