Packagegraphics.filters
Classpublic class RippleCrossingFilter
InheritanceRippleCrossingFilter Inheritance ShaderCustomFilter Inheritance flash.filters.ShaderFilter

Applies a ripple crossing transition effect. The Shader must be defines with the RippleCrossing pixelbender implementation.


Public Properties
 PropertyDefined By
  amount : Number
The amount value of the transition betwen 0 and 1.
RippleCrossingFilter
  amplitude : Number
The amplitude of the ripple effect between 0 and 1 (default 0.05)
RippleCrossingFilter
  centerX : Number
The center x offset value between 0 and 1 of the effect (default 0.5)
RippleCrossingFilter
  centerY : Number
The center y offset value between 0 and 1 of the effect (default 0.5)
RippleCrossingFilter
 Inheriteddescription : String
[read-only] The description of the filter (defines in the Shader).
ShaderCustomFilter
  frequency : Number
The frequency of the ripple effect (value between 0.0 and 1.0 and default 0.2).
RippleCrossingFilter
  from : BitmapData
The BitmapData reference who represents the "from" input representation of the interpolation.
RippleCrossingFilter
  height : Number
The height of the ripple effect area (default 240 px).
RippleCrossingFilter
 Inheritedname : String
[read-only] The name of the filter (defines in the Shader).
ShaderCustomFilter
 Inheritednamespace : String
[read-only] The namespace of the filter (defines in the Shader).
ShaderCustomFilter
  speed : Number
The speed of the ripple effect (value between 0.0 and 1.0 and default 0.1).
RippleCrossingFilter
  to : BitmapData
The BitmapData reference who represents the "to" input representation of the interpolation.
RippleCrossingFilter
 Inheritedversion : String
[read-only] The version of the filter (defines in the Shader).
ShaderCustomFilter
  width : Number
The width of the ripple effect area (default 320 px).
RippleCrossingFilter
Public Methods
 MethodDefined By
  
RippleCrossingFilter(init:Object = null, shader:Shader = null)
Creates a new RippleCrossingFilter instance.
RippleCrossingFilter
  
clone():BitmapFilter
[override] Returns a shallow copy of the object.
RippleCrossingFilter
Property Detail
amountproperty
amount:Number

The amount value of the transition betwen 0 and 1.


Implementation
    public function get amount():Number
    public function set amount(value:Number):void
amplitudeproperty 
amplitude:Number

The amplitude of the ripple effect between 0 and 1 (default 0.05)


Implementation
    public function get amplitude():Number
    public function set amplitude(value:Number):void
centerXproperty 
centerX:Number

The center x offset value between 0 and 1 of the effect (default 0.5)


Implementation
    public function get centerX():Number
    public function set centerX(value:Number):void
centerYproperty 
centerY:Number

The center y offset value between 0 and 1 of the effect (default 0.5)


Implementation
    public function get centerY():Number
    public function set centerY(value:Number):void
frequencyproperty 
frequency:Number

The frequency of the ripple effect (value between 0.0 and 1.0 and default 0.2).


Implementation
    public function get frequency():Number
    public function set frequency(value:Number):void
fromproperty 
from:BitmapData

The BitmapData reference who represents the "from" input representation of the interpolation.


Implementation
    public function get from():BitmapData
    public function set from(value:BitmapData):void
heightproperty 
height:Number

The height of the ripple effect area (default 240 px).


Implementation
    public function get height():Number
    public function set height(value:Number):void
speedproperty 
speed:Number

The speed of the ripple effect (value between 0.0 and 1.0 and default 0.1).


Implementation
    public function get speed():Number
    public function set speed(value:Number):void
toproperty 
to:BitmapData

The BitmapData reference who represents the "to" input representation of the interpolation.


Implementation
    public function get to():BitmapData
    public function set to(value:BitmapData):void
widthproperty 
width:Number

The width of the ripple effect area (default 320 px).


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
RippleCrossingFilter()Constructor
public function RippleCrossingFilter(init:Object = null, shader:Shader = null)

Creates a new RippleCrossingFilter instance.

Parameters
init:Object (default = null) — The optional dynamic object to initialize the filter.
 
shader:Shader (default = null) — The Shader reference of the filter.
Method Detail
clone()method
override public function clone():BitmapFilter

Returns a shallow copy of the object.

Returns
BitmapFilter — a shallow copy of the object.




Mardi Août 16 2011, 02:33 PM +02:00