com.jme.ui
Class UIBillboard

java.lang.Object
  com.jme.scene.Spatial
      com.jme.scene.Node
          com.jme.ui.UIObject
              com.jme.ui.UIBillboard

All Implemented Interfaces:

java.io.Serializable

public class UIBillboard

extends UIObject

UIObject based class that displays an image on the screen in a Orthogonal way. Also has a couple of convienience methods to center the image in the screen and to change the width and height on the screen. The image file that is specified still needs to be sized by the standard texture power of 2 rule.

Author:

schustej

See Also:

Serialized Form

Field Summary

Fields inherited from class com.jme.ui.UIObject

_bottomborder, _height, _leftborder, _quad, _rightborder, _textureStates, _topborder, _width, _x, _y, BORDER, INVERSE_BORDER, TEXTURE

Fields inherited from class com.jme.scene.Node

children

Fields inherited from class com.jme.scene.Spatial

currentStates, defaultStateList, forceCull, forceView, frustrumIntersects, geometricalControllers, lightCombineMode, localRotation, localScale, localTranslation, name, parent, queueDistance, renderQueueMode, renderStateList, textureCombineMode, worldBound, worldRotation, worldScale, worldTranslation, zOrder

Constructor Summary

UIBillboard(java.lang.String name, int x, int y, int width, int height, java.lang.String imgfile)
Specific the image file to be shown.

UIBillboard(java.lang.String name, int x, int y, int width, int height, java.lang.String imgfile, int imageType)

UIBillboard(java.lang.String name, int x, int y, int width, int height, UIColorScheme scheme)

UIBillboard(java.lang.String name, int x, int y, int width, int height, UIColorScheme scheme, java.lang.String imgfile, int flags, boolean useClassLoader, int imageType)

Method Summary

void	center() Easy method that will center the image within the display.
void	setWrap(int wrap) Used to set the wrapping parameters.
boolean	update() Non-functionaly method since there is no user interaction with this object

Methods inherited from class com.jme.ui.UIObject

centerAt, getHeight, getWidth, setLocation, setup, usingBorders, usingInverseBorder, usingStdBorder, usingTexture

Methods inherited from class com.jme.scene.Node

applyRenderState, attachChild, detachAllChildren, detachChild, detachChildAt, detachChildNamed, draw, drawBounds, findCollisions, findPick, getChild, getChild, getChildren, getQuantity, hasChild, hasCollision, putClone, setChild, setForceView, updateCollisionTree, updateWorldBound, updateWorldData

Methods inherited from class com.jme.scene.Spatial

addController, applyDefaultStates, calculateCollisions, calculatePick, clearCurrentState, clearCurrentStates, clearRenderState, getController, getControllers, getCurrentState, getLastFrustumIntersection, getLightCombineMode, getLocalRotation, getLocalScale, getLocalTranslation, getName, getParent, getRenderQueueMode, getRenderStateList, getTextureCombineMode, getWorldBound, getWorldRotation, getWorldScale, getWorldTranslation, getZOrder, isForceCulled, isForceView, onDraw, onDrawBounds, propagateBoundToRoot, propagateStatesFromRoot, removeController, removeFromParent, setForceCull, setLightCombineMode, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalTranslation, setName, setParent, setRenderQueueMode, setRenderState, setTextureCombineMode, setWorldBound, setZOrder, toString, updateGeometricState, updateRenderState, updateRenderState

Methods inherited from class java.lang.Object

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

Constructor Detail

UIBillboard

public UIBillboard(java.lang.String name,
                   int x,
                   int y,
                   int width,
                   int height,
                   java.lang.String imgfile)

Specific the image file to be shown. Just like all objects in jME, name it with a unique name.

UIBillboard

public UIBillboard(java.lang.String name,
                   int x,
                   int y,
                   int width,
                   int height,
                   UIColorScheme scheme)

UIBillboard

public UIBillboard(java.lang.String name,
                   int x,
                   int y,
                   int width,
                   int height,
                   java.lang.String imgfile,
                   int imageType)

UIBillboard

public UIBillboard(java.lang.String name,
                   int x,
                   int y,
                   int width,
                   int height,
                   UIColorScheme scheme,
                   java.lang.String imgfile,
                   int flags,
                   boolean useClassLoader,
                   int imageType)

Method Detail

center

public void center()

Easy method that will center the image within the display.

setWrap

public void setWrap(int wrap)

Used to set the wrapping parameters. Use Texture.WM_* wrapping parameters.

update

public boolean update()

Non-functionaly method since there is no user interaction with this object