ImageCache Class Reference

List of all members.

Public Member Functions

void addBufferedImageToCache (final File pathToImage, BufferedImage bImg)
 Use this only if you need to explicitly add something to the cache.
BufferedImage getBufferedImage (File pathToImage)
 Normally, just call this function to get a BufferedImage and put it in the cache.
PlanarImage getPlanarImage (File pathToImage)

Static Public Member Functions

static ImageCache getInstance ()
static BufferedImage loadBufferedImage (File path)
static BufferedImage loadBufferedImage (URL resource)
static PlanarImage loadPlanarImage (File path)

Classes

class  ImageObject

Detailed Description

This software is distributed under the BSD License.

Author:
Ron B Yeh (ronyeh(AT)cs.stanford.edu)

Definition at line 23 of file ImageCache.java.


Member Function Documentation

void addBufferedImageToCache ( final File  pathToImage,
BufferedImage  bImg 
)

Use this only if you need to explicitly add something to the cache.

Usually, you do NOT need to use this function.

Parameters:
File 

Definition at line 137 of file ImageCache.java.

References ImageCache.ImageObject.setBufferedImage().

BufferedImage getBufferedImage ( File  pathToImage  ) 

Normally, just call this function to get a BufferedImage and put it in the cache.

Set your hard references to null when you are done.

Parameters:
pathToImage 
Returns:

Definition at line 167 of file ImageCache.java.

References ImageCache.ImageObject.getBufferedImage().

Referenced by ImageCache.loadBufferedImage().

PlanarImage getPlanarImage ( File  pathToImage  ) 

Parameters:
pathToImage 
Returns:

Definition at line 175 of file ImageCache.java.

References ImageCache.ImageObject.getPlanarImage().

Referenced by ImageCache.loadPlanarImage().

static BufferedImage loadBufferedImage ( URL  resource  )  [static]

Parameters:
resource Allows you to get images from the JAR.
Returns:

Definition at line 107 of file ImageCache.java.

References ImageCache.getBufferedImage(), and ImageCache.getInstance().

static BufferedImage loadBufferedImage ( File  path  )  [static]

Parameters:
path 
Returns:

Definition at line 98 of file ImageCache.java.

References ImageCache.getBufferedImage(), and ImageCache.getInstance().

static PlanarImage loadPlanarImage ( File  path  )  [static]

Parameters:
path 
Returns:

Definition at line 120 of file ImageCache.java.

References ImageCache.getInstance(), and ImageCache.getPlanarImage().


The documentation for this class was generated from the following file:
Generated on Sat Apr 14 18:21:46 2007 for R3 Paper Toolkit by  doxygen 1.4.7