net.mumie.mathletfactory.util

Class CanvasImage

java.lang.Object

net.mumie.mathletfactory.util.CanvasImage

public class CanvasImage
extends java.lang.Object

This class is used to render an arbitrary image in a MMG2DCanvas(). The attribute isStatic declares that the image uses whether screen or world coordinates (i.e. counting from the top left corner of the canvas or going from canvas origin to positive infinity). Translating or scaling the canvas's view has therefore no effect on static images. Only non-static images are "embedded" in the world. The attribute isRepeating declares that the image will whether be repeated (at original size) over the defined width and height, or not. The attributes can be combined.

Author:

Markus Gronau

Document status:

finished

Constructor Summary

Constructors

Constructor and Description
CanvasImage()
CanvasImage(java.awt.image.BufferedImage img)
CanvasImage(java.awt.image.BufferedImage img, double x, double y, double width, double height, boolean isStatic, boolean isRepeating)
CanvasImage(java.lang.String location) Constructs a new CanvasImage that will be drawn at (0,0) in canvas coordinates.
CanvasImage(java.lang.String location, double x, double y) Constructs a new CanvasImage that will be drawn at (x,y) in canvas coordinates.
CanvasImage(java.lang.String location, double x, double y, double width, double height) Constructs a new CanvasImage that will be drawn at (x,y) in canvas coordinates.
CanvasImage(java.lang.String location, double x, double y, double width, double height, boolean isStatic, boolean isRepeating) Constructs a new CanvasImage that will be drawn at (x,y) in canvas-coordinates.

Method Summary

Methods

Modifier and Type	Method and Description
void	drawImage() Draws the image onto the canvas.
double[]	getCoordinates() Returns wheather the absolute or relative coordinates of the picture.
double	getDimensionRatio() Returns the ratio between width and height.
java.awt.image.BufferedImage	getImage() Returns the real image.
java.lang.String	getImageFileLocation() Returns the file location from where the image is loaded.
java.awt.Color	getPixelColor(int x, int y) Returns the color of the pixel with the specified (image) coordinates.
double[]	getSize()
boolean	isRepeating()
boolean	isStatic()
void	setCanvas(MMG2DCanvas canvas) Sets the canvas in which this CanvasImage will be drawn.
void	setCoordinates(double x, double y) Sets the absolute or relative coordinates of the image's left bottom corner.
void	setImage(java.awt.image.BufferedImage bi) Sets the real image.
void	setImage(java.lang.String loc) Loads and sets the image.
void	setPixelColor(java.awt.Color c, int x, int y) Sets the color of the pixel with the specified (image) coordinates.
void	setSize(double width, double height) Sets the size of this image.

Methods inherited from class java.lang.Object

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

Constructor Detail

CanvasImage

public CanvasImage(java.lang.String location)

Constructs a new CanvasImage that will be drawn at (0,0) in canvas coordinates. The source will be loaded from location.

CanvasImage

public CanvasImage(java.lang.String location,
           double x,
           double y)

Constructs a new CanvasImage that will be drawn at (x,y) in canvas coordinates. The source will be loaded from location.

CanvasImage

public CanvasImage(java.lang.String location,
           double x,
           double y,
           double width,
           double height)

Constructs a new CanvasImage that will be drawn at (x,y) in canvas coordinates. It will be resized to fit the specified size. Setting the width and height to zero will restore the images original size. The source will be loaded from location.

CanvasImage

public CanvasImage(java.lang.String location,
           double x,
           double y,
           double width,
           double height,
           boolean isStatic,
           boolean isRepeating)

Constructs a new CanvasImage that will be drawn at (x,y) in canvas-coordinates. Setting the width and height to zero will restore the image's original size. The source will be loaded from location.

CanvasImage

public CanvasImage()

CanvasImage

public CanvasImage(java.awt.image.BufferedImage img)

CanvasImage

public CanvasImage(java.awt.image.BufferedImage img,
           double x,
           double y,
           double width,
           double height,
           boolean isStatic,
           boolean isRepeating)

Method Detail

setImage

public void setImage(java.lang.String loc)

Loads and sets the image.

setImage

public void setImage(java.awt.image.BufferedImage bi)

Sets the real image.

getImage

public java.awt.image.BufferedImage getImage()

Returns the real image.

getImageFileLocation

public java.lang.String getImageFileLocation()

Returns the file location from where the image is loaded.

Returns:

the file location or null if this CanvasImage was initialized with a BufferedImage instead of a file location

getCoordinates

public double[] getCoordinates()

Returns wheather the absolute or relative coordinates of the picture.

setCoordinates

public void setCoordinates(double x,
                  double y)

Sets the absolute or relative coordinates of the image's left bottom corner.

setSize

public void setSize(double width,
           double height)

Sets the size of this image. The sizes will be stored as absolute or relative values depending on the images type (static or not).

getSize

public double[] getSize()

isStatic

public boolean isStatic()

isRepeating

public boolean isRepeating()

drawImage

public void drawImage()

Draws the image onto the canvas. If the image is null (i.e. the image file could not be found) or the canvas is null, the method does nothing.

setPixelColor

public void setPixelColor(java.awt.Color c,
                 int x,
                 int y)

Sets the color of the pixel with the specified (image) coordinates.

getPixelColor

public java.awt.Color getPixelColor(int x,
                           int y)

Returns the color of the pixel with the specified (image) coordinates.

getDimensionRatio

public double getDimensionRatio()

Returns the ratio between width and height. Calculation: height = width * ratio (i.e. y = x * r)

setCanvas

public void setCanvas(MMG2DCanvas canvas)

Sets the canvas in which this CanvasImage will be drawn. Must be called before the image will be drawn the first time.