java.awt
Class TexturePaint

java.lang.Object
  |
  +--java.awt.TexturePaint

All Implemented Interfaces:

Paint, Transparency

public class TexturePaint

extends Object

implements Paint

Safe: The TexturePaint class provides a way to fill a Shape with a texture that is specified as a BufferedImage. The size of the BufferedImage object should be small because the BufferedImage data is copied by the TexturePaint object. At construction time, the texture is anchored to the upper left corner of a Rectangle2D that is specified in user space. Texture is computed for locations in the device space by conceptually replicating the specified Rectangle2D infinitely in all directions in user space and mapping the BufferedImage to each replicated Rectangle2D.

Version:

1.37, 12/03/01

See Also:

Paint, Graphics2D.setPaint(java.awt.Paint)

Field Summary

(package private) java.awt.image.BufferedImage	bufImg
(package private) double	sx
(package private) double	sy
(package private) double	tx
(package private) double	ty

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

TexturePaint(java.awt.image.BufferedImage txtr, java.awt.geom.Rectangle2D anchor)
Enabled: Constructs a TexturePaint object.

Method Summary

PaintContext	createContext(java.awt.image.ColorModel cm, Rectangle deviceBounds, java.awt.geom.Rectangle2D userBounds, java.awt.geom.AffineTransform xform, RenderingHints hints) Enabled: Creates and returns a context used to generate the color pattern.
java.awt.geom.Rectangle2D	getAnchorRect() Enabled: Returns a copy of the anchor rectangle which positions and sizes the textured image.
java.awt.image.BufferedImage	getImage() Enabled: Returns the BufferedImage texture used to fill the shapes.
int	getTransparency() Enabled: Returns the transparency mode for this TexturePaint.

Methods inherited from class java.lang.Object

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

Field Detail

bufImg

java.awt.image.BufferedImage bufImg

tx

double tx

ty

double ty

sx

double sx

sy

double sy

Constructor Detail

TexturePaint

public TexturePaint(java.awt.image.BufferedImage txtr,
                    java.awt.geom.Rectangle2D anchor)

Enabled: Constructs a TexturePaint object.

Parameters:

txtr - the BufferedImage object with the texture used for painting

anchor - the Rectangle2D in user space used to anchor and replicate the texture

Method Detail

getImage

public java.awt.image.BufferedImage getImage()

Enabled: Returns the BufferedImage texture used to fill the shapes.

Returns:

a BufferedImage.

getAnchorRect

public java.awt.geom.Rectangle2D getAnchorRect()

Enabled: Returns a copy of the anchor rectangle which positions and sizes the textured image.

Returns:

the Rectangle2D used to anchor and size this TexturePaint.

createContext

public PaintContext createContext(java.awt.image.ColorModel cm,
                                  Rectangle deviceBounds,
                                  java.awt.geom.Rectangle2D userBounds,
                                  java.awt.geom.AffineTransform xform,
                                  RenderingHints hints)

Enabled: Creates and returns a context used to generate the color pattern.

Specified by:

createContext in interface Paint

Parameters:

cm - the ColorModel that receives the Paint data. This is used only as a hint.

deviceBounds - the device space bounding box of the graphics primitive being rendered

userBounds - the user space bounding box of the graphics primitive being rendered

xform - the AffineTransform from user space into device space

hints - a RenderingHints object that can be used to specify how the pattern is ultimately rendered

Returns:

the PaintContext used for generating color patterns.

See Also:

PaintContext

getTransparency

public int getTransparency()

Enabled: Returns the transparency mode for this TexturePaint.

Specified by:

getTransparency in interface Transparency

Returns:

the transparency mode for this TexturePaint as an integer value.

See Also:

Transparency