Package com.jme3.ui

Class Picture

All Implemented Interfaces:
HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, 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.
  • Constructor Details

    • Picture

      public Picture(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(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

      protected Picture()
      Serialization only. Do not use.
  • Method Details

    • getHeight

      public float getHeight()
      Return the height of the picture.
      Returns:
      the height (in pixels)
    • getWidth

      public float getWidth()
      Return the width of the picture.
      Returns:
      the width (in pixels)
    • 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, 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.