railo.runtime.img.filter
Class LightFilter

java.lang.Object
  extended by railo.runtime.img.filter.AbstractBufferedImageOp
      extended by railo.runtime.img.filter.WholeImageFilter
          extended by railo.runtime.img.filter.LightFilter
All Implemented Interfaces:
BufferedImageOp, Cloneable, DynFiltering
Direct Known Subclasses:
ChromeFilter

public class LightFilter
extends WholeImageFilter
implements DynFiltering

A filter which produces lighting and embossing effects.


Nested Class Summary
 class LightFilter.AmbientLight
           
 class LightFilter.DistantLight
           
static class LightFilter.Light
          A class representing a light.
static class LightFilter.Material
          A class representing material properties.
 class LightFilter.PointLight
           
 class LightFilter.SpotLight
           
 
Field Summary
static int AMBIENT
           
static int BUMPS_FROM_BEVEL
          Use a custom function as the bump map.
static int BUMPS_FROM_IMAGE
          Use the input image brightness as the bump map.
static int BUMPS_FROM_IMAGE_ALPHA
          Use the input image alpha as the bump map.
static int BUMPS_FROM_MAP
          Use a separate image alpha channel as the bump map.
static int COLORS_CONSTANT
          Use constant material color.
static int COLORS_FROM_IMAGE
          Take the output colors from the input image.
static int DISTANT
           
static int POINT
           
static int SPOT
           
 
Constructor Summary
LightFilter()
           
 
Method Summary
 void addLight(LightFilter.Light light)
           
 BufferedImage filter(BufferedImage src, Struct parameters)
           
 Function2D getBumpFunction()
           
 float getBumpHeight()
           
 int getBumpShape()
           
 float getBumpSoftness()
           
 int getBumpSource()
           
 int getColorSource()
           
 int getDiffuseColor()
           
 Image getEnvironmentMap()
           
 Vector getLights()
           
 LightFilter.Material getMaterial()
           
 float getViewDistance()
           
 void removeLight(LightFilter.Light light)
           
 void setBumpFunction(Function2D bumpFunction)
           
 void setBumpHeight(float bumpHeight)
           
 void setBumpShape(int bumpShape)
           
 void setBumpSoftness(float bumpSoftness)
           
 void setBumpSource(int bumpSource)
           
 void setColorSource(int colorSource)
           
 void setDiffuseColor(int diffuseColor)
           
 void setEnvironmentMap(BufferedImage environmentMap)
           
 void setMaterial(LightFilter.Material material)
           
 void setViewDistance(float viewDistance)
           
 String toString()
           
 
Methods inherited from class railo.runtime.img.filter.WholeImageFilter
filter
 
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
 

Field Detail

COLORS_FROM_IMAGE

public static final int COLORS_FROM_IMAGE
Take the output colors from the input image.

See Also:
Constant Field Values

COLORS_CONSTANT

public static final int COLORS_CONSTANT
Use constant material color.

See Also:
Constant Field Values

BUMPS_FROM_IMAGE

public static final int BUMPS_FROM_IMAGE
Use the input image brightness as the bump map.

See Also:
Constant Field Values

BUMPS_FROM_IMAGE_ALPHA

public static final int BUMPS_FROM_IMAGE_ALPHA
Use the input image alpha as the bump map.

See Also:
Constant Field Values

BUMPS_FROM_MAP

public static final int BUMPS_FROM_MAP
Use a separate image alpha channel as the bump map.

See Also:
Constant Field Values

BUMPS_FROM_BEVEL

public static final int BUMPS_FROM_BEVEL
Use a custom function as the bump map.

See Also:
Constant Field Values

AMBIENT

public static final int AMBIENT
See Also:
Constant Field Values

DISTANT

public static final int DISTANT
See Also:
Constant Field Values

POINT

public static final int POINT
See Also:
Constant Field Values

SPOT

public static final int SPOT
See Also:
Constant Field Values
Constructor Detail

LightFilter

public LightFilter()
Method Detail

setMaterial

public void setMaterial(LightFilter.Material material)

getMaterial

public LightFilter.Material getMaterial()

setBumpFunction

public void setBumpFunction(Function2D bumpFunction)

getBumpFunction

public Function2D getBumpFunction()

setBumpHeight

public void setBumpHeight(float bumpHeight)

getBumpHeight

public float getBumpHeight()

setBumpSoftness

public void setBumpSoftness(float bumpSoftness)

getBumpSoftness

public float getBumpSoftness()

setBumpShape

public void setBumpShape(int bumpShape)

getBumpShape

public int getBumpShape()

setViewDistance

public void setViewDistance(float viewDistance)

getViewDistance

public float getViewDistance()

setEnvironmentMap

public void setEnvironmentMap(BufferedImage environmentMap)

getEnvironmentMap

public Image getEnvironmentMap()

setColorSource

public void setColorSource(int colorSource)

getColorSource

public int getColorSource()

setBumpSource

public void setBumpSource(int bumpSource)

getBumpSource

public int getBumpSource()

setDiffuseColor

public void setDiffuseColor(int diffuseColor)

getDiffuseColor

public int getDiffuseColor()

addLight

public void addLight(LightFilter.Light light)

removeLight

public void removeLight(LightFilter.Light light)

getLights

public Vector getLights()

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
Overrides:
filter in class WholeImageFilter
Throws:
PageException


Copyright © 2012 Railo