| Pacote | spark.filters |
| Classe | public class DisplacementMapFilter |
| Herança | DisplacementMapFilter  BaseFilter EventDispatcher Object |
| Implementações | IBitmapFilter |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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
filtersproperty of the display object. Setting thefiltersproperty of an object does not modify the object, and you can remove the filter by clearing thefiltersproperty. - 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.
Mostrar sintaxe MXML
Ocultar sintaxe MXMLThe <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" />
Elementos da API relacionados
flash.display.DisplayObject.filters
flash.display.DisplayObject.cacheAsBitmap
| Propriedade | Definido por | ||
|---|---|---|---|
| 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
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | 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 | ||
| Método | Definido por | ||
|---|---|---|---|
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
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | EventDispatcher | |
Returns a copy of this filter object. | DisplacementMapFilter | ||
|
Envia um evento para o fluxo de eventos. | EventDispatcher | |
|
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | Object | |
|
Propagates a change event when the filter has changed. | BaseFilter | |
|
Indica se a propriedade especificada existe e é enumerável. | Object | |
|
Remove um ouvinte do objeto EventDispatcher. | EventDispatcher | |
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | EventDispatcher | |
alpha | propriedade |
alpha:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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.
O valor padrão é 0.
Implementação
public function get alpha():Number public function set alpha(value:Number):voidcolor | propriedade |
color:uint| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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.
O valor padrão é 0x000000.
Implementação
public function get color():uint public function set color(value:uint):voidcomponentX | propriedade |
componentX:uint| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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.ALPHABitmapDataChannel.BLUEBitmapDataChannel.GREENBitmapDataChannel.RED
O valor padrão é 0, meaning no channel..
Implementação
public function get componentX():uint public function set componentX(value:uint):voidElementos da API relacionados
componentY | propriedade |
componentY:uint| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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.ALPHABitmapDataChannel.BLUEBitmapDataChannel.GREENBitmapDataChannel.RED
O valor padrão é 0, meaning no channel..
Implementação
public function get componentY():uint public function set componentY(value:uint):voidmapBitmap | propriedade |
mapBitmap:BitmapData| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | Flash Player 10, AIR 1.5 |
A BitmapData object containing the displacement map data.
O valor padrão é null.
Implementação
public function get mapBitmap():BitmapData public function set mapBitmap(value:BitmapData):voidmapPoint | propriedade |
mapPoint:Point| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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.
O valor padrão é null.
Implementação
public function get mapPoint():Point public function set mapPoint(value:Point):voidmode | propriedade |
mode:String| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | 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.
O valor padrão é DisplacementMapFilterMode.WRAP.
Implementação
public function get mode():String public function set mode(value:String):voidscaleX | propriedade |
scaleX:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | Flash Player 10, AIR 1.5 |
The multiplier to use to scale the x displacement result from the map calculation.
O valor padrão é 0.
Implementação
public function get scaleX():Number public function set scaleX(value:Number):voidscaleY | propriedade |
scaleY:Number| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | Flash Player 10, AIR 1.5 |
The multiplier to use to scale the y displacement result from the map calculation.
O valor padrão é 0.
Implementação
public function get scaleY():Number public function set scaleY(value:Number):voidDisplacementMapFilter | () | Construtor |
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)| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | Flash Player 10, AIR 1.5 |
Constructor.
ParâmetrosmapBitmap:BitmapData (default = null) | |
mapPoint:Point (default = null) | |
componentX:uint (default = 0) | |
componentY:uint (default = 0) | |
scaleX:Number (default = 0.0) | |
scaleY:Number (default = 0.0) | |
mode:String (default = "wrap") | |
color:uint (default = 0)mode is set to DisplacementMapFilterMode.COLOR.
| |
alpha:Number (default = 0.0)mode is set to DisplacementMapFilterMode.COLOR.
|
Elementos da API relacionados
clone | () | método |
public function clone():BitmapFilter| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 4 |
| Versões de runtime: | Flash Player 10, AIR 1.5 |
Returns a copy of this filter object.
RetornaBitmapFilter — A new DisplacementMapFilter instance with all the same properties as the
original one.
|
Wed Jun 13 2018, 11:10 AM Z