magoffin.matt.ma2.image.jmagick
Class BumpMapEffect

java.lang.Object
  extended by magoffin.matt.ma2.image.jmagick.BaseJMagickMediaEffect
      extended by magoffin.matt.ma2.image.jmagick.BumpMapEffect
All Implemented Interfaces:
JMagickMediaEffect, MediaEffect

public class BumpMapEffect
extends BaseJMagickMediaEffect

A watermark effect for JMagick 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.
 
Fields inherited from class magoffin.matt.ma2.image.jmagick.BaseJMagickMediaEffect
log
 
Fields inherited from interface magoffin.matt.ma2.image.jmagick.JMagickMediaEffect
INPUT_IMAGE_INFO_KEY, INPUT_MAGICK_IMAGE_KEY, OUTPUT_MAGICK_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
 magick.MagickImage applyEffect(MediaItem item, MediaRequest request, magick.ImageInfo inInfo, magick.MagickImage image)
          Apply effect with ImageMagick.
 java.lang.String getKey()
          Get the key for this effect.
 
Methods inherited from class magoffin.matt.ma2.image.jmagick.BaseJMagickMediaEffect
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
Constructor Detail

BumpMapEffect

public BumpMapEffect()
Method Detail

applyEffect

public magick.MagickImage applyEffect(MediaItem item,
                                      MediaRequest request,
                                      magick.ImageInfo inInfo,
                                      magick.MagickImage image)
Description copied from interface: JMagickMediaEffect
Apply effect with ImageMagick.

Parameters:
item - the MediaItem the effect is being applied to
request - the request
inInfo - the ImageInfo used to open the image
image - the current ImageMagick MagickImage
Returns:
the resulting image

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