jahuwaldt.j3d

Interface BGFGImage

public interface BGFGImage

The interface in common to any objects that provide a background or foreground (overlay) image to render behind or on top of a BGFGCanvas3D.

Modified by: Joseph A.Huwaldt

Version:

September 16, 2016

Author:

Joseph A. Huwaldt, Date: April 9, 2009

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getImage() Returns a BufferedImage containing the background or overlay to be displayed in a BGFGCanvas3D canvas either behind or over top of the 3D scene or returns null for no image.
int	getImageX() Returns the X coordinate location on the canvas where the upper-left corner of the buffered image should be drawn.
int	getImageY() Returns the Y coordinate location on the canvas where the upper-left corner of the buffered image should be drawn.

Method Detail

getImage

java.awt.image.BufferedImage getImage()

Returns a BufferedImage containing the background or overlay to be displayed in a BGFGCanvas3D canvas either behind or over top of the 3D scene or returns null for no image.

Returns:

The background or overlay image.

getImageX

int getImageX()

Returns the X coordinate location on the canvas where the upper-left corner of the buffered image should be drawn.

Returns:

X-coordinate of the upper-left corner of the image on the canvas.

getImageY

int getImageY()

Returns the Y coordinate location on the canvas where the upper-left corner of the buffered image should be drawn.

Returns:

Y-coordinate of the upper-left corner of the image on the canvas.