001    /* TexturePaint.java -- 
002       Copyright (C) 2002 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package java.awt;
040    
041    import gnu.java.awt.java2d.TexturePaintContext;
042    
043    import java.awt.geom.AffineTransform;
044    import java.awt.geom.Rectangle2D;
045    import java.awt.image.BufferedImage;
046    import java.awt.image.ColorModel;
047    
048    /**
049     * This class provides a way to fill a Shape with a texture that is
050     * specified by a BufferedImage.
051     */
052    public class TexturePaint implements Paint
053    {
054      private final BufferedImage texture;
055      private final Rectangle2D anchor;
056      
057      /**
058       * Constructor.
059       * 
060       * @param texture - the texture
061       * @param anchor - the shape
062       */
063      public TexturePaint(BufferedImage texture, Rectangle2D anchor)
064      {
065        this.texture = texture;
066        this.anchor = anchor;
067      }
068    
069      /**
070       * Gets the texture image.
071       * 
072       * @return the texture
073       */
074      public BufferedImage getImage()
075      {
076        return texture;
077      }
078    
079      /**
080       * Gets the shape anchor.
081       * 
082       * @return the shape anchor
083       */
084      public Rectangle2D getAnchorRect()
085      {
086        return anchor;
087      }
088    
089      /**
090       * Creates the context used to paint the texture.
091       * 
092       * @param cm - the ColorModel that receives the Paint data. Used only as a hint.
093       * @param deviceBounds - the device space being rendered.
094       * @param userBounds - the user space being rendered
095       * @param xform - the AffineTransform from user space into device space
096       * @param hints - a RenderingHints object that is used to specify how the 
097       * pattern is rendered
098       * @return the paint context used to paint the texture
099       */
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