magoffin.matt.ma2.image.awt
Class BumpMapEffect

java.lang.Object
  magoffin.matt.ma2.image.awt.BaseAwtMediaEffect
      magoffin.matt.ma2.image.awt.BumpMapEffect

All Implemented Interfaces:

AwtMediaEffect, MediaEffect

public class BumpMapEffect
extends BaseAwtMediaEffect

A watermark effect for AWT based processing, that creates a 3D bump map from the watermark image.

Version:

$Revision: 43 $ $Date: 2007-10-21 11:10:01 +1300 (Sun, 21 Oct 2007) $

Author:

matt

Field Summary

static java.lang.String	BUMP_MAP_KEY The key for this effect.
static java.awt.Color	DEFAULT_COLOR Default value for the color property.
static int	DEFAULT_ELEVATION_SCALE Default value for the elevationScale property.
static float	DEFAULT_INTENSITY Default value for the intensity property.
static double[]	DEFAULT_LIGHT Default value for the light property.

Fields inherited from class magoffin.matt.ma2.image.awt.BaseAwtMediaEffect

log

Fields inherited from interface magoffin.matt.ma2.image.awt.AwtMediaEffect

INPUT_BUFFERED_IMAGE_KEY

Fields inherited from interface magoffin.matt.ma2.MediaEffect

KEY_ROTATE, KEY_SCALE, KEY_WATERMARK, MEDIA_REQUEST_PARAM_ROTATE_DEGREES, MEDIA_REQUEST_PARAM_WATERMARK_RESOURCE

Constructor Summary

BumpMapEffect()

Method Summary

java.awt.image.BufferedImage	applyEffect(MediaItem item, MediaRequest request, java.awt.image.BufferedImage source) Apply an effect on a BufferedImage and return the result as a new BufferedImage.
java.awt.Color	getColor()
java.lang.Integer	getElevationScale()
ImageMediaHelper	getImageMediaHelper()
java.lang.Float	getIntensity()
java.lang.String	getKey() Get the key for this effect.
double[]	getLight()
void	setColor(java.awt.Color color)
void	setElevationScale(java.lang.Integer elevationScale)
void	setImageMediaHelper(ImageMediaHelper imageMediaHelper)
void	setIntensity(java.lang.Float intensity)
void	setLight(double[] light)

Methods inherited from class magoffin.matt.ma2.image.awt.BaseAwtMediaEffect

apply, getMediaBiz, setMediaBiz

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUMP_MAP_KEY

public static final java.lang.String BUMP_MAP_KEY

The key for this effect.

See Also:

Constant Field Values

DEFAULT_LIGHT

public static final double[] DEFAULT_LIGHT

Default value for the light property.

DEFAULT_INTENSITY

public static final float DEFAULT_INTENSITY

Default value for the intensity property.

See Also:

Constant Field Values

DEFAULT_COLOR

public static final java.awt.Color DEFAULT_COLOR

Default value for the color property.

DEFAULT_ELEVATION_SCALE

public static final int DEFAULT_ELEVATION_SCALE

Default value for the elevationScale property.

See Also:

Constant Field Values

Constructor Detail

BumpMapEffect

public BumpMapEffect()

Method Detail

applyEffect

public java.awt.image.BufferedImage applyEffect(MediaItem item,
                                                MediaRequest request,
                                                java.awt.image.BufferedImage source)

Description copied from interface: AwtMediaEffect

Apply an effect on a BufferedImage and return the result as a new BufferedImage.

If no change is made to the source BufferedImage then source can be returned from this method.

Parameters:

item - the MediaItem the effect is being applied to

request - the request

source - the source BufferedImage

Returns:

the updated BufferedImage

getKey

public java.lang.String getKey()

Description copied from interface: MediaEffect

Get the key for this effect.

Keys uniquely describe the implementation and function of the effect. The implementation key should come first, and the function key at the end. Some standard function key values are defined in this API: MediaEffect.KEY_SCALE for re-sizing and MediaEffect.KEY_ROTATE for rotating.

For example, a key might look like image.awt.rotate for an image rotation effect based on a Java AWT implementation.

Returns:

the effect key

getImageMediaHelper

public ImageMediaHelper getImageMediaHelper()

Returns:

the imageMediaHelper

setImageMediaHelper

public void setImageMediaHelper(ImageMediaHelper imageMediaHelper)

Parameters:

imageMediaHelper - the imageMediaHelper to set

getColor

public java.awt.Color getColor()

Returns:

the color

setColor

public void setColor(java.awt.Color color)

Parameters:

color - the color to set

getElevationScale

public java.lang.Integer getElevationScale()

Returns:

the elevationScale

setElevationScale

public void setElevationScale(java.lang.Integer elevationScale)

Parameters:

elevationScale - the elevationScale to set

getIntensity

public java.lang.Float getIntensity()

Returns:

the intensity

setIntensity

public void setIntensity(java.lang.Float intensity)

Parameters:

intensity - the intensity to set

getLight

public double[] getLight()

Returns:

the light

setLight

public void setLight(double[] light)

Parameters:

light - the light to set