railo.runtime.img.filter
Class TransitionFilter

java.lang.Object
  extended by railo.runtime.img.filter.AbstractBufferedImageOp
      extended by railo.runtime.img.filter.TransitionFilter
All Implemented Interfaces:
BufferedImageOp, Cloneable, DynFiltering

public class TransitionFilter
extends AbstractBufferedImageOp
implements DynFiltering

A filter which uses another filter to perform a transition. e.g. to create a blur transition, you could write: new TransitionFilter( new BoxBlurFilter(), "radius", 0, 100 );


Constructor Summary
TransitionFilter(BufferedImageOp filter, String property, float minValue, float maxValue)
          Construct a TransitionFilter.
 
Method Summary
 BufferedImage filter(BufferedImage src, BufferedImage dst)
           
 BufferedImage filter(BufferedImage src, Struct parameters)
           
 BufferedImage getDestination()
          Get the destination image.
 float getTransition()
          Get the transition of the image.
 void prepareFilter(float transition)
          Prepare the filter for the transiton at a given time.
 void setDestination(BufferedImage destination)
          Set the destination image.
 void setTransition(float transition)
          Set the transition of the image in the range 0..1.
 String toString()
           
 
Methods inherited from class railo.runtime.img.filter.AbstractBufferedImageOp
clone, createCompatibleDestImage, getBounds2D, getPoint2D, getRenderingHints, getRGB, setRGB
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TransitionFilter

public TransitionFilter(BufferedImageOp filter,
                        String property,
                        float minValue,
                        float maxValue)
Construct a TransitionFilter.

Parameters:
filter - the filter to use
property - the filter property which is changed over the transition
minValue - the start value for the filter property
maxValue - the end value for the filter property
Method Detail

setTransition

public void setTransition(float transition)
Set the transition of the image in the range 0..1.

Parameters:
transition - the transition
See Also:
getTransition()

getTransition

public float getTransition()
Get the transition of the image.

Returns:
the transition
See Also:
setTransition(float)

setDestination

public void setDestination(BufferedImage destination)
Set the destination image.

Parameters:
destination - the destination image
See Also:
getDestination()

getDestination

public BufferedImage getDestination()
Get the destination image.

Returns:
the destination image
See Also:
setDestination(java.awt.image.BufferedImage)

prepareFilter

public void prepareFilter(float transition)
Prepare the filter for the transiton at a given time. The default implementation sets the given filter property, but you could override this method to make other changes.

Parameters:
transition - the transition time in the range 0 - 1

filter

public BufferedImage filter(BufferedImage src,
                            BufferedImage dst)
Specified by:
filter in interface BufferedImageOp

toString

public String toString()
Overrides:
toString in class Object

filter

public BufferedImage filter(BufferedImage src,
                            Struct parameters)
                     throws PageException
Specified by:
filter in interface DynFiltering
Throws:
PageException


Copyright © 2012 Railo