| Paquete | spark.filters |
| Clase | public class DisplacementMapFilter |
| Herencia | DisplacementMapFilter  BaseFilter EventDispatcher Object |
| Implementa | IBitmapFilter |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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 sintaxis MXML
Ocultar sintaxis 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 de API relacionados
flash.display.DisplayObject.filters
flash.display.DisplayObject.cacheAsBitmap
| Propiedad | 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
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | 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 un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | |
Returns a copy of this filter object. | DisplacementMapFilter | ||
|
Distribuye un evento en el flujo del evento. | EventDispatcher | |
|
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | |
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Propagates a change event when the filter has changed. | BaseFilter | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Elimina un detector del objeto EventDispatcher. | EventDispatcher | |
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
|
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | EventDispatcher | |
alpha | propiedad |
alpha:Number| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es 0.
Implementación
public function get alpha():Number public function set alpha(value:Number):voidcolor | propiedad |
color:uint| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es 0x000000.
Implementación
public function get color():uint public function set color(value:uint):voidcomponentX | propiedad |
componentX:uint| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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
El valor predeterminado es 0, meaning no channel..
Implementación
public function get componentX():uint public function set componentX(value:uint):voidElementos de API relacionados
componentY | propiedad |
componentY:uint| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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
El valor predeterminado es 0, meaning no channel..
Implementación
public function get componentY():uint public function set componentY(value:uint):voidmapBitmap | propiedad |
mapBitmap:BitmapData| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
A BitmapData object containing the displacement map data.
El valor predeterminado es null.
Implementación
public function get mapBitmap():BitmapData public function set mapBitmap(value:BitmapData):voidmapPoint | propiedad |
mapPoint:Point| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es null.
Implementación
public function get mapPoint():Point public function set mapPoint(value:Point):voidmode | propiedad |
mode:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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.
El valor predeterminado es DisplacementMapFilterMode.WRAP.
Implementación
public function get mode():String public function set mode(value:String):voidscaleX | propiedad |
scaleX:Number| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
The multiplier to use to scale the x displacement result from the map calculation.
El valor predeterminado es 0.
Implementación
public function get scaleX():Number public function set scaleX(value:Number):voidscaleY | propiedad |
scaleY:Number| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
The multiplier to use to scale the y displacement result from the map calculation.
El valor predeterminado es 0.
Implementación
public function get scaleY():Number public function set scaleY(value:Number):voidDisplacementMapFilter | () | Información sobre |
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)| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | 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 de API relacionados
clone | () | método |
public function clone():BitmapFilter| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Flex 4 |
| Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Returns a copy of this filter object.
Valor devueltoBitmapFilter — A new DisplacementMapFilter instance with all the same properties as the
original one.
|
Tue Jun 12 2018, 02:12 PM Z