159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.ui; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.asset.AssetManager; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.asset.TextureKey; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.material.Material; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.material.RenderState.BlendMode; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.math.ColorRGBA; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.math.Vector3f; 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.renderer.queue.RenderQueue.Bucket; 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.Geometry; 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.shape.Quad; 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.texture.Texture2D; 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * A <code>Picture</code> represents a 2D image drawn on the screen. 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * It can be used to represent sprites or other background elements. 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Kirill Vainer 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class Picture extends Geometry { 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float width = 1f; 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private float height = 1f; 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Create a named picture. 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * By default a picture's width and height are 1 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * and its position is 0, 0. 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param name the name of the picture in the scene graph 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param flipY If true, the Y coordinates of the texture will be flipped. 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Picture(String name, boolean flipY){ 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta super(name, new Quad(1, 1, flipY)); 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setQueueBucket(Bucket.Gui); 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setCullHint(CullHint.Never); 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Creates a named picture. 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * By default a picture's width and height are 1 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * and its position is 0, 0. 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The image texture coordinates will not be flipped. 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param name the name of the picture in the scene graph 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Picture(String name){ 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this(name, false); 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /* 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Serialization only. Do not use. 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Picture(){ 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Set the width in pixels of the picture, if the width 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * does not match the texture's width, then the texture will 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * be scaled to fit the picture. 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param width the width to set. 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setWidth(float width){ 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.width = width; 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setLocalScale(new Vector3f(width, height, 1f)); 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Set the height in pixels of the picture, if the height 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * does not match the texture's height, then the texture will 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * be scaled to fit the picture. 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param height the height to set. 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setHeight(float height){ 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta this.height = height; 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setLocalScale(new Vector3f(width, height, 1f)); 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Set the position of the picture in pixels. 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * The origin (0, 0) is at the bottom-left of the screen. 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param x The x coordinate 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param y The y coordinate 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setPosition(float x, float y){ 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta float z = getLocalTranslation().getZ(); 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setLocalTranslation(x, y, z); 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Set the image to put on the picture. 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param assetManager The {@link AssetManager} to use to load the image. 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param imgName The image name. 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param useAlpha If true, the picture will appear transparent and allow 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * objects behind it to appear through. If false, the transparent 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * portions will be the image's color at that pixel. 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setImage(AssetManager assetManager, String imgName, boolean useAlpha){ 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta TextureKey key = new TextureKey(imgName, true); 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Texture2D tex = (Texture2D) assetManager.loadTexture(key); 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setTexture(assetManager, tex, useAlpha); 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Set the texture to put on the picture. 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 14459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param assetManager The {@link AssetManager} to use to load the material. 14559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param tex The texture 14659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @param useAlpha If true, the picture will appear transparent and allow 14759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * objects behind it to appear through. If false, the transparent 14859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * portions will be the image's color at that pixel. 14959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 15059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void setTexture(AssetManager assetManager, Texture2D tex, boolean useAlpha){ 15159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (getMaterial() == null){ 15259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta Material mat = new Material(assetManager, "Common/MatDefs/Gui/Gui.j3md"); 15359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta mat.setColor("Color", ColorRGBA.White); 15459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta setMaterial(mat); 15559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta material.getAdditionalRenderState().setBlendMode(useAlpha ? BlendMode.Alpha : BlendMode.Off); 15759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta material.setTexture("Texture", tex); 15859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 15959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 16059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 161