Source for java.awt.TexturePaint

   1: /* TexturePaint.java -- 
   2:    Copyright (C) 2002 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.awt;
  40: 
  41: import gnu.java.awt.java2d.TexturePaintContext;
  42: 
  43: import java.awt.geom.AffineTransform;
  44: import java.awt.geom.Rectangle2D;
  45: import java.awt.image.BufferedImage;
  46: import java.awt.image.ColorModel;
  47: 
  48: /**
  49:  * This class provides a way to fill a Shape with a texture that is
  50:  * specified by a BufferedImage.
  51:  */
  52: public class TexturePaint implements Paint
  53: {
  54:   private final BufferedImage texture;
  55:   private final Rectangle2D anchor;
  56:   
  57:   /**
  58:    * Constructor.
  59:    * 
  60:    * @param texture - the texture
  61:    * @param anchor - the shape
  62:    */
  63:   public TexturePaint(BufferedImage texture, Rectangle2D anchor)
  64:   {
  65:     this.texture = texture;
  66:     this.anchor = anchor;
  67:   }
  68: 
  69:   /**
  70:    * Gets the texture image.
  71:    * 
  72:    * @return the texture
  73:    */
  74:   public BufferedImage getImage()
  75:   {
  76:     return texture;
  77:   }
  78: 
  79:   /**
  80:    * Gets the shape anchor.
  81:    * 
  82:    * @return the shape anchor
  83:    */
  84:   public Rectangle2D getAnchorRect()
  85:   {
  86:     return anchor;
  87:   }
  88: 
  89:   /**
  90:    * Creates the context used to paint the texture.
  91:    * 
  92:    * @param cm - the ColorModel that receives the Paint data. Used only as a hint.
  93:    * @param deviceBounds - the device space being rendered.
  94:    * @param userBounds - the user space being rendered
  95:    * @param xform - the AffineTransform from user space into device space
  96:    * @param hints - a RenderingHints object that is used to specify how the 
  97:    * pattern is rendered
  98:    * @return the paint context used to paint the texture
  99:    */
 100:   public PaintContext createContext(ColorModel cm, Rectangle deviceBounds,
 101:                                     Rectangle2D userBounds,
 102:                                     AffineTransform xform, RenderingHints hints)
 103:   {
 104:     // TODO: Maybe add some hook for providing alternative/accelerated
 105:     // implementations of this.
 106:     return new TexturePaintContext(this, deviceBounds, userBounds, xform);
 107:   }
 108: 
 109:   /**
 110:    * Returns the transparency mode.
 111:    * 
 112:    * @return the transparency mode.
 113:    */
 114:   public int getTransparency()
 115:   {
 116:     return texture.getTransparency();
 117:   }
 118: } // class TexturePaint