nifty_gui_java_layout.html 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660
  1. <!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="Asciidoctor 1.5.4"><meta name="keywords" content="gui, documentation, nifty, hud"><title>Laying Out the GUI in Java</title><link rel="stylesheet" href="./asciidoctor.css">
  2. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css">
  3. <link rel="stylesheet" href="./coderay-asciidoctor.css"><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css"><link rel="stylesheet" href="/home/travis/build/jMonkeyEngine/wiki/build/asciidoc/html5/jme3/advanced/twemoji-awesome.css"></head><body class="article toc2 toc-left"><div id="header"><div id="toolbar"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/src/docs/asciidoc/jme3/advanced/nifty_gui_java_layout.adoc"><i class="fa fa-pencil-square" aria-hidden="true"></i></a><a href="https://github.com/jMonkeyEngine/wiki/new/master/src/docs/asciidoc/jme3/advanced/"><i class="fa fa-plus-square" aria-hidden="true"></i></a><input dir="auto" style="position: relative; vertical-align: top;" spellcheck="false" autocomplete="off" class="searchbox__input aa-input" id="doc-search" name="search" placeholder="Search in the doc" required="required" type="search"></div><h1>Laying Out the GUI in Java</h1><div class="details"><span class="author" id="author"></span><br><span id="revnumber">version ,</span> <span id="revdate">2016/03/17 20:48</span></div><div id="toc" class="toc2"><div id="toctitle">Table of Contents</div><ul class="sectlevel1"><li><a href="#sample-code">Sample Code</a></li><li><a href="#implement-your-gui-layout">Implement Your GUI Layout</a><ul class="sectlevel2"><li><a href="#make-screens">Make Screens</a></li><li><a href="#make-layers">Make Layers</a></li><li><a href="#make-panels">Make Panels</a></li></ul></li><li><a href="#adding-content-to-panels">Adding Content to Panels</a><ul class="sectlevel2"><li><a href="#add-images">Add Images</a></li><li><a href="#add-static-text">Add Static Text</a></li><li><a href="#add-controls">Add Controls</a></li></ul></li><li><a href="#intermediate-result">Intermediate Result</a></li><li><a href="#nifty-java-settings">Nifty Java Settings</a></li><li><a href="#next-steps">Next Steps</a></li></ul></div></div><div id="content"><div id="preamble"><div class="sectionbody"><div class="olist arabic"><ol class="arabic"><li><p><a href="../../jme3/advanced/nifty_gui.html">Nifty GUI Concepts</a></p></li><li><p><a href="../../jme3/advanced/nifty_gui_best_practices.html">Nifty GUI Best Practices</a></p></li><li><p><a href="../../jme3/advanced/nifty_gui_xml_layout.html">Nifty GUI XML Layout</a> or <strong>Nifty <abbr title="Graphical User Interface">GUI</abbr> Java Layout</strong></p></li><li><p><a href="../../jme3/advanced/nifty_gui_overlay.html">Nifty GUI Overlay</a> or <a href="../../jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a></p></li><li><p><a href="../../jme3/advanced/nifty_gui_java_interaction.html">Interact with the GUI from Java</a></p></li></ol></div>
  4. <div class="paragraph"><p>You can &#8220;draw&#8221; the <abbr title="Graphical User Interface">GUI</abbr> to the screen by writing Java code – alternatively to using XML. Typically you lay out the static base <abbr title="Graphical User Interface">GUI</abbr> in XML, and use Java commands if you need to change the <abbr title="Graphical User Interface">GUI</abbr> dynamically at runtime. In theory, you can also lay out the whole <abbr title="Graphical User Interface">GUI</abbr> in Java (but we don&#8217;t cover that here).</p></div></div></div>
  5. <div class="sect1"><h2 id="sample-code">Sample Code</h2><div class="sectionbody"><div class="paragraph"><p>Sample project</p></div>
  6. <div class="ulist"><ul><li><p><strong>Original Source Code:</strong> <a href="https://github.com/nifty-gui/nifty-gui/tree/1.4/nifty-examples/src/main/java/de/lessvoid/nifty/examples/defaultcontrols">/nifty-examples/src/main/java/de/lessvoid/nifty/examples/defaultcontrols/</a>.</p></li></ul></div>
  7. <div class="paragraph"><p>Just so you get a quick picture what Nifty <abbr title="Graphical User Interface">GUI</abbr>'s Java Syntax looks like, here is the most basic example. It creates a screen with a layer and a panel that contains a button.</p></div>
  8. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">mygame</span>;
  9. <span class="keyword">import</span> <span class="include">com.jme3.app.Application</span>;
  10. <span class="keyword">import</span> <span class="include">com.jme3.app.SimpleApplication</span>;
  11. <span class="keyword">import</span> <span class="include">com.jme3.app.state.BaseAppState</span>;
  12. <span class="keyword">import</span> <span class="include">com.jme3.niftygui.NiftyJmeDisplay</span>;
  13. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.Nifty</span>;
  14. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.LayerBuilder</span>;
  15. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.PanelBuilder</span>;
  16. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.ScreenBuilder</span>;
  17. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.controls.button.builder.ButtonBuilder</span>;
  18. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.screen.DefaultScreenController</span>;
  19. <span class="directive">public</span> <span class="type">class</span> <span class="class">MyStartScreen</span> <span class="directive">extends</span> BaseAppState {
  20. <span class="annotation">@Override</span>
  21. <span class="directive">protected</span> <span class="type">void</span> initialize(Application app) {
  22. <span class="comment">//It is technically safe to do all initialization and cleanup in the</span>
  23. <span class="comment">//onEnable()/onDisable() methods. Choosing to use initialize() and</span>
  24. <span class="comment">//cleanup() for this is a matter of performance specifics for the</span>
  25. <span class="comment">//implementor.</span>
  26. <span class="comment">//TODO: initialize your AppState, e.g. attach spatials to rootNode</span>
  27. }
  28. <span class="annotation">@Override</span>
  29. <span class="directive">protected</span> <span class="type">void</span> cleanup(Application app) {
  30. <span class="comment">//TODO: clean up what you initialized in the initialize method,</span>
  31. <span class="comment">//e.g. remove all spatials from rootNode</span>
  32. }
  33. <span class="comment">//onEnable()/onDisable() can be used for managing things that should</span>
  34. <span class="comment">//only exist while the state is enabled. Prime examples would be scene</span>
  35. <span class="comment">//graph attachment or input listener attachment.</span>
  36. <span class="annotation">@Override</span>
  37. <span class="directive">protected</span> <span class="type">void</span> onEnable() {
  38. NiftyJmeDisplay niftyDisplay = NiftyJmeDisplay.newNiftyJmeDisplay(
  39. getApplication().getAssetManager(),
  40. getApplication().getInputManager(),
  41. getApplication().getAudioRenderer(),
  42. getApplication().getGuiViewPort());
  43. Nifty nifty = niftyDisplay.getNifty();
  44. getApplication().getGuiViewPort().addProcessor(niftyDisplay);
  45. ((SimpleApplication) getApplication()).getFlyByCamera().setDragToRotate(<span class="predefined-constant">true</span>);
  46. nifty.loadStyleFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-styles.xml</span><span class="delimiter">&quot;</span></span>);
  47. nifty.loadControlFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-controls.xml</span><span class="delimiter">&quot;</span></span>);
  48. <span class="comment">// &lt;screen&gt;</span>
  49. nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">Screen_ID</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">Hello Nifty Screen</span><span class="delimiter">&quot;</span></span>){{
  50. controller(<span class="keyword">new</span> DefaultScreenController()); <span class="comment">// Screen properties</span>
  51. <span class="comment">// &lt;layer&gt;</span>
  52. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">Layer_ID</span><span class="delimiter">&quot;</span></span>) {{
  53. childLayoutVertical(); <span class="comment">// layer properties, add more...</span>
  54. <span class="comment">// &lt;panel&gt;</span>
  55. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">Panel_ID</span><span class="delimiter">&quot;</span></span>) {{
  56. childLayoutCenter(); <span class="comment">// panel properties, add more...</span>
  57. <span class="comment">// GUI elements</span>
  58. control(<span class="keyword">new</span> ButtonBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">Button_ID</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Hello Nifty</span><span class="delimiter">&quot;</span></span>){{
  59. alignCenter();
  60. valignCenter();
  61. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">5%</span><span class="delimiter">&quot;</span></span>);
  62. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  63. }});
  64. <span class="comment">//.. add more GUI elements here</span>
  65. }});
  66. <span class="comment">// &lt;/panel&gt;</span>
  67. }});
  68. <span class="comment">// &lt;/layer&gt;</span>
  69. }}.build(nifty));
  70. <span class="comment">// &lt;/screen&gt;</span>
  71. nifty.gotoScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">Screen_ID</span><span class="delimiter">&quot;</span></span>); <span class="comment">// start the screen</span>
  72. }
  73. <span class="annotation">@Override</span>
  74. <span class="directive">protected</span> <span class="type">void</span> onDisable() {
  75. <span class="comment">//Called when the state was previously enabled but is now disabled</span>
  76. <span class="comment">//either because setEnabled(false) was called or the state is being</span>
  77. <span class="comment">//cleaned up.</span>
  78. }
  79. <span class="annotation">@Override</span>
  80. <span class="directive">public</span> <span class="type">void</span> update(<span class="type">float</span> tpf) {
  81. <span class="comment">//TODO: implement behavior during runtime</span>
  82. }
  83. }</code></pre></div></div></div></div>
  84. <div class="sect2"><h3 id="implement-your-gui-layout">Implement Your GUI Layout</h3><div style="text-align: left;" class="imageblock"><div class="content"><img src="../../jme3/advanced/gui-layout-draft.png" alt="gui-layout-draft.png" width="" height=""></div></div>
  85. <div class="paragraph"><p>In this tutorial, you recreate the same screen as in the <a href="../../jme3/advanced/nifty_gui_xml_layout.html">Laying out the GUI in XML</a> example.</p></div>
  86. <div class="paragraph"><p>Create an Screen.Java file that extends BaseAppState in the mygame directory of your project. One Java file can contain several, or even all screens. As a reminder: Nifty displays one screen at a time; a screen contains several layers on top of one another; each layer contains panels that are embedded into another; the panels contain the actual content (text, images, or controls).</p></div>
  87. <div class="paragraph"><p>Next, setup your Nifty display.</p></div>
  88. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">NiftyJmeDisplay niftyDisplay = NiftyJmeDisplay.newNiftyJmeDisplay(
  89. getApplication().getAssetManager(),
  90. getApplication().getInputManager(),
  91. getApplication().getAudioRenderer(),
  92. getApplication().getGuiViewPort());
  93. Nifty nifty = niftyDisplay.getNifty();
  94. getApplication().getGuiViewPort().addProcessor(niftyDisplay);
  95. ((SimpleApplication) getApplication()).getFlyByCamera().setDragToRotate(<span class="predefined-constant">true</span>);
  96. nifty.loadStyleFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-styles.xml</span><span class="delimiter">&quot;</span></span>);
  97. nifty.loadControlFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-controls.xml</span><span class="delimiter">&quot;</span></span>);
  98. <span class="comment">// &lt;!-- ... --&gt;</span>
  99. nifty.gotoScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>); <span class="comment">// start the screen</span></code></pre></div></div>
  100. <div class="sect2"><h3 id="make-screens">Make Screens</h3><div class="paragraph"><p>The following minimal Java file contains a start screen and a HUD screen. (Neither has been defined yet.)</p></div>
  101. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>) {{
  102. controller(<span class="keyword">new</span> DefaultScreenController());
  103. <span class="comment">// &lt;!-- ... --&gt;</span>
  104. }}.build(nifty));
  105. nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>) {{
  106. controller(<span class="keyword">new</span> DefaultScreenController());
  107. <span class="comment">// &lt;!-- ... --&gt;</span>
  108. }}.build(nifty));</code></pre></div></div>
  109. <div class="paragraph"><p>Every Nifty <abbr title="Graphical User Interface">GUI</abbr> must have a start screen. The others (in this example, the HUD screen) are optional.</p></div></div>
  110. <div class="sect2"><h3 id="make-layers">Make Layers</h3><div class="paragraph"><p>The following Java code shows how we add layers to the start screen and HUD screen. Add the following to your <code>Screen.java</code> file:</p></div>
  111. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>) {{
  112. controller(<span class="keyword">new</span> DefaultScreenController());
  113. <span class="comment">// layer added</span>
  114. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  115. childLayoutCenter();
  116. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000f</span><span class="delimiter">&quot;</span></span>);
  117. <span class="comment">// &lt;!-- ... --&gt;</span>
  118. }});
  119. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">foreground</span><span class="delimiter">&quot;</span></span>) {{
  120. childLayoutVertical();
  121. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#0000</span><span class="delimiter">&quot;</span></span>);
  122. <span class="comment">// &lt;!-- ... --&gt;</span>
  123. }});
  124. <span class="comment">// layer added</span>
  125. }}.build(nifty));</code></pre></div></div>
  126. <div class="paragraph"><p>Repeat the same, but use</p></div>
  127. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code>nifty.addScreen("hud", new ScreenBuilder("hud"){{</code></pre></div></div>
  128. <div class="paragraph"><p>for the HUD screen.</p></div>
  129. <div class="paragraph"><p>In a layer, you can now add panels and arrange them. Panels are containers that mark the areas where you want to display text, images, or controls (buttons etc) later.</p></div></div>
  130. <div class="sect2"><h3 id="make-panels">Make Panels</h3><div class="paragraph"><p>A panel is the inner-most container (that will contain the actual content: text, images, or controls). You place panels inside layers. The following panels go into in the <code>start</code> screen <code>foreground</code> layer:</p></div>
  131. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>) {{
  132. controller(<span class="keyword">new</span> DefaultScreenController());
  133. <span class="comment">// layer added</span>
  134. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  135. childLayoutCenter();
  136. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000f</span><span class="delimiter">&quot;</span></span>);
  137. <span class="comment">// &lt;!-- ... --&gt;</span>
  138. }});
  139. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">foreground</span><span class="delimiter">&quot;</span></span>) {{
  140. childLayoutVertical();
  141. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#0000</span><span class="delimiter">&quot;</span></span>);
  142. <span class="comment">// panel added</span>
  143. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top</span><span class="delimiter">&quot;</span></span>) {{
  144. childLayoutCenter();
  145. alignCenter();
  146. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#f008</span><span class="delimiter">&quot;</span></span>);
  147. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">25%</span><span class="delimiter">&quot;</span></span>);
  148. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  149. }});
  150. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_mid</span><span class="delimiter">&quot;</span></span>) {{
  151. childLayoutCenter();
  152. alignCenter();
  153. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#0f08</span><span class="delimiter">&quot;</span></span>);
  154. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  155. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  156. }});
  157. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom</span><span class="delimiter">&quot;</span></span>) {{
  158. childLayoutHorizontal();
  159. alignCenter();
  160. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#00f8</span><span class="delimiter">&quot;</span></span>);
  161. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">25%</span><span class="delimiter">&quot;</span></span>);
  162. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  163. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom_left</span><span class="delimiter">&quot;</span></span>) {{
  164. childLayoutCenter();
  165. valignCenter();
  166. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#44f8</span><span class="delimiter">&quot;</span></span>);
  167. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  168. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  169. }});
  170. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom_right</span><span class="delimiter">&quot;</span></span>) {{
  171. childLayoutCenter();
  172. valignCenter();
  173. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#88f8</span><span class="delimiter">&quot;</span></span>);
  174. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  175. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  176. }});
  177. }}); <span class="comment">// panel added</span>
  178. }});
  179. <span class="comment">// layer added</span>
  180. }}.build(nifty));</code></pre></div></div>
  181. <div class="paragraph"><p>The following panels go into in the <code>hud</code> screen:</p></div>
  182. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="Java">nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>) {{
  183. controller(<span class="keyword">new</span> DefaultScreenController());
  184. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  185. childLayoutCenter();
  186. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000f</span><span class="delimiter">&quot;</span></span>);
  187. <span class="comment">// &lt;!-- ... --&gt;</span>
  188. }});
  189. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">foreground</span><span class="delimiter">&quot;</span></span>) {{
  190. childLayoutHorizontal();
  191. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#0000</span><span class="delimiter">&quot;</span></span>);
  192. <span class="comment">// panel added</span>
  193. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_left</span><span class="delimiter">&quot;</span></span>) {{
  194. childLayoutVertical();
  195. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#0f08</span><span class="delimiter">&quot;</span></span>);
  196. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  197. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">80%</span><span class="delimiter">&quot;</span></span>);
  198. <span class="comment">// &lt;!-- spacer --&gt;</span>
  199. }});
  200. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_right</span><span class="delimiter">&quot;</span></span>) {{
  201. childLayoutVertical();
  202. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#00f8</span><span class="delimiter">&quot;</span></span>);
  203. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  204. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">20%</span><span class="delimiter">&quot;</span></span>);
  205. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top_right1</span><span class="delimiter">&quot;</span></span>) {{
  206. childLayoutCenter();
  207. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#00f8</span><span class="delimiter">&quot;</span></span>);
  208. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  209. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  210. }});
  211. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top_right2</span><span class="delimiter">&quot;</span></span>) {{
  212. childLayoutCenter();
  213. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#44f8</span><span class="delimiter">&quot;</span></span>);
  214. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  215. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  216. }});
  217. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bot_right</span><span class="delimiter">&quot;</span></span>) {{
  218. childLayoutCenter();
  219. valignCenter();
  220. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#88f8</span><span class="delimiter">&quot;</span></span>);
  221. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">70%</span><span class="delimiter">&quot;</span></span>);
  222. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  223. }});
  224. }}); <span class="comment">// panel added</span>
  225. }});
  226. }}.build(nifty));</code></pre></div></div>
  227. <div class="paragraph"><p>Try the sample. Remember to activate a screen using <code>nifty.gotoScreen("start");</code> or <code>hud</code> respectively.
  228. The result should look as follows:</p></div>
  229. <div style="text-align: center;" class="imageblock"><div class="content"><img src="../../jme3/advanced/nifty-gui-panels.png" alt="nifty-gui-panels.png" width="" height=""></div></div></div></div>
  230. <div class="sect2"><h3 id="adding-content-to-panels">Adding Content to Panels</h3><div class="paragraph"><p>See also <a href="https://github.com/nifty-gui/nifty-gui/raw/1.4/nifty-core/manual/nifty-gui-the-manual-1.3.2.pdf">Nifty GUI - the Manual: Layouts</a> on the Nifty <abbr title="Graphical User Interface">GUI</abbr> site.</p></div>
  231. <div class="sect2"><h3 id="add-images">Add Images</h3><div class="paragraph"><p>The <code>start-background.png</code> image is a fullscreen background picture. In the <code>start</code> screen, add the following image element:</p></div>
  232. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>) {{
  233. controller(<span class="keyword">new</span> DefaultScreenController());
  234. <span class="comment">// layer added</span>
  235. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  236. childLayoutCenter();
  237. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000f</span><span class="delimiter">&quot;</span></span>);
  238. <span class="comment">// add image</span>
  239. image(<span class="keyword">new</span> ImageBuilder() {{
  240. filename(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/start-background.png</span><span class="delimiter">&quot;</span></span>);
  241. }});
  242. }});
  243. <span class="comment">// &lt;!-- ... --&gt;</span>
  244. }}.build(nifty));</code></pre></div></div>
  245. <div class="paragraph"><p>The <code>hud-frame.png</code> image is a transparent frame that we use as HUD decoration. In the <code>hud</code> screen, add the following image element:</p></div>
  246. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>) {{
  247. controller(<span class="keyword">new</span> DefaultScreenController());
  248. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  249. childLayoutCenter();
  250. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000f</span><span class="delimiter">&quot;</span></span>);
  251. <span class="comment">// add image</span>
  252. image(<span class="keyword">new</span> ImageBuilder() {{
  253. filename(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/hud-frame.png</span><span class="delimiter">&quot;</span></span>);
  254. }});
  255. }});
  256. <span class="comment">// &lt;!-- ... --&gt;</span>
  257. }}.build(nifty));</code></pre></div></div>
  258. <div class="paragraph"><p>The <code>face1.png</code> image is an image that you want to use as a status icon.
  259. In the <code>hud</code> screens <code>foreground</code> layer, add the following image element:</p></div>
  260. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top_right2</span><span class="delimiter">&quot;</span></span>) {{
  261. childLayoutCenter();
  262. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#44f8</span><span class="delimiter">&quot;</span></span>);
  263. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  264. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  265. <span class="comment">// add image</span>
  266. image(<span class="keyword">new</span> ImageBuilder() {{
  267. filename(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/face1.png</span><span class="delimiter">&quot;</span></span>);
  268. valignCenter();
  269. alignCenter();
  270. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  271. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">30%</span><span class="delimiter">&quot;</span></span>);
  272. }});
  273. }});</code></pre></div></div>
  274. <div class="paragraph"><p>This image is scaled to use 50% of the height and 30% of the width of its container.</p></div></div>
  275. <div class="sect2"><h3 id="add-static-text">Add Static Text</h3><div class="paragraph"><p>The game title is a typical example of static text. In the <code>start</code> screen <code>foreground</code> layer, add the following text element:</p></div>
  276. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java"><span class="comment">// panel added</span>
  277. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top</span><span class="delimiter">&quot;</span></span>) {{
  278. childLayoutCenter();
  279. alignCenter();
  280. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#f008</span><span class="delimiter">&quot;</span></span>);
  281. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">25%</span><span class="delimiter">&quot;</span></span>);
  282. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  283. text(<span class="keyword">new</span> TextBuilder() {{
  284. text(<span class="string"><span class="delimiter">&quot;</span><span class="content">My Cool Game</span><span class="delimiter">&quot;</span></span>);
  285. font(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/Fonts/Default.fnt</span><span class="delimiter">&quot;</span></span>);
  286. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  287. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  288. }});
  289. }});</code></pre></div></div>
  290. <div class="paragraph"><p>For longer pieces of static text, such as an introduction, you can use <code>wrap="true"</code>. Setting <code>wrap="true"</code> will only work when you set a width for the text element, so that Nifty knows when to wrap a line. Add the following text element to the <code>Start</code> screen <code>foreground</code> layer:</p></div>
  291. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_mid</span><span class="delimiter">&quot;</span></span>) {{
  292. childLayoutCenter();
  293. alignCenter();
  294. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#0f08</span><span class="delimiter">&quot;</span></span>);
  295. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  296. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  297. <span class="comment">// add text</span>
  298. text(<span class="keyword">new</span> TextBuilder() {{
  299. text(<span class="string"><span class="delimiter">&quot;</span><span class="content">Here goes some text describing the game and the rules and stuff. </span><span class="delimiter">&quot;</span></span>
  300. + <span class="string"><span class="delimiter">&quot;</span><span class="content">Incidentally, the text is quite long and needs to wrap at the end of lines.</span><span class="delimiter">&quot;</span></span>);
  301. font(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/Fonts/Default.fnt</span><span class="delimiter">&quot;</span></span>);
  302. wrap(<span class="predefined-constant">true</span>);
  303. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  304. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  305. }});
  306. }});</code></pre></div></div>
  307. <div class="paragraph"><p>The font used is jME3&#8217;s default font &#8220;Interface/Fonts/Default.fnt&#8221; which is included in the jMonkeyEngine.JAR. You can add your own fonts to your own <code>assets/Interface</code> directory. Set your font to the one you created during the start of the <a href="../../jme3/advanced/nifty_gui_xml_layout.html#implement-your-gui-layout">Gui Implementation</a> phase of your game.</p></div></div>
  308. <div class="sect2"><h3 id="add-controls">Add Controls</h3><div class="paragraph"><p>Before you can use any control, you must load a Control Definition first. Thats why we add the following two lines <em>before</em> the screen definitions:</p></div>
  309. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.loadStyleFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-styles.xml</span><span class="delimiter">&quot;</span></span>);
  310. nifty.loadControlFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-controls.xml</span><span class="delimiter">&quot;</span></span>);</code></pre></div></div>
  311. <div class="sect3"><h4 id="label-control">Label Control</h4><div class="paragraph"><p>Use label controls for text that you want to edit dynamically from Java. One example for this is the score display.
  312. In the <code>hud</code> screen&#8217;s <code>foreground</code> layer, add the following text element:</p></div>
  313. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top_right1</span><span class="delimiter">&quot;</span></span>) {{
  314. childLayoutCenter();
  315. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#00f8</span><span class="delimiter">&quot;</span></span>);
  316. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  317. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  318. control(<span class="keyword">new</span> LabelBuilder(){{
  319. color(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000</span><span class="delimiter">&quot;</span></span>);
  320. text(<span class="string"><span class="delimiter">&quot;</span><span class="content">123</span><span class="delimiter">&quot;</span></span>);
  321. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  322. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  323. }});
  324. }});</code></pre></div></div>
  325. <div class="paragraph"><p>Note that the width and height do not scale the bitmap font, but make indirectly certain it is centered. If you want a different size for the font, you need to provide an extra bitmap font (they come with fixes sizes and don&#8217;t scale well).</p></div></div>
  326. <div class="sect3"><h4 id="button-control">Button Control</h4><div class="paragraph"><p>Our <abbr title="Graphical User Interface">GUI</abbr> plan asks for two buttons on the start screen. You add the Start and Quit buttons to the bottom panel of the <code>start</code> screen using the <code>&lt;control&gt;</code> element:</p></div>
  327. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom_left</span><span class="delimiter">&quot;</span></span>) {{
  328. childLayoutCenter();
  329. valignCenter();
  330. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#44f8</span><span class="delimiter">&quot;</span></span>);
  331. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  332. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  333. <span class="comment">// add control</span>
  334. control(<span class="keyword">new</span> ButtonBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">StartButton</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Start</span><span class="delimiter">&quot;</span></span>) {{
  335. alignCenter();
  336. valignCenter();
  337. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  338. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  339. }});
  340. }});
  341. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom_right</span><span class="delimiter">&quot;</span></span>) {{
  342. childLayoutCenter();
  343. valignCenter();
  344. backgroundColor(<span class="string"><span class="delimiter">&quot;</span><span class="content">#88f8</span><span class="delimiter">&quot;</span></span>);
  345. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  346. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  347. <span class="comment">// add control</span>
  348. control(<span class="keyword">new</span> ButtonBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">QuitButton</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Quit</span><span class="delimiter">&quot;</span></span>) {{
  349. alignCenter();
  350. valignCenter();
  351. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  352. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  353. }});
  354. }});</code></pre></div></div>
  355. <div class="paragraph"><p>Note that these controls don&#8217;t do anything yet – we&#8217;ll get to that soon.</p></div></div>
  356. <div class="sect3"><h4 id="other-controls">Other Controls</h4><div class="paragraph"><p>Nifty additionally offers many customizable controls such as check boxes, text fields, menus, chats, tabs, …</p></div>
  357. <div class="paragraph"><p>See also:</p></div>
  358. <div class="ulist"><ul><li><p><a href="https://github.com/nifty-gui/nifty-gui/raw/1.4/nifty-core/manual/nifty-gui-the-manual-1.3.2.pdf">Nifty GUI - the Manual: Elements</a></p></li><li><p><a href="https://github.com/nifty-gui/nifty-gui/wiki/Controls">Controls</a></p></li></ul></div></div></div></div>
  359. <div class="sect1"><h2 id="intermediate-result">Intermediate Result</h2><div class="sectionbody"><div class="paragraph"><p>When you preview this code in the jMonkeyEngine SDK, our tutorial demo should looks as follows: A start screen with two buttons, and a game screen with a simple HUD frame and a blue cube (which stands for any jME3 game content).</p></div>
  360. <div class="admonitionblock tip"><table><tr><td class="icon"><i class="fa icon-tip" title="Tip"></i></td><td class="content">Remove all lines that set background colors, you only needed them to see the arrangement.</td></tr></table></div>
  361. <div style="text-align: center;" class="imageblock"><div class="content"><img src="../../jme3/advanced/nifty-gui-simple-demo.png" alt="nifty-gui-simple-demo.png" width="" height=""></div></div>
  362. <div class="paragraph"><p>Your <code>Screen.java</code> file should look like this:</p></div>
  363. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java"><span class="keyword">package</span> <span class="namespace">mygame</span>;
  364. <span class="keyword">import</span> <span class="include">com.jme3.app.Application</span>;
  365. <span class="keyword">import</span> <span class="include">com.jme3.app.SimpleApplication</span>;
  366. <span class="keyword">import</span> <span class="include">com.jme3.app.state.BaseAppState</span>;
  367. <span class="keyword">import</span> <span class="include">com.jme3.niftygui.NiftyJmeDisplay</span>;
  368. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.Nifty</span>;
  369. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.ImageBuilder</span>;
  370. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.LayerBuilder</span>;
  371. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.PanelBuilder</span>;
  372. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.ScreenBuilder</span>;
  373. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.builder.TextBuilder</span>;
  374. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.controls.button.builder.ButtonBuilder</span>;
  375. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.controls.label.builder.LabelBuilder</span>;
  376. <span class="keyword">import</span> <span class="include">de.lessvoid.nifty.screen.DefaultScreenController</span>;
  377. <span class="directive">public</span> <span class="type">class</span> <span class="class">Screen</span> <span class="directive">extends</span> BaseAppState {
  378. <span class="annotation">@Override</span>
  379. <span class="directive">protected</span> <span class="type">void</span> initialize(Application app) {
  380. <span class="comment">//It is technically safe to do all initialization and cleanup in the</span>
  381. <span class="comment">//onEnable()/onDisable() methods. Choosing to use initialize() and</span>
  382. <span class="comment">//cleanup() for this is a matter of performance specifics for the</span>
  383. <span class="comment">//implementor.</span>
  384. <span class="comment">//TODO: initialize your AppState, e.g. attach spatials to rootNode</span>
  385. }
  386. <span class="annotation">@Override</span>
  387. <span class="directive">protected</span> <span class="type">void</span> cleanup(Application app) {
  388. <span class="comment">//TODO: clean up what you initialized in the initialize method,</span>
  389. <span class="comment">//e.g. remove all spatials from rootNode</span>
  390. }
  391. <span class="comment">//onEnable()/onDisable() can be used for managing things that should</span>
  392. <span class="comment">//only exist while the state is enabled. Prime examples would be scene</span>
  393. <span class="comment">//graph attachment or input listener attachment.</span>
  394. <span class="annotation">@Override</span>
  395. <span class="directive">protected</span> <span class="type">void</span> onEnable() {
  396. NiftyJmeDisplay niftyDisplay = NiftyJmeDisplay.newNiftyJmeDisplay(
  397. getApplication().getAssetManager(),
  398. getApplication().getInputManager(),
  399. getApplication().getAudioRenderer(),
  400. getApplication().getGuiViewPort());
  401. Nifty nifty = niftyDisplay.getNifty();
  402. getApplication().getGuiViewPort().addProcessor(niftyDisplay);
  403. ((SimpleApplication) getApplication()).getFlyByCamera().setDragToRotate(<span class="predefined-constant">true</span>);
  404. nifty.loadStyleFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-styles.xml</span><span class="delimiter">&quot;</span></span>);
  405. nifty.loadControlFile(<span class="string"><span class="delimiter">&quot;</span><span class="content">nifty-default-controls.xml</span><span class="delimiter">&quot;</span></span>);
  406. nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">start</span><span class="delimiter">&quot;</span></span>) {{
  407. controller(<span class="keyword">new</span> DefaultScreenController());
  408. <span class="comment">// layer added</span>
  409. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  410. childLayoutCenter();
  411. <span class="comment">// backgroundColor(&quot;#000f&quot;);</span>
  412. <span class="comment">// add image</span>
  413. image(<span class="keyword">new</span> ImageBuilder() {{
  414. filename(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/start-background.png</span><span class="delimiter">&quot;</span></span>);
  415. }});
  416. }});
  417. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">foreground</span><span class="delimiter">&quot;</span></span>) {{
  418. childLayoutVertical();
  419. <span class="comment">// backgroundColor(&quot;#0000&quot;);</span>
  420. <span class="comment">// panel added</span>
  421. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top</span><span class="delimiter">&quot;</span></span>) {{
  422. childLayoutCenter();
  423. alignCenter();
  424. <span class="comment">// backgroundColor(&quot;#f008&quot;);</span>
  425. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">25%</span><span class="delimiter">&quot;</span></span>);
  426. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  427. text(<span class="keyword">new</span> TextBuilder() {{
  428. text(<span class="string"><span class="delimiter">&quot;</span><span class="content">My Cool Game</span><span class="delimiter">&quot;</span></span>);
  429. font(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/Fonts/Arial.fnt</span><span class="delimiter">&quot;</span></span>);
  430. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  431. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  432. }});
  433. }});
  434. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_mid</span><span class="delimiter">&quot;</span></span>) {{
  435. childLayoutCenter();
  436. alignCenter();
  437. <span class="comment">// backgroundColor(&quot;#0f08&quot;);</span>
  438. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  439. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  440. <span class="comment">// add text</span>
  441. text(<span class="keyword">new</span> TextBuilder() {{
  442. text(<span class="string"><span class="delimiter">&quot;</span><span class="content">Here goes some text describing the game and the rules and stuff. </span><span class="delimiter">&quot;</span></span>
  443. + <span class="string"><span class="delimiter">&quot;</span><span class="content">Incidentally, the text is quite long and needs to wrap at the end of lines. </span><span class="delimiter">&quot;</span></span>);
  444. font(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/Fonts/Arial.fnt</span><span class="delimiter">&quot;</span></span>);
  445. wrap(<span class="predefined-constant">true</span>);
  446. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  447. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  448. }});
  449. }});
  450. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom</span><span class="delimiter">&quot;</span></span>) {{
  451. childLayoutHorizontal();
  452. alignCenter();
  453. <span class="comment">// backgroundColor(&quot;#00f8&quot;);</span>
  454. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">25%</span><span class="delimiter">&quot;</span></span>);
  455. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">75%</span><span class="delimiter">&quot;</span></span>);
  456. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom_left</span><span class="delimiter">&quot;</span></span>) {{
  457. childLayoutCenter();
  458. valignCenter();
  459. <span class="comment">// backgroundColor(&quot;#44f8&quot;);</span>
  460. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  461. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  462. <span class="comment">// add control</span>
  463. control(<span class="keyword">new</span> ButtonBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">StartButton</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Start</span><span class="delimiter">&quot;</span></span>) {{
  464. alignCenter();
  465. valignCenter();
  466. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  467. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  468. }});
  469. }});
  470. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bottom_right</span><span class="delimiter">&quot;</span></span>) {{
  471. childLayoutCenter();
  472. valignCenter();
  473. <span class="comment">// backgroundColor(&quot;#88f8&quot;);</span>
  474. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  475. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  476. <span class="comment">// add control</span>
  477. control(<span class="keyword">new</span> ButtonBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">QuitButton</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Quit</span><span class="delimiter">&quot;</span></span>) {{
  478. alignCenter();
  479. valignCenter();
  480. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  481. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  482. }});
  483. }});
  484. }}); <span class="comment">// panel added</span>
  485. }});
  486. <span class="comment">// layer added</span>
  487. }}.build(nifty));
  488. nifty.addScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>, <span class="keyword">new</span> ScreenBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>) {{
  489. controller(<span class="keyword">new</span> DefaultScreenController());
  490. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">background</span><span class="delimiter">&quot;</span></span>) {{
  491. childLayoutCenter();
  492. <span class="comment">// backgroundColor(&quot;#000f&quot;);</span>
  493. <span class="comment">// add image</span>
  494. image(<span class="keyword">new</span> ImageBuilder() {{
  495. filename(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/hud-frame.png</span><span class="delimiter">&quot;</span></span>);
  496. }});
  497. }});
  498. layer(<span class="keyword">new</span> LayerBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">foreground</span><span class="delimiter">&quot;</span></span>) {{
  499. childLayoutHorizontal();
  500. <span class="comment">// backgroundColor(&quot;#0000&quot;);</span>
  501. <span class="comment">// panel added</span>
  502. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_left</span><span class="delimiter">&quot;</span></span>) {{
  503. childLayoutVertical();
  504. <span class="comment">// backgroundColor(&quot;#0f08&quot;);</span>
  505. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  506. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">80%</span><span class="delimiter">&quot;</span></span>);
  507. <span class="comment">// &lt;!-- spacer --&gt;</span>
  508. }});
  509. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_right</span><span class="delimiter">&quot;</span></span>) {{
  510. childLayoutVertical();
  511. <span class="comment">// backgroundColor(&quot;#00f8&quot;);</span>
  512. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  513. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">20%</span><span class="delimiter">&quot;</span></span>);
  514. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top_right1</span><span class="delimiter">&quot;</span></span>) {{
  515. childLayoutCenter();
  516. <span class="comment">// backgroundColor(&quot;#00f8&quot;);</span>
  517. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  518. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  519. control(<span class="keyword">new</span> LabelBuilder(){{
  520. color(<span class="string"><span class="delimiter">&quot;</span><span class="content">#000</span><span class="delimiter">&quot;</span></span>);
  521. text(<span class="string"><span class="delimiter">&quot;</span><span class="content">123</span><span class="delimiter">&quot;</span></span>);
  522. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  523. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  524. }});
  525. }});
  526. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_top_right2</span><span class="delimiter">&quot;</span></span>) {{
  527. childLayoutCenter();
  528. <span class="comment">// backgroundColor(&quot;#44f8&quot;);</span>
  529. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">15%</span><span class="delimiter">&quot;</span></span>);
  530. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  531. <span class="comment">// add image</span>
  532. image(<span class="keyword">new</span> ImageBuilder() {{
  533. filename(<span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/face1.png</span><span class="delimiter">&quot;</span></span>);
  534. valignCenter();
  535. alignCenter();
  536. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">50%</span><span class="delimiter">&quot;</span></span>);
  537. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">30%</span><span class="delimiter">&quot;</span></span>);
  538. }});
  539. }});
  540. panel(<span class="keyword">new</span> PanelBuilder(<span class="string"><span class="delimiter">&quot;</span><span class="content">panel_bot_right</span><span class="delimiter">&quot;</span></span>) {{
  541. childLayoutCenter();
  542. valignCenter();
  543. <span class="comment">// backgroundColor(&quot;#88f8&quot;);</span>
  544. height(<span class="string"><span class="delimiter">&quot;</span><span class="content">70%</span><span class="delimiter">&quot;</span></span>);
  545. width(<span class="string"><span class="delimiter">&quot;</span><span class="content">100%</span><span class="delimiter">&quot;</span></span>);
  546. }});
  547. }}); <span class="comment">// panel added</span>
  548. }});
  549. }}.build(nifty));
  550. nifty.gotoScreen(<span class="string"><span class="delimiter">&quot;</span><span class="content">hud</span><span class="delimiter">&quot;</span></span>); <span class="comment">// start the screen</span>
  551. }
  552. <span class="annotation">@Override</span>
  553. <span class="directive">protected</span> <span class="type">void</span> onDisable() {
  554. <span class="comment">//Called when the state was previously enabled but is now disabled</span>
  555. <span class="comment">//either because setEnabled(false) was called or the state is being</span>
  556. <span class="comment">//cleaned up.</span>
  557. }
  558. <span class="annotation">@Override</span>
  559. <span class="directive">public</span> <span class="type">void</span> update(<span class="type">float</span> tpf) {
  560. <span class="comment">//TODO: implement behavior during runtime</span>
  561. }
  562. }</code></pre></div></div></div></div>
  563. <div class="sect1"><h2 id="nifty-java-settings">Nifty Java Settings</h2><div class="sectionbody"><div class="paragraph"><p>Before initializing the nifty screens, you set up properties and register media.</p></div>
  564. <table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 50%;"><col style="width: 50%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Nifty Method</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>registerSound("mysound", "Interface/abc.wav");</p></div></div></td><td class="tableblock halign-left valign-top"><div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>registerMusic("mymusic", "Interface/xyz.ogg");</p></div></div></td><td class="tableblock halign-left valign-top"><div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>registerMouseCursor("mypointer", "Interface/abc.png", 5, 4);</p></div></div></td><td class="tableblock halign-left valign-top"><div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>registerEffect(?);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>?</p></div></div></td></tr><tr><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>setDebugOptionPanelColors(true);</p></div></div></td><td class="tableblock halign-left valign-top"><div><div class="paragraph"><p>Highlight all panels, makes it easier to arrange them.</p></div></div></td></tr></tbody></table>
  565. <div class="paragraph"><p>Example:</p></div>
  566. <div class="listingblock"><div class="content"><pre class="CodeRay highlight"><code data-lang="java">nifty.registerMouseCursor(<span class="string"><span class="delimiter">&quot;</span><span class="content">hand</span><span class="delimiter">&quot;</span></span>, <span class="string"><span class="delimiter">&quot;</span><span class="content">Interface/mouse-cursor-hand.png</span><span class="delimiter">&quot;</span></span>, <span class="integer">5</span>, <span class="integer">4</span>);</code></pre></div></div></div></div>
  567. <div class="sect1"><h2 id="next-steps">Next Steps</h2><div class="sectionbody"><div class="paragraph"><p>Integrate the <abbr title="Graphical User Interface">GUI</abbr> into the game. Typically, you will overlay the <abbr title="Graphical User Interface">GUI</abbr>.</p></div>
  568. <div class="ulist"><ul><li><p><a href="../../jme3/advanced/nifty_gui_overlay.html">Nifty GUI Overlay</a> (recommended)</p></li><li><p><a href="../../jme3/advanced/nifty_gui_projection.html">Nifty GUI Projection</a> (optional)</p></li></ul></div></div></div></div><div id="footer"><div id="footer-text">Version <br>Last updated 2019-12-20 23:30:51 +00:00</div></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script><script>docsearch({
  569. apiKey: 'a736b6d93de805e26ec2f49b55013fbd',
  570. indexName: 'jmonkeyengine',
  571. inputSelector: '#doc-search',
  572. debug: false // Set debug to true if you want to inspect the dropdown
  573. });</script></body></html>