jahuwaldt.j3d

Class BGFGCanvas3D

java.lang.Object

Canvas3D

jahuwaldt.j3d.ImageCaptureCanvas3D

jahuwaldt.j3d.BGFGCanvas3D

Direct Known Subclasses:

GeomSSCanvas3D

public class BGFGCanvas3D
extends ImageCaptureCanvas3D

BGFGCanvas3D is a Canvas3D that renders an list of arbitrary 2D BGFGImage objects either behind or over top of the 3D scene. This canvas also provides a callback that allows you to capture the contents of the canvas and write out the image information.

Modified by: Joseph A.Huwaldt

Version:

September 16, 2016

Author:

Joseph A. Huwaldt, Date: April 9, 2009

Constructor Summary

Constructors

Constructor and Description
BGFGCanvas3D(java.awt.GraphicsConfiguration gconfig) Constructs and initializes a new BGFGCanvas3D object that Java 3D can render into.
BGFGCanvas3D(java.awt.GraphicsConfiguration gconfig, boolean offscreen) Constructs and initializes a new BGFGCanvas3D object that Java 3D can render into.

Method Summary

Modifier and Type	Method and Description
void	addBackground(BGFGImage background) Adds the specified background to this canvas.
void	addOverlay(BGFGImage overlay) Adds the specified overlay to this canvas.
void	clearBackgrounds() Removes all the backgrounds from this canvas.
void	clearOverlays() Removes all the overlays from this canvas.
BGFGImage	getBackground(int index) Return the specified background used by this canvas.
int	getNumberBackgrounds() Returns the number of background images associated with this canvas.
int	getNumberOverlays() Returns the number of overlays/foregrounds associated with this canvas.
BGFGImage	getOverlay(int index) Return the specified overlay used by this canvas.
void	postRender() This routine is called by the Java 3D rendering loop after completing all rendering to the canvas for this frame and before the buffer swap.
void	preRender() This routine is called by the Java 3D rendering loop after clearing the canvas and before any rendering has been done for this frame.
boolean	removeBackground(BGFGImage background) Removes the specified background from this canvas.
BGFGImage	removeBackground(int index) Removes the specified background from this canvas.
boolean	removeOverlay(BGFGImage overlay) Removes the specified overlay from this canvas.
BGFGImage	removeOverlay(int index) Removes the specified overlay from this canvas.
BGFGImage	setBackground(int index, BGFGImage background) Set the specified background for use for this canvas.
BGFGImage	setOverlay(int index, BGFGImage overlay) Set the specified overlay for use for this canvas.

Methods inherited from class jahuwaldt.j3d.ImageCaptureCanvas3D

addCaptureObserver, postSwap, removeCaptureObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

BGFGCanvas3D

public BGFGCanvas3D(java.awt.GraphicsConfiguration gconfig)

Constructs and initializes a new BGFGCanvas3D object that Java 3D can render into.

Parameters:

gconfig - A valid GraphicsConfiguration object that will be used to create the canvas. May not be null.

Throws:

java.lang.IllegalArgumentException - if the specified GraphicsConfiguration does not support 3D rendering

BGFGCanvas3D

public BGFGCanvas3D(java.awt.GraphicsConfiguration gconfig,
                    boolean offscreen)

Constructs and initializes a new BGFGCanvas3D object that Java 3D can render into.

Parameters:

gconfig - A valid GraphicsConfiguration object that will be used to create the canvas. May not be null.

offscreen - A flag that indicates whether this canvas is an off-screen 3D rendering canvas. Note that if offScreen is set to true, this Canvas3D object cannot be used for normal rendering; it should not be added to any Container object.

Throws:

java.lang.IllegalArgumentException - if the specified GraphicsConfiguration does not support 3D rendering

Method Detail

getNumberBackgrounds

public int getNumberBackgrounds()

Returns the number of background images associated with this canvas.

Returns:

The number of background images.

getBackground

public BGFGImage getBackground(int index)

Return the specified background used by this canvas.

Parameters:

index - The index of the background image to retrieve.

Returns:

The background image at the specified index.

setBackground

public BGFGImage setBackground(int index,
                               BGFGImage background)

Set the specified background for use for this canvas.

Parameters:

index - The index for the background to set.

background - The background image to set at the specified index. May not be null.

Returns:

The image that was at the specified index location.

addBackground

public void addBackground(BGFGImage background)

Adds the specified background to this canvas.

Parameters:

background - The background to add to this canvas. May not be null.

removeBackground

public BGFGImage removeBackground(int index)

Removes the specified background from this canvas.

Parameters:

index - The index for the background to remove.

Returns:

The image that used to be at the specified index.

removeBackground

public boolean removeBackground(BGFGImage background)

Removes the specified background from this canvas.

Parameters:

background - The background to remove from this canvas. May not be null.

Returns:

true if this canvas contained the specified background image.

clearBackgrounds

public void clearBackgrounds()

Removes all the backgrounds from this canvas.

getNumberOverlays

public int getNumberOverlays()

Returns the number of overlays/foregrounds associated with this canvas.

Returns:

The number of overlays.

getOverlay

public BGFGImage getOverlay(int index)

Return the specified overlay used by this canvas.

Parameters:

index - The index of the overlay (foreground) to return.

Returns:

The overlay/foreground image at the specified index.

setOverlay

public BGFGImage setOverlay(int index,
                            BGFGImage overlay)

Set the specified overlay for use for this canvas.

Parameters:

index - The index for the overlay to set.

overlay - The overlay to set at the specified index location. May not be null.

Returns:

The image that was at the specified index location.

addOverlay

public void addOverlay(BGFGImage overlay)

Adds the specified overlay to this canvas.

Parameters:

overlay - The overlay to add. May not be null.

removeOverlay

public BGFGImage removeOverlay(int index)

Removes the specified overlay from this canvas.

Parameters:

index - The index for the overlay to remove.

Returns:

The image that used to be at the specified index.

removeOverlay

public boolean removeOverlay(BGFGImage overlay)

Removes the specified overlay from this canvas.

Parameters:

overlay - The overlay image to remove from this canvas. May not be null.

Returns:

true if this canvas contained the specified overlay/foreground image.

clearOverlays

public void clearOverlays()

Removes all the overlays from this canvas.

preRender

public void preRender()

This routine is called by the Java 3D rendering loop after clearing the canvas and before any rendering has been done for this frame. This implementation renders any background images onto the canvas. Note that BGFGImage.getImage() is always called before getImageX() or getImageY().

postRender

public void postRender()

This routine is called by the Java 3D rendering loop after completing all rendering to the canvas for this frame and before the buffer swap. This implementation renders any overlay images onto the canvas. Note that BGFGImage.getImage() is always called before getImageX() or getImageY().