套件 | spark.filters |
類別 | public class DisplacementMapFilter |
繼承 | DisplacementMapFilter BaseFilter EventDispatcher Object |
實作 | IBitmapFilter |
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4 |
執行階段版本: | Flash Player 10, AIR 1.5 |
The use of filters depends on the object to which you apply the filter:
- To apply filters to a display object, use the
filters
property of the display object. Setting thefilters
property of an object does not modify the object, and you can remove the filter by clearing thefilters
property. - To apply filters to BitmapData objects, use the
BitmapData.applyFilter()
method. CallingapplyFilter()
on a BitmapData object takes the source BitmapData object and the filter object and generates a filtered image.
If you apply a filter to a display object, the value of the cacheAsBitmap
property of the
display object is set to true
. If you clear all filters, the original value of
cacheAsBitmap
is restored.
The filter uses the following formula:
dstPixel[x, y] = srcPixel[x + ((componentX(x, y) - 128) * scaleX) / 256, y + ((componentY(x, y) - 128) *scaleY) / 256)
where componentX(x, y)
gets the componentX
property color value
from the mapBitmap
property at (x - mapPoint.x ,y - mapPoint.y)
.
The map image used by the filter is scaled to match the Stage scaling. It is not scaled when the object itself is scaled.
This filter supports Stage scaling. However, general scaling, rotation, and
skewing are not supported. If the object itself is scaled (if the scaleX
and scaleY
properties are set to a value other than 1.0),
the filter effect is not scaled. It is scaled only when the user zooms in on the Stage.
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" />
相關 API 元素
flash.display.DisplayObject.filters
flash.display.DisplayObject.cacheAsBitmap
屬性 | 定義自 | ||
---|---|---|---|
alpha : Number
Specifies the alpha transparency value to use for out-of-bounds
displacements. | DisplacementMapFilter | ||
color : uint
Specifies what color to use for out-of-bounds displacements. | DisplacementMapFilter | ||
componentX : uint
Describes which color channel to use in the map image to displace the x result. | DisplacementMapFilter | ||
componentY : uint
Describes which color channel to use in the map image to displace the y result. | DisplacementMapFilter | ||
constructor : Object
類別物件的參照或是特定物件實體的建構函數。 | Object | ||
mapBitmap : BitmapData
A BitmapData object containing the displacement map data. | DisplacementMapFilter | ||
mapPoint : Point
A value that contains the offset of the upper-left corner of the target display
object from the upper-left corner of the map image. | DisplacementMapFilter | ||
mode : String
The mode for the filter. | DisplacementMapFilter | ||
scaleX : Number
The multiplier to use to scale the x displacement result from the map calculation. | DisplacementMapFilter | ||
scaleY : Number
The multiplier to use to scale the y displacement result from the map calculation. | 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)
Constructor. | DisplacementMapFilter | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式,以便讓偵聽程式收到事件的通知。 | EventDispatcher | ||
Returns a copy of this filter object. | DisplacementMapFilter | ||
會將事件傳送到事件流程。 | EventDispatcher | ||
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | EventDispatcher | ||
指出物件是否有已定義的指定屬性。 | Object | ||
指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。 | Object | ||
Propagates a change event when the filter has changed. | BaseFilter | ||
指出指定的屬性是否存在,以及是否可列舉。 | Object | ||
會從 EventDispatcher 物件移除偵聽程式。 | EventDispatcher | ||
為迴圈作業設定動態屬性的可用性。 | Object | ||
傳回代表此物件的字串,根據地區特定慣例進行格式化。 | Object | ||
會傳回指定之物件的字串形式。 | Object | ||
會傳回指定之物件的基本值。 | Object | ||
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式,或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | EventDispatcher |
alpha | 屬性 |
alpha:Number
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4 |
執行階段版本: | Flash Player 10, AIR 1.5 |
Specifies the alpha transparency value to use for out-of-bounds displacements. It is specified as a normalized value from 0.0 to 1.0. For example, .25 sets a transparency value of 25%. The default value is 0. Use this property if the mode property is set to 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 |
Specifies what color to use for out-of-bounds displacements. The valid range of displacements is 0.0 to 1.0. Values are in hexadecimal format. The default value for color is 0. Use this property if the mode property is set to 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 |
Describes which color channel to use in the map image to displace the x result. Possible values are BitmapDataChannel constants:
BitmapDataChannel.ALPHA
BitmapDataChannel.BLUE
BitmapDataChannel.GREEN
BitmapDataChannel.RED
預設值為 0, meaning no channel.。
實作
public function get componentX():uint
public function set componentX(value:uint):void
相關 API 元素
componentY | 屬性 |
componentY:uint
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4 |
執行階段版本: | Flash Player 10, AIR 1.5 |
Describes which color channel to use in the map image to displace the y result. Possible values are BitmapDataChannel constants:
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 |
A BitmapData object containing the displacement map data.
預設值為 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 |
A value that contains the offset of the upper-left corner of the target display object from the upper-left corner of the map image.
預設值為 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 |
The mode for the filter. Possible values are DisplacementMapFilterMode constants:
DisplacementMapFilterMode.WRAP
- Wraps the displacement value to the other side of the source image.DisplacementMapFilterMode.CLAMP
- Clamps the displacement value to the edge of the source image.DisplacementMapFilterMode.IGNORE
- If the displacement value is out of range, ignores the displacement and uses the source pixel.DisplacementMapFilterMode.COLOR
- If the displacement value is outside the image, substitutes the values in the color and alpha properties.
預設值為 DisplacementMapFilterMode.WRAP。
實作
public function get mode():String
public function set mode(value:String):void
scaleX | 屬性 |
scaleY | 屬性 |
DisplacementMapFilter | () | 建構函式 |
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 |
Constructor.
參數mapBitmap:BitmapData (default = null ) — A BitmapData object containing the displacement map data.
| |
mapPoint:Point (default = null ) — A value that contains the offset of the upper-left corner of the
target display object from the upper-left corner of the map image.
| |
componentX:uint (default = 0 ) — Describes which color channel to use in the map image to displace the x result.
Possible values are the BitmapDataChannel constants.
| |
componentY:uint (default = 0 ) — Describes which color channel to use in the map image to displace the y result.
Possible values are the BitmapDataChannel constants.
| |
scaleX:Number (default = 0.0 ) — The multiplier to use to scale the x displacement result from the map calculation.
| |
scaleY:Number (default = 0.0 ) — The multiplier to use to scale the y displacement result from the map calculation.
| |
mode:String (default = "wrap ") — The mode of the filter. Possible values are the DisplacementMapFilterMode
constants.
| |
color:uint (default = 0 ) — Specifies the color to use for out-of-bounds displacements. The valid range of
displacements is 0.0 to 1.0. Use this parameter if mode is set to DisplacementMapFilterMode.COLOR .
| |
alpha:Number (default = 0.0 ) — Specifies what alpha value to use for out-of-bounds displacements.
It is specified as a normalized value from 0.0 to 1.0. For example,
.25 sets a transparency value of 25%.
Use this parameter if mode is set to DisplacementMapFilterMode.COLOR .
|
相關 API 元素
clone | () | 方法 |
public function clone():BitmapFilter
語言版本: | ActionScript 3.0 |
產品版本: | Flex 4 |
執行階段版本: | Flash Player 10, AIR 1.5 |
Returns a copy of this filter object.
傳回值BitmapFilter — A new DisplacementMapFilter instance with all the same properties as the
original one.
|
Tue Jun 12 2018, 03:47 PM Z