Packagede.popforge.imageprocessing.filters.distortion
Classpublic class DisplacementMap
InheritanceDisplacementMap Inheritance NativeFilter
SubclassesQuickBumpMap

The DisplacementMap class is an implementation of the native DisplacementMapFilter.

Supported formats:

See also

flash.filters.DisplacementMapFilter

Protected Properties
 PropertyDefined by
 Inheritedfilter : BitmapFilter
The native filter that will be overridden by a subclass of NativeFilter.
NativeFilter
Public Methods
 MethodDefined by
  
DisplacementMap(mapBitmap:BitmapData = null, mapPoint:Point = null, componentX:uint = 0, componentY:uint = 0, scaleX:Number = 0.0, scaleY:Number = 0, mode:String = "wrap", color:uint = 0, alpha:Number = 0)
Creates a new DisplacementMap object.
DisplacementMap
 Inherited
apply(image:Image):void
Applies the filter to the given Image object.
NativeFilter
  
toString():String
Builds and returns a string containing the name of the class.
DisplacementMap
Constructor detail
DisplacementMap()constructor
public function DisplacementMap(mapBitmap:BitmapData = null, mapPoint:Point = null, componentX:uint = 0, componentY:uint = 0, scaleX:Number = 0.0, scaleY:Number = 0, mode:String = "wrap", color:uint = 0, alpha:Number = 0)

Creates a new DisplacementMap object.

Parameters
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) — 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) — 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%. The default is 1.0. Use this parameter if mode is set to DisplacementMapFilterMode.COLOR.
Method detail
toString()method
public override function toString():String

Builds and returns a string containing the name of the class.

Returns
String — A string containing the name of the class.



Built with love by Joa Ebert - http://blog.je2050.de/
Do Feb 8 2007, 1:02 AM GMT+01:00