javax.media.jai.operator
Class TranslateDescriptor

java.lang.Object
  |
  +--javax.media.jai.OperationDescriptorImpl
        |
        +--javax.media.jai.operator.TranslateDescriptor

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class TranslateDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "Translate" operation.

The "Translate" operation copies an image to a new location in the plane.

For each pixel (x, y) of the destination, the source value at the fractional subpixel position (x - xTrans, y - yTrans) is constructed by means of an Interpolation object and written to the destination. If both xTrans and yTrans are integral, the operation simply "wraps" its source image to change the image's position in the coordinate plane.

It may be noted that the minX, minY, width and height hints as specified through the JAI.KEY_IMAGE_LAYOUT hint in the RenderingHints object are not honored, as this operator calculates the destination image bounds itself. The other ImageLayout hints, like tileWidth and tileHeight, however are honored.

It should be noted that this operation automatically adds a value of Boolean.TRUE for the JAI.KEY_REPLACE_INDEX_COLOR_MODEL to the given configuration so that the operation is performed on the pixel values instead of being performed on the indices into the color map if the source(s) have an IndexColorModel. This addition will take place only if a value for the JAI.KEY_REPLACE_INDEX_COLOR_MODEL has not already been provided by the user. Note that the configuration Map is cloned before the new hint is added to it. The operation can be smart about the value of the JAI.KEY_REPLACE_INDEX_COLOR_MODEL RenderingHints, i.e. while the default value for the JAI.KEY_REPLACE_INDEX_COLOR_MODEL is Boolean.TRUE, in some cases the operator could set the default.

"Translate" defines a PropertyGenerator that performs an identical transformation on the "ROI" property of the source image, which can be retrieved by calling the getProperty method with "ROI" as the property name.

Resource List

Name	Value
GlobalName	Translate
LocalName	Translate
Vendor	com.sun.media.jai
Description	Moves an image to a new location.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/TranslateDescriptor.html
Version	1.0
arg0Desc	The displacement in X direction.
arg1Desc	The displacement in Y direction.
arg2Desc	The interpolation method.

Parameter List

Name	Class Type	Default Value
xTrans	java.lang.Float	0.0F
yTrans	java.lang.Float	0.0F
interpolation	javax.media.jai.Interpolation	InterpolationNearest

See Also:

Interpolation, OperationDescriptor, Serialized Form

Fields inherited from class javax.media.jai.OperationDescriptorImpl

resources, sourceNames, supportedModes

Fields inherited from interface javax.media.jai.OperationDescriptor

NO_PARAMETER_DEFAULT

Constructor Summary

TranslateDescriptor()
Constructor.

Method Summary

static RenderedOp	create(RenderedImage source0, Float xTrans, Float yTrans, Interpolation interpolation, RenderingHints hints) Moves an image to a new location.
static RenderableOp	createRenderable(RenderableImage source0, Float xTrans, Float yTrans, Interpolation interpolation, RenderingHints hints) Moves an image to a new location.
PropertyGenerator[]	getPropertyGenerators() Returns an array of PropertyGenerators implementing property inheritance for the "Translate" operation
boolean	isRenderableSupported() Returns true since renderable operation is supported.

Methods inherited from class javax.media.jai.OperationDescriptorImpl

arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, getInvalidRegion, getName, getNumParameters, getNumSources, getParamClasses, getParamDefaults, getParamDefaultValue, getParameterListDescriptor, getParamMaxValue, getParamMinValue, getParamNames, getPropertyGenerators, getRenderableDestClass, getRenderableSourceClasses, getResourceBundle, getResources, getSourceClasses, getSourceClasses, getSourceNames, getSupportedModes, isImmediate, isModeSupported, isRenderedSupported, makeDefaultSourceClassList, validateArguments, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslateDescriptor

public TranslateDescriptor()

Constructor.

Method Detail

isRenderableSupported

public boolean isRenderableSupported()

Returns true since renderable operation is supported.

Overrides:

isRenderableSupported in class OperationDescriptorImpl

Following copied from class: javax.media.jai.OperationDescriptorImpl

See Also:

OperationDescriptorImpl.isModeSupported(java.lang.String)

getPropertyGenerators

public PropertyGenerator[] getPropertyGenerators()

Returns an array of PropertyGenerators implementing property inheritance for the "Translate" operation

Overrides:

getPropertyGenerators in class OperationDescriptorImpl

Returns:

An array of property generators.

create

public static RenderedOp create(RenderedImage source0,
                                Float xTrans,
                                Float yTrans,
                                Interpolation interpolation,
                                RenderingHints hints)

Moves an image to a new location.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.create(String,ParameterBlock,RenderingHints).

Parameters:

source0 - RenderedImage source 0.

xTrans - The displacement in X direction. May be null.

yTrans - The displacement in Y direction. May be null.

interpolation - The interpolation method. May be null.

hints - The RenderingHints to use. May be null.

Returns:

The RenderedOp destination.

Throws:

IllegalArgumentException - if source0 is null.

See Also:

JAI, ParameterBlockJAI, RenderedOp

createRenderable

public static RenderableOp createRenderable(RenderableImage source0,
                                            Float xTrans,
                                            Float yTrans,
                                            Interpolation interpolation,
                                            RenderingHints hints)

Moves an image to a new location.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.createRenderable(String,ParameterBlock,RenderingHints).

Parameters:

source0 - RenderableImage source 0.

xTrans - The displacement in X direction. May be null.

yTrans - The displacement in Y direction. May be null.

interpolation - The interpolation method. May be null.

hints - The RenderingHints to use. May be null.

Returns:

The RenderableOp destination.

Throws:

IllegalArgumentException - if source0 is null.

See Also:

JAI, ParameterBlockJAI, RenderableOp