001 /*
002 * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.awt.image;
027
028 import java.awt.geom.Rectangle2D;
029 import java.awt.geom.Point2D;
030 import java.awt.RenderingHints;
031
032 /**
033 * This interface describes single-input/single-output
034 * operations performed on Raster objects. It is implemented by such
035 * classes as AffineTransformOp, ConvolveOp, and LookupOp. The Source
036 * and Destination objects must contain the appropriate number
037 * of bands for the particular classes implementing this interface.
038 * Otherwise, an exception is thrown. This interface cannot be used to
039 * describe more sophisticated Ops such as ones that take multiple sources.
040 * Each class implementing this interface will specify whether or not it
041 * will allow an in-place filtering operation (i.e. source object equal
042 * to the destination object). Note that the restriction to single-input
043 * operations means that the values of destination pixels prior to the
044 * operation are not used as input to the filter operation.
045 * @see AffineTransformOp
046 * @see BandCombineOp
047 * @see ColorConvertOp
048 * @see ConvolveOp
049 * @see LookupOp
050 * @see RescaleOp
051 * @version 10 Feb 1997
052 */
053 public interface RasterOp {
054 /**
055 * Performs a single-input/single-output operation from a source Raster
056 * to a destination Raster. If the destination Raster is null, a
057 * new Raster will be created. The IllegalArgumentException may be thrown
058 * if the source and/or destination Raster is incompatible with the types
059 * of Rasters allowed by the class implementing this filter.
060 * @param src the source <code>Raster</code>
061 * @param dest the destination <code>WritableRaster</code>
062 * @return a <code>WritableRaster</code> that represents the result of
063 * the filtering operation.
064 */
065 public WritableRaster filter(Raster src, WritableRaster dest);
066
067 /**
068 * Returns the bounding box of the filtered destination Raster.
069 * The IllegalArgumentException may be thrown if the source Raster
070 * is incompatible with the types of Rasters allowed
071 * by the class implementing this filter.
072 * @param src the source <code>Raster</code>
073 * @return a <code>Rectangle2D</code> that is the bounding box of
074 * the <code>Raster</code> resulting from the filtering
075 * operation.
076 */
077 public Rectangle2D getBounds2D(Raster src);
078
079 /**
080 * Creates a zeroed destination Raster with the correct size and number of
081 * bands.
082 * The IllegalArgumentException may be thrown if the source Raster
083 * is incompatible with the types of Rasters allowed
084 * by the class implementing this filter.
085 * @param src the source <code>Raster</code>
086 * @return a <code>WritableRaster</code> that is compatible with
087 * <code>src</code>
088 */
089 public WritableRaster createCompatibleDestRaster(Raster src);
090
091 /**
092 * Returns the location of the destination point given a
093 * point in the source Raster. If dstPt is non-null, it
094 * will be used to hold the return value.
095 * @param srcPt the source <code>Point2D</code>
096 * @param dstPt the destination <code>Point2D</code>
097 * @return the location of the destination point.
098 */
099 public Point2D getPoint2D(Point2D srcPt, Point2D dstPt);
100
101 /**
102 * Returns the rendering hints for this RasterOp. Returns
103 * null if no hints have been set.
104 * @return the <code>RenderingHints</code> object of this
105 * <code>RasterOp</code>.
106 */
107 public RenderingHints getRenderingHints();
108 }
|