com.jme3.ui
Class Picture

java.lang.Object
  extended by com.jme3.scene.Spatial
      extended by com.jme3.scene.Geometry
          extended by com.jme3.ui.Picture
All Implemented Interfaces:
CloneableSmartAsset, Collidable, Savable, java.lang.Cloneable

public class Picture
extends Geometry

A Picture represents a 2D image drawn on the screen. It can be used to represent sprites or other background elements.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.jme3.scene.Spatial
Spatial.BatchHint, Spatial.CullHint
 
Field Summary
 
Fields inherited from class com.jme3.scene.Geometry
batchNode, cachedOffsetMat, cachedWorldMat, ignoreTransform, lodLevel, material, mesh, prevBatchTransforms, SAVABLE_VERSION, startIndex
 
Fields inherited from class com.jme3.scene.Spatial
batchHint, controls, cullHint, frustrumIntersects, key, localLights, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_LIGHTLIST, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldTransform
 
Constructor Summary
Picture()
           
Picture(java.lang.String name)
          Creates a named picture.
Picture(java.lang.String name, boolean flipY)
          Create a named picture.
 
Method Summary
 void setHeight(float height)
          Set the height in pixels of the picture, if the height does not match the texture's height, then the texture will be scaled to fit the picture.
 void setImage(AssetManager assetManager, java.lang.String imgName, boolean useAlpha)
          Set the image to put on the picture.
 void setPosition(float x, float y)
          Set the position of the picture in pixels.
 void setTexture(AssetManager assetManager, Texture2D tex, boolean useAlpha)
          Set the texture to put on the picture.
 void setWidth(float width)
          Set the width in pixels of the picture, if the width does not match the texture's width, then the texture will be scaled to fit the picture.
 
Methods inherited from class com.jme3.scene.Geometry
batch, breadthFirstTraversal, clone, clone, collideWith, computeOffsetTransform, computeWorldMatrix, deepClone, depthFirstTraversal, getLodLevel, getMaterial, getMesh, getModelBound, getTriangleCount, getVertexCount, getWorldMatrix, isBatched, isIgnoreTransform, read, removeFromParent, setIgnoreTransform, setLodLevel, setMaterial, setMesh, setModelBound, setParent, unBatch, updateModelBound, updateWorldBound, updateWorldTransforms, write
 
Methods inherited from class com.jme3.scene.Spatial
addControl, addLight, breadthFirstTraversal, center, checkCulling, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, localToWorld, lookAt, matches, move, move, removeControl, removeControl, removeLight, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLightListRefresh, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setName, setQueueBucket, setShadowMode, setTransformRefresh, setUserData, toString, updateGeometricState, updateLogicalState, updateWorldLightList, worldToLocal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Picture

public Picture(java.lang.String name,
               boolean flipY)
Create a named picture. By default a picture's width and height are 1 and its position is 0, 0.

Parameters:
name - the name of the picture in the scene graph
flipY - If true, the Y coordinates of the texture will be flipped.

Picture

public Picture(java.lang.String name)
Creates a named picture. By default a picture's width and height are 1 and its position is 0, 0. The image texture coordinates will not be flipped.

Parameters:
name - the name of the picture in the scene graph

Picture

public Picture()
Method Detail

setWidth

public void setWidth(float width)
Set the width in pixels of the picture, if the width does not match the texture's width, then the texture will be scaled to fit the picture.

Parameters:
width - the width to set.

setHeight

public void setHeight(float height)
Set the height in pixels of the picture, if the height does not match the texture's height, then the texture will be scaled to fit the picture.

Parameters:
height - the height to set.

setPosition

public void setPosition(float x,
                        float y)
Set the position of the picture in pixels. The origin (0, 0) is at the bottom-left of the screen.

Parameters:
x - The x coordinate
y - The y coordinate

setImage

public void setImage(AssetManager assetManager,
                     java.lang.String imgName,
                     boolean useAlpha)
Set the image to put on the picture.

Parameters:
assetManager - The AssetManager to use to load the image.
imgName - The image name.
useAlpha - If true, the picture will appear transparent and allow objects behind it to appear through. If false, the transparent portions will be the image's color at that pixel.

setTexture

public void setTexture(AssetManager assetManager,
                       Texture2D tex,
                       boolean useAlpha)
Set the texture to put on the picture.

Parameters:
assetManager - The AssetManager to use to load the material.
tex - The texture
useAlpha - If true, the picture will appear transparent and allow objects behind it to appear through. If false, the transparent portions will be the image's color at that pixel.