001 /*
002 * Copyright 1997-2007 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;
027
028 import java.awt.geom.Rectangle2D;
029 import java.awt.geom.AffineTransform;
030 import java.awt.image.BufferedImage;
031 import java.awt.image.ColorModel;
032
033 /**
034 * The <code>TexturePaint</code> class provides a way to fill a
035 * {@link Shape} with a texture that is specified as
036 * a {@link BufferedImage}. The size of the <code>BufferedImage</code>
037 * object should be small because the <code>BufferedImage</code> data
038 * is copied by the <code>TexturePaint</code> object.
039 * At construction time, the texture is anchored to the upper
040 * left corner of a {@link Rectangle2D} that is
041 * specified in user space. Texture is computed for
042 * locations in the device space by conceptually replicating the
043 * specified <code>Rectangle2D</code> infinitely in all directions
044 * in user space and mapping the <code>BufferedImage</code> to each
045 * replicated <code>Rectangle2D</code>.
046 * @see Paint
047 * @see Graphics2D#setPaint
048 * @version 1.48, 06/05/07
049 */
050
051 public class TexturePaint implements Paint {
052
053 BufferedImage bufImg;
054 double tx;
055 double ty;
056 double sx;
057 double sy;
058
059 /**
060 * Constructs a <code>TexturePaint</code> object.
061 * @param txtr the <code>BufferedImage</code> object with the texture
062 * used for painting
063 * @param anchor the <code>Rectangle2D</code> in user space used to
064 * anchor and replicate the texture
065 */
066 public TexturePaint(BufferedImage txtr, Rectangle2D anchor) {
067 this .bufImg = txtr;
068 this .tx = anchor.getX();
069 this .ty = anchor.getY();
070 this .sx = anchor.getWidth() / bufImg.getWidth();
071 this .sy = anchor.getHeight() / bufImg.getHeight();
072 }
073
074 /**
075 * Returns the <code>BufferedImage</code> texture used to
076 * fill the shapes.
077 * @return a <code>BufferedImage</code>.
078 */
079 public BufferedImage getImage() {
080 return bufImg;
081 }
082
083 /**
084 * Returns a copy of the anchor rectangle which positions and
085 * sizes the textured image.
086 * @return the <code>Rectangle2D</code> used to anchor and
087 * size this <code>TexturePaint</code>.
088 */
089 public Rectangle2D getAnchorRect() {
090 return new Rectangle2D.Double(tx, ty, sx * bufImg.getWidth(),
091 sy * bufImg.getHeight());
092 }
093
094 /**
095 * Creates and returns a context used to generate the color pattern.
096 * @param cm the {@link ColorModel} that receives the
097 * <code>Paint</code> data. This is used only as a hint.
098 * @param deviceBounds the device space bounding box of the graphics
099 * primitive being rendered
100 * @param userBounds the user space bounding box of the graphics
101 * primitive being rendered
102 * @param xform the {@link AffineTransform} from user space
103 * into device space
104 * @param hints a {@link RenderingHints} object that can be used to
105 * specify how the pattern is ultimately rendered
106 * @return the {@link PaintContext} used for generating color
107 * patterns.
108 * @see PaintContext
109 */
110 public PaintContext createContext(ColorModel cm,
111 Rectangle deviceBounds, Rectangle2D userBounds,
112 AffineTransform xform, RenderingHints hints) {
113 if (xform == null) {
114 xform = new AffineTransform();
115 } else {
116 xform = (AffineTransform) xform.clone();
117 }
118 xform.translate(tx, ty);
119 xform.scale(sx, sy);
120
121 return TexturePaintContext.getContext(bufImg, xform, hints,
122 deviceBounds);
123 }
124
125 /**
126 * Returns the transparency mode for this <code>TexturePaint</code>.
127 * @return the transparency mode for this <code>TexturePaint</code>
128 * as an integer value.
129 * @see Transparency
130 */
131 public int getTransparency() {
132 return (bufImg.getColorModel()).getTransparency();
133 }
134
135 }
|