org.xith3d.scenegraph.primitives
Class BackgroundImage

java.lang.Object
  extended by org.xith3d.render.RenderPass
      extended by org.xith3d.render.BackgroundRenderPass
          extended by org.xith3d.scenegraph.primitives.BackgroundImage
All Implemented Interfaces:
org.jagatoo.datatypes.Enableable, org.jagatoo.datatypes.NamableObject, org.jagatoo.datatypes.NamedObject

public class BackgroundImage
extends BackgroundRenderPass

A simple background image for the scene.
It covers the whole canvas.


Constructor Summary
BackgroundImage(java.lang.String texture, float aspectRatio)
           
BackgroundImage(Texture texture, float aspectRatio)
           
 
Method Summary
 Texture getTexture()
           
 void setTexture(java.lang.String texture)
          Sets the Texture of the background image.
 void setTexture(Texture texture)
          Sets the Texture of the background image.
 
Methods inherited from class org.xith3d.render.BackgroundRenderPass
createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createParallel, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, createPerspective, isFrustumCullingEnabled, setFrustumCullingEnabled
 
Methods inherited from class org.xith3d.render.RenderPass
addRenderCallback, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, create2D, createRenderBinProvider, freeOpenGLResources, freeOpenGLResources, getBranchGroup, getConfig, getName, getRenderBinProvider, getRenderCallbackNotifier, getRenderTarget, getShadowCasterLight, isClipperEnabled, isEnabled, isLayeredModeForced, isScissorEnabled, isUnlayeredModeForced, removeRenderCallback, setBranchGroup, setClipperEnabled, setConfig, setEnabled, setLayeredModeForced, setName, setRenderTarget, setScissorEnabled, setShadowCasterLight, setUnlayeredModeForced, switchWireframeMode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BackgroundImage

public BackgroundImage(Texture texture,
                       float aspectRatio)

BackgroundImage

public BackgroundImage(java.lang.String texture,
                       float aspectRatio)
Method Detail

setTexture

public void setTexture(Texture texture)
Sets the Texture of the background image.

Parameters:
texture -

setTexture

public void setTexture(java.lang.String texture)
Sets the Texture of the background image.

Parameters:
texture - the texture resource name (loaded without alpha channel)

getTexture

public Texture getTexture()
Returns:
the Texture of the background image