Class SimpleRenderedImage
- java.lang.Object
-
- org.apache.batik.ext.awt.image.codec.util.SimpleRenderedImage
-
- All Implemented Interfaces:
java.awt.image.RenderedImage
- Direct Known Subclasses:
PNGImage,SingleTileRenderedImage
public abstract class SimpleRenderedImage extends java.lang.Object implements java.awt.image.RenderedImageA simple class implemented theRenderedImageinterface. Only thegetTile()method needs to be implemented by subclasses. The instance variables must also be filled in properly.Normally in JAI
PlanarImageis used for this purpose, but in the interest of modularity the use ofPlanarImagehas been avoided.- Version:
- $Id: SimpleRenderedImage.java 1804130 2017-08-04 14:41:11Z ssteiner $
-
-
Field Summary
Fields Modifier and Type Field Description protected java.awt.image.ColorModelcolorModelThe image's ColorModel.protected intheightThe image's height in pixels.protected intminXThe X coordinate of the image's upper-left pixel.protected intminYThe Y coordinate of the image's upper-left pixel.protected java.util.MappropertiesA Hashtable containing the image properties.protected java.awt.image.SampleModelsampleModelThe image's SampleModel.protected java.util.ListsourcesThe image's sources, stored in a Vector.protected inttileGridXOffsetThe X coordinate of the upper-left pixel of tile (0, 0).protected inttileGridYOffsetThe Y coordinate of the upper-left pixel of tile (0, 0).protected inttileHeightThe height of a tile.protected inttileWidthThe width of a tile.protected intwidthThe image's width in pixels.
-
Constructor Summary
Constructors Constructor Description SimpleRenderedImage()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.image.WritableRastercopyData(java.awt.image.WritableRaster dest)Copies an arbitrary rectangular region of the RenderedImage into a caller-supplied WritableRaster.java.awt.RectanglegetBounds()Returns a Rectangle indicating the image bounds.java.awt.image.ColorModelgetColorModel()Returns the ColorModel of the image.java.awt.image.RastergetData()Returns the entire image in a single Raster.java.awt.image.RastergetData(java.awt.Rectangle bounds)Returns an arbitrary rectangular region of the RenderedImage in a Raster.intgetHeight()Returns the height of the image.intgetMaxTileX()Returns the horizontal index of the rightmost column of tiles.intgetMaxTileY()Returns the vertical index of the bottom row of tiles.intgetMaxX()Returns the X coordinate of the column immediatetely to the right of the rightmost column of the image.intgetMaxY()Returns the Y coordinate of the row immediately below the bottom row of the image.intgetMinTileX()Returns the horizontal index of the leftmost column of tiles.intgetMinTileY()Returns the vertical index of the uppermost row of tiles.intgetMinX()Returns the X coordinate of the leftmost column of the image.intgetMinY()Returns the X coordinate of the uppermost row of the image.intgetNumXTiles()Returns the number of tiles along the tile grid in the horizontal direction.intgetNumYTiles()Returns the number of tiles along the tile grid in the vertical direction.java.lang.ObjectgetProperty(java.lang.String name)Gets a property from the property set of this image.java.lang.String[]getPropertyNames()Returns a list of the properties recognized by this image.java.lang.String[]getPropertyNames(java.lang.String prefix)Returns an array ofStrings recognized as names by this property source that begin with the supplied prefix.java.awt.image.SampleModelgetSampleModel()Returns the SampleModel of the image.java.util.VectorgetSources()intgetTileGridXOffset()Returns the X coordinate of the upper-left pixel of tile (0, 0).intgetTileGridYOffset()Returns the Y coordinate of the upper-left pixel of tile (0, 0).intgetTileHeight()Returns the height of a tile.intgetTileWidth()Returns the width of a tile.intgetWidth()Returns the width of the image.inttileXToX(int tx)Converts a horizontal tile index into the X coordinate of its upper left pixel.static inttileXToX(int tx, int tileGridXOffset, int tileWidth)Converts a horizontal tile index into the X coordinate of its upper left pixel relative to a given tile grid layout specified by its X offset and tile width.inttileYToY(int ty)Converts a vertical tile index into the Y coordinate of its upper left pixel.static inttileYToY(int ty, int tileGridYOffset, int tileHeight)Converts a vertical tile index into the Y coordinate of its upper left pixel relative to a given tile grid layout specified by its Y offset and tile height.intXToTileX(int x)Converts a pixel's X coordinate into a horizontal tile index.static intXToTileX(int x, int tileGridXOffset, int tileWidth)Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.intYToTileY(int y)Converts a pixel's Y coordinate into a vertical tile index.static intYToTileY(int y, int tileGridYOffset, int tileHeight)Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.
-
-
-
Field Detail
-
minX
protected int minX
The X coordinate of the image's upper-left pixel.
-
minY
protected int minY
The Y coordinate of the image's upper-left pixel.
-
width
protected int width
The image's width in pixels.
-
height
protected int height
The image's height in pixels.
-
tileWidth
protected int tileWidth
The width of a tile.
-
tileHeight
protected int tileHeight
The height of a tile.
-
tileGridXOffset
protected int tileGridXOffset
The X coordinate of the upper-left pixel of tile (0, 0).
-
tileGridYOffset
protected int tileGridYOffset
The Y coordinate of the upper-left pixel of tile (0, 0).
-
sampleModel
protected java.awt.image.SampleModel sampleModel
The image's SampleModel.
-
colorModel
protected java.awt.image.ColorModel colorModel
The image's ColorModel.
-
sources
protected java.util.List sources
The image's sources, stored in a Vector.
-
properties
protected java.util.Map properties
A Hashtable containing the image properties.
-
-
Method Detail
-
getMinX
public int getMinX()
Returns the X coordinate of the leftmost column of the image.- Specified by:
getMinXin interfacejava.awt.image.RenderedImage
-
getMaxX
public final int getMaxX()
Returns the X coordinate of the column immediatetely to the right of the rightmost column of the image. getMaxX() is implemented in terms of getMinX() and getWidth() and so does not need to be implemented by subclasses.
-
getMinY
public int getMinY()
Returns the X coordinate of the uppermost row of the image.- Specified by:
getMinYin interfacejava.awt.image.RenderedImage
-
getMaxY
public final int getMaxY()
Returns the Y coordinate of the row immediately below the bottom row of the image. getMaxY() is implemented in terms of getMinY() and getHeight() and so does not need to be implemented by subclasses.
-
getWidth
public int getWidth()
Returns the width of the image.- Specified by:
getWidthin interfacejava.awt.image.RenderedImage
-
getHeight
public int getHeight()
Returns the height of the image.- Specified by:
getHeightin interfacejava.awt.image.RenderedImage
-
getBounds
public java.awt.Rectangle getBounds()
Returns a Rectangle indicating the image bounds.
-
getTileWidth
public int getTileWidth()
Returns the width of a tile.- Specified by:
getTileWidthin interfacejava.awt.image.RenderedImage
-
getTileHeight
public int getTileHeight()
Returns the height of a tile.- Specified by:
getTileHeightin interfacejava.awt.image.RenderedImage
-
getTileGridXOffset
public int getTileGridXOffset()
Returns the X coordinate of the upper-left pixel of tile (0, 0).- Specified by:
getTileGridXOffsetin interfacejava.awt.image.RenderedImage
-
getTileGridYOffset
public int getTileGridYOffset()
Returns the Y coordinate of the upper-left pixel of tile (0, 0).- Specified by:
getTileGridYOffsetin interfacejava.awt.image.RenderedImage
-
getMinTileX
public int getMinTileX()
Returns the horizontal index of the leftmost column of tiles. getMinTileX() is implemented in terms of getMinX() and so does not need to be implemented by subclasses.- Specified by:
getMinTileXin interfacejava.awt.image.RenderedImage
-
getMaxTileX
public int getMaxTileX()
Returns the horizontal index of the rightmost column of tiles. getMaxTileX() is implemented in terms of getMaxX() and so does not need to be implemented by subclasses.
-
getNumXTiles
public int getNumXTiles()
Returns the number of tiles along the tile grid in the horizontal direction. getNumXTiles() is implemented in terms of getMinTileX() and getMaxTileX() and so does not need to be implemented by subclasses.- Specified by:
getNumXTilesin interfacejava.awt.image.RenderedImage
-
getMinTileY
public int getMinTileY()
Returns the vertical index of the uppermost row of tiles. getMinTileY() is implemented in terms of getMinY() and so does not need to be implemented by subclasses.- Specified by:
getMinTileYin interfacejava.awt.image.RenderedImage
-
getMaxTileY
public int getMaxTileY()
Returns the vertical index of the bottom row of tiles. getMaxTileY() is implemented in terms of getMaxY() and so does not need to be implemented by subclasses.
-
getNumYTiles
public int getNumYTiles()
Returns the number of tiles along the tile grid in the vertical direction. getNumYTiles() is implemented in terms of getMinTileY() and getMaxTileY() and so does not need to be implemented by subclasses.- Specified by:
getNumYTilesin interfacejava.awt.image.RenderedImage
-
getSampleModel
public java.awt.image.SampleModel getSampleModel()
Returns the SampleModel of the image.- Specified by:
getSampleModelin interfacejava.awt.image.RenderedImage
-
getColorModel
public java.awt.image.ColorModel getColorModel()
Returns the ColorModel of the image.- Specified by:
getColorModelin interfacejava.awt.image.RenderedImage
-
getProperty
public java.lang.Object getProperty(java.lang.String name)
Gets a property from the property set of this image. If the property name is not recognized,nullwill be returned.- Specified by:
getPropertyin interfacejava.awt.image.RenderedImage- Parameters:
name- the name of the property to get, as aString.- Returns:
- a reference to the property
Object, or the valuenull
-
getPropertyNames
public java.lang.String[] getPropertyNames()
Returns a list of the properties recognized by this image. If no properties are available, an empty String[] will be returned.- Specified by:
getPropertyNamesin interfacejava.awt.image.RenderedImage- Returns:
- an array of
Strings representing valid property names.
-
getPropertyNames
public java.lang.String[] getPropertyNames(java.lang.String prefix)
Returns an array ofStrings recognized as names by this property source that begin with the supplied prefix. If no property names match,nullwill be returned. The comparison is done in a case-independent manner.The default implementation calls
getPropertyNames()and searches the list of names for matches.- Returns:
- an array of
Strings giving the valid property names (can be null).
-
XToTileX
public static int XToTileX(int x, int tileGridXOffset, int tileWidth)Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.
-
YToTileY
public static int YToTileY(int y, int tileGridYOffset, int tileHeight)Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.
-
XToTileX
public int XToTileX(int x)
Converts a pixel's X coordinate into a horizontal tile index. This is a convenience method. No attempt is made to detect out-of-range coordinates.- Parameters:
x- the X coordinate of a pixel.- Returns:
- the X index of the tile containing the pixel.
-
YToTileY
public int YToTileY(int y)
Converts a pixel's Y coordinate into a vertical tile index. This is a convenience method. No attempt is made to detect out-of-range coordinates.- Parameters:
y- the Y coordinate of a pixel.- Returns:
- the Y index of the tile containing the pixel.
-
tileXToX
public static int tileXToX(int tx, int tileGridXOffset, int tileWidth)Converts a horizontal tile index into the X coordinate of its upper left pixel relative to a given tile grid layout specified by its X offset and tile width.
-
tileYToY
public static int tileYToY(int ty, int tileGridYOffset, int tileHeight)Converts a vertical tile index into the Y coordinate of its upper left pixel relative to a given tile grid layout specified by its Y offset and tile height.
-
tileXToX
public int tileXToX(int tx)
Converts a horizontal tile index into the X coordinate of its upper left pixel. This is a convenience method. No attempt is made to detect out-of-range indices.- Parameters:
tx- the horizontal index of a tile.- Returns:
- the X coordinate of the tile's upper left pixel.
-
tileYToY
public int tileYToY(int ty)
Converts a vertical tile index into the Y coordinate of its upper left pixel. This is a convenience method. No attempt is made to detect out-of-range indices.- Parameters:
ty- the vertical index of a tile.- Returns:
- the Y coordinate of the tile's upper left pixel.
-
getSources
public java.util.Vector getSources()
- Specified by:
getSourcesin interfacejava.awt.image.RenderedImage
-
getData
public java.awt.image.Raster getData()
Returns the entire image in a single Raster. For images with multiple tiles this will require making a copy.The returned Raster is semantically a copy. This means that updates to the source image will not be reflected in the returned Raster. For non-writable (immutable) source images, the returned value may be a reference to the image's internal data. The returned Raster should be considered non-writable; any attempt to alter its pixel data (such as by casting it to WritableRaster or obtaining and modifying its DataBuffer) may result in undefined behavior. The copyData method should be used if the returned Raster is to be modified.
- Specified by:
getDatain interfacejava.awt.image.RenderedImage- Returns:
- a Raster containing a copy of this image's data.
-
getData
public java.awt.image.Raster getData(java.awt.Rectangle bounds)
Returns an arbitrary rectangular region of the RenderedImage in a Raster. The rectangle of interest will be clipped against the image bounds.The returned Raster is semantically a copy. This means that updates to the source image will not be reflected in the returned Raster. For non-writable (immutable) source images, the returned value may be a reference to the image's internal data. The returned Raster should be considered non-writable; any attempt to alter its pixel data (such as by casting it to WritableRaster or obtaining and modifying its DataBuffer) may result in undefined behavior. The copyData method should be used if the returned Raster is to be modified.
- Specified by:
getDatain interfacejava.awt.image.RenderedImage- Parameters:
bounds- the region of the RenderedImage to be returned.
-
copyData
public java.awt.image.WritableRaster copyData(java.awt.image.WritableRaster dest)
Copies an arbitrary rectangular region of the RenderedImage into a caller-supplied WritableRaster. The region to be computed is determined by clipping the bounds of the supplied WritableRaster against the bounds of the image. The supplied WritableRaster must have a SampleModel that is compatible with that of the image.If the raster argument is null, the entire image will be copied into a newly-created WritableRaster with a SampleModel that is compatible with that of the image.
- Specified by:
copyDatain interfacejava.awt.image.RenderedImage- Parameters:
dest- a WritableRaster to hold the returned portion of the image.- Returns:
- a reference to the supplied WritableRaster, or to a new WritableRaster if the supplied one was null.
-
-