org.j3d.aviatrix3d
Class ImageBackground

java.lang.Object
  org.j3d.aviatrix3d.SceneGraphObject
      org.j3d.aviatrix3d.Node
          org.j3d.aviatrix3d.Leaf
              org.j3d.aviatrix3d.Background
                  org.j3d.aviatrix3d.ImageBackground

All Implemented Interfaces:

java.lang.Comparable, BackgroundRenderable, Cullable, EnvironmentCullable, ObjectRenderable, Renderable

public class ImageBackground
extends Background

Background node for 2D scenes that draws an image on screen as the background.

This will set the background colour to a single colour for the entire viewport and then draw the image over the top of the colour, including blending any transparency. The image may be scaled or not to fit the window or it may be repeated without scale, to cover the entire viewport. If used, this will override the setClearColor() on GraphicsOutputDevice. Note that if the user has turned the useClearColor flag off in the base class, that this node effectively will do nothing.

Version:

$Revision: 2.2 $

Author:

Justin Couch

Field Summary

Fields inherited from class org.j3d.aviatrix3d.Background

color, dispListMap, INVALID_ALPHA_PROP, INVALID_BLUE_PROP, INVALID_GREEN_PROP, INVALID_RED_PROP, useClearColor

Fields inherited from class org.j3d.aviatrix3d.Node

bounds, implicitBounds, INVALID_BOUNDS, parent

Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject

alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler

Constructor Summary

ImageBackground()
Constructs a background node for a base colour of black and no image set.

ImageBackground(float[] c)
Construct a background node for a user-provided colour.

Method Summary

int	compareTo(ImageBackground bg) Compares this object with the specified object for order.
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
boolean	equals(ImageBackground bg) Compares this object with the specified object to check for equivalence.
boolean	equals(java.lang.Object o) Compare this object for equality to the given object.
boolean	is2D() Check to see whether this shape is something that represents 2D or 3D renderable background.
void	postRender(javax.media.opengl.GL gl) Restore all openGL state to the given drawable.
void	render(javax.media.opengl.GL gl) Issue ogl commands needed for this component

Methods inherited from class org.j3d.aviatrix3d.Background

compareColor4, equalsColor4, getColor, getCullableParent, getRenderable, isColorClearEnabled, markBoundsDirty, setColor, setColor, setColorClearEnabled

Methods inherited from class org.j3d.aviatrix3d.Node

boundsChanged, checkForCyclicParent, getBounds, getParent, recomputeBounds, removeParent, requestBoundsUpdate, setBounds, setParent, updateBounds, updateParentBounds

Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject

checkForCyclicChild, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setLive, setUpdateHandler, setUserData

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageBackground

public ImageBackground()

Constructs a background node for a base colour of black and no image set.

ImageBackground

public ImageBackground(float[] c)
                throws java.lang.IllegalArgumentException

Construct a background node for a user-provided colour. The colour provided should have 3 or 4 elements. If 3 are provided, a fully opaque background is assumed. If less than 3 elements are provided, an exception is generated. If the array is null, this assumes the a default black background.

Parameters:

c - The array of colours to use, or null

Throws:

java.lang.IllegalArgumentException - The colour array is not long enough

Method Detail

is2D

public boolean is2D()

Check to see whether this shape is something that represents 2D or 3D renderable background. Pure 2D backgrounds do not need transformation stacks or frustums set up to render - they can blit straight to the screen as needed.

Returns:

True if this is 2D background, false if this is 3D

render

public void render(javax.media.opengl.GL gl)

Issue ogl commands needed for this component

Parameters:

gl - The gl context to draw with

postRender

public void postRender(javax.media.opengl.GL gl)

Restore all openGL state to the given drawable.

Parameters:

gl - The gl context to draw with

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:

o - The objec to be compared

Returns:

-1, 0 or 1 depending on order

Throws:

java.lang.ClassCastException - The specified object's type prevents it from being compared to this Object

equals

public boolean equals(java.lang.Object o)

Compare this object for equality to the given object.

Specified by:

equals in interface Renderable

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to be compared

Returns:

True if these represent the same values

compareTo

public int compareTo(ImageBackground bg)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:

bg - The argument instance to be compared

Returns:

-1, 0 or 1 depending on order

equals

public boolean equals(ImageBackground bg)

Compares this object with the specified object to check for equivalence.

Parameters:

bg - The background instance to be compared

Returns:

true if the objects represent identical values