Define a key (for example escape) that switches the GUI on and off. You can either overlay the running game with the GUI (you will most likely pause the game then), or even project it as a texture onto a mesh textures (but then you cannot click to select).
On this page, we look at the projection variant (less commonly used).
You can project the Nifty GUI onto a texture, load the texture into a material, and assign it to a 3D mesh. Allthough this is possible the approach is rarely used since it is difficult to record clicks this way, you can only interact with this UI by keyboard or programmatically. (E.g. an action performed by a character standing in front of a "computer")
/** Create a new viewport for the GUI */ ViewPort niftyView = renderManager.createPreView("NiftyView", new Camera(1024, 768)); niftyView.setClearEnabled(true); /** Create a new NiftyJmeDisplay for the integration */ NiftyJmeDisplay niftyDisplay = new NiftyJmeDisplay( assetManager, inputManager, audioRenderer, niftyView); /** Create a new NiftyGUI object */ Nifty nifty = niftyDisplay.getNifty(); /** Read your XML and initialize your custom ScreenController */ nifty.fromXml("Interface/helloworld.xml", "start", new MySettingsScreen(data)); /** We prepare a framebuffer for the texture niftytex */ niftyView.addProcessor(niftyDisplay); FrameBuffer fb = new FrameBuffer(1024, 768, 0); fb.setDepthBuffer(Format.Depth); Texture2D niftytex = new Texture2D(1024, 768, Format.RGB8); fb.setColorTexture(niftytex); niftyView.setClearEnabled(true); niftyView.setOutputFrameBuffer(fb); /** This is the 3D cube we project the GUI on */ Box(Vector3f.ZERO, 1, 1, 1); Geometry geom = new Geometry("Box", b); Material mat = new Material(assetManager, "Common/MatDefs/Misc/Unshaded.j3md"); mat.setTexture("m_ColorMap", niftytex); /** Here comes the texture! */ geom.setMaterial(mat); rootNode.attachChild(geom);
The MySettingsScreen class is a custom de.lessvoid.nifty.screen.ScreenController in which you implement your GUI behaviour. The variable data
contains an object that you use to exchange state info with the game. See Nifty GUI Java Interaction for details on how we created this class.
Run the code sample. You select buttons on this GUI with the arrow keys and then press return. Note that clicking on the texture will not work!
Again, check the Nifty GUI wiki to get all the "bells and whistles" of the syntax!