Package com.bc.ceres.swing.figure.support

Class ImageSymbol

java.lang.Object

com.bc.ceres.swing.figure.support.ImageSymbol

All Implemented Interfaces:

Symbol

public class ImageSymbol
extends Object
implements Symbol

A symbol that uses an icon image.

Since:

Ceres 0.13

Method Summary

Modifier and Type	Method	Description
static ImageSymbol	createIcon(String imageResourcePath)
static ImageSymbol	createIcon(String imageResourcePath, double refX, double refY)
static ImageSymbol	createIcon(String imageResourcePath, double refX, double refY, Class callerClass)
static ImageSymbol	createIcon(String imageResourcePath, Class callerClass)
void	draw(Rendering rendering, FigureStyle style)	Draws the symbol on the given rendering using the given style.
Rectangle2D	getBounds()	The bounds of the symbol.
BufferedImage	getImage()
double	getRefX()
double	getRefY()
String	getResourcePath()
boolean	isHitBy(double x, double y)	Tests weather this symbol is hit by the given point.

Methods inherited from class java.lang.Object

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

Method Detail

createIcon

public static ImageSymbol createIcon(String imageResourcePath)

createIcon

public static ImageSymbol createIcon(String imageResourcePath,
                                     Class callerClass)

createIcon

public static ImageSymbol createIcon(String imageResourcePath,
                                     double refX,
                                     double refY)

createIcon

public static ImageSymbol createIcon(String imageResourcePath,
                                     double refX,
                                     double refY,
                                     Class callerClass)

getResourcePath

public String getResourcePath()

getImage

public BufferedImage getImage()

getRefX

public double getRefX()

Returns:

The X-coordinate of the reference point.

getRefY

public double getRefY()

Returns:

The Y-coordinate of the reference point.

draw

public void draw(Rendering rendering,
                 FigureStyle style)

Description copied from interface: Symbol

Draws the symbol on the given rendering using the given style. The rendering's graphics is transformed so that drawing can be done directly in symbol coordinates using view units, e.g.

     rendering.getGraphics().draw(symbolShape);
 

or

     rendering.getGraphics().drawRenderedImage(symbolImage, null);
 

Specified by:

draw in interface Symbol

Parameters:

rendering - The rendering.

style - The style.

isHitBy

public boolean isHitBy(double x,
                       double y)

Description copied from interface: Symbol

Tests weather this symbol is hit by the given point.

Specified by:

isHitBy in interface Symbol

Parameters:

x - The X-coordinate of the point in symbol coordinates using view units.

y - The Y-coordinate of the point in symbol coordinates using view units.

Returns:

true, if so.

getBounds

public Rectangle2D getBounds()

Description copied from interface: Symbol

The bounds of the symbol.

Specified by:

getBounds in interface Symbol

Returns:

The bounds of the symbol in symbol coordinates using view units.