| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width,initial-scale=1">
- <title>loading_screen :: jMonkeyEngine Docs</title>
- <link rel="canonical" href="https://wiki.jmonkeyengine.org/docs/jme3/advanced/loading_screen.html">
- <meta name="generator" content="Antora 2.3.3">
- <link rel="stylesheet" href="../../../_/css/site.css">
- <meta property="og:image" content="https://mitm001.github.io/docs.jmonkeyengine.org/_/img/iconx128.png">
- <meta property="og:description" content="loading_screen">
- <meta property="og:title" content="jMonkeyEngine Docs">
- <link rel="icon" href="../../../_/img/favicon.ico" type="image/x-icon">
- </head>
- <body class="article">
- <header class="header">
- <nav class="navbar">
- <div class="navbar-brand">
- <a class="navbar-item" href="https://wiki.jmonkeyengine.org">
- <img alt="" src="../../../_/img/iconx128.png" width="32" type="image/x-icon" style="margin-right:16px">
- jMonkeyEngine Docs
- </a>
- <button class="navbar-burger" data-target="topbar-nav">
- <span></span>
- <span></span>
- <span></span>
- </button>
- </div>
- <div id="topbar-nav" class="navbar-menu">
- <div class="navbar-end">
- <div class="navbar-item theme-switch-wrapper">
- <label class="theme-switch" for="checkbox">
- <input type="checkbox" id="checkbox" />
- <div class="slider round"></div>
- </label>
- <p class="navlabel">Dark Mode</p>
- </div>
- <a class="navbar-item" href="https://github.com/jmonkeyengine/wiki">Github</a>
- </div>
- </div>
- </nav>
- </header>
- <div class="body">
- <div class="nav-container" data-component="docs" data-version="master">
- <aside class="nav">
- <div class="panels">
- <div class="nav-panel-menu is-active" data-panel="menu">
- <nav class="nav-menu">
- <h3 class="title"><a href="../../documentation.html">Docs</a></h3>
- <ul class="nav-list">
- <li class="nav-item" data-depth="0">
- <ul class="nav-list">
- <li class="nav-item" data-depth="1">
- <a class="nav-link" href="../../documentation.html">Getting Started</a>
- </li>
- <li class="nav-item" data-depth="1">
- <a class="nav-link" href="https://javadoc.jmonkeyengine.org/v3.3.2-stable">JavaDoc</a>
- </li>
- <li class="nav-item" data-depth="1">
- <button class="nav-item-toggle"></button>
- <a class="nav-link" href="../../jme3.html">jMonkeyEngine 3</a>
- <ul class="nav-list">
- <li class="nav-item" data-depth="2">
- <button class="nav-item-toggle"></button>
- <span class="nav-text">Beginner Tutorials</span>
- <ul class="nav-list">
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_simpleapplication.html">Hello SimpleApplication</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_node.html">Hello Node</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_asset.html">Hello Asset</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_main_event_loop.html">Hello Main Event Loop</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_input_system.html">Hello Input System</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_material.html">Hello Material</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_animation.html">Hello Animation</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_picking.html">Hello Picking</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_collision.html">Hello Collision</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_terrain.html">Hello Terrain</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_audio.html">Hello Audio</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_effects.html">Hello Effects</a>
- </li>
- <li class="nav-item" data-depth="3">
- <a class="nav-link" href="../beginner/hello_physics.html">Hello Physics</a>
- </li>
- </ul>
- </li>
- <li class="nav-item" data-depth="2">
- <button class="nav-item-toggle"></button>
- <span class="nav-text">Intermediate Tutorials</span>
- <ul class="nav-list">
- <li class="nav-item" data-depth="3">
- <button class="nav-item-toggle"></button>
- <span class="nav-text">Concepts</span>
- <ul class="nav-list">
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/best_practices.html">Best Practices</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/simpleapplication.html">Simple Application</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../features.html">Features</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/optimization.html">Optimization</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../faq.html">FAQ</a>
- </li>
- </ul>
- </li>
- <li class="nav-item" data-depth="3">
- <button class="nav-item-toggle"></button>
- <span class="nav-text">Math Concepts</span>
- <ul class="nav-list">
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../math_for_dummies.html">Math For Dummies</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/math.html">Math</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../math.html">More Math</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../rotate.html">Rotate</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../math_video_tutorials.html">Math Video Tutorials</a>
- </li>
- </ul>
- </li>
- <li class="nav-item" data-depth="3">
- <button class="nav-item-toggle"></button>
- <span class="nav-text">3D Graphics Concepts</span>
- <ul class="nav-list">
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/multi-media_asset_pipeline.html">Multi-Media Asset Pipeline</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../scenegraph_for_dummies.html">Scenegraph for Dummies</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../beginner/hellovector.html">Hello Vector</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../terminology.html">Terminology</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/how_to_use_materials.html">How to Use Materials</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../intermediate/transparency_sorting.html">Transparency and Sorting</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../external/blender.html">Importing from Blender</a>
- </li>
- <li class="nav-item" data-depth="4">
- <a class="nav-link" href="../external/3dsmax.html">Importing from 3DS Max</a>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- <li class="nav-item" data-depth="1">
- <a class="nav-link" href="../../logo.html">Logo Usage</a>
- </li>
- <li class="nav-item" data-depth="1">
- <a class="nav-link" href="../../bsd_license.html">License</a>
- </li>
- <li class="nav-item" data-depth="1">
- <a class="nav-link" href="../../github_tips.html">Github Tips</a>
- </li>
- </ul>
- </li>
- <li class="nav-item" data-depth="0">
- <button class="nav-item-toggle"></button>
- <span class="nav-text">SDK</span>
- <ul class="nav-list">
- <li class="nav-item" data-depth="1">
- <a class="nav-link" href="../../sdk.html">jMonkeyEngine SDK</a>
- </li>
- </ul>
- </li>
- </ul>
- </nav>
- </div>
- <div class="nav-panel-explore" data-panel="explore">
- <div class="context">
- <span class="title">Docs</span>
- <span class="version">master</span>
- </div>
- <ul class="components">
- <li class="component is-current">
- <span class="title">Docs</span>
- <ul class="versions">
- <li class="version is-current is-latest">
- <a href="../../documentation.html">master</a>
- </li>
- </ul>
- </li>
- <li class="component">
- <span class="title">Wiki UI</span>
- <ul class="versions">
- <li class="version is-latest">
- <a href="../../../wiki-ui/index.html">master</a>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- </aside>
- </div>
- <main class="article">
- <div class="toolbar" role="navigation">
- <button class="nav-toggle"></button>
- <nav class="breadcrumbs" aria-label="breadcrumbs">
- <ul>
- <li><a href="../../documentation.html">Docs</a></li>
- <li><a href="loading_screen.html">loading_screen</a></li>
- </ul>
- </nav>
- <div class="edit-this-page"><a href="https://github.com/jMonkeyEngine/wiki/edit/master/docs/modules/ROOT/pages/jme3/advanced/loading_screen.adoc">Edit this Page</a></div>
- </div>
- <div class="content">
- <article class="doc">
- <h1 class="page">loading_screen</h1>
- <div class="sect1">
- <h2 id="nifty-loading-screen-progress-bar"><a class="anchor" href="#nifty-loading-screen-progress-bar"></a>Nifty Loading Screen (Progress Bar)</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p>This example will use the existing hello terrain as an example.
- It will require these 2 images inside Assets/Interface/ (save them as border.png and inner.png respectively).</p>
- </div>
- <div class="paragraph">
- <p><span class="image"><img src="../../_images/jme3/advanced/inner1.png" alt="inner1.png" width="" height=""></span></p>
- </div>
- <div class="paragraph">
- <p><span class="image"><img src="../../_images/jme3/advanced/border1.png" alt="border1.png" width="" height=""></span></p>
- </div>
- <div class="paragraph">
- <p>You need to add the jme3-niftygui and <a href="../../sdk/sample_code.html#jme3testdata-assets#" class="page">jme3-test-data</a> libraries.</p>
- </div>
- <div class="paragraph">
- <p>You will need to set your projects source to JDK 8.</p>
- </div>
- <div class="paragraph">
- <p>This is the progress bar at 90%:</p>
- </div>
- <div class="paragraph">
- <p><span class="image"><img src="../../_images/jme3/advanced/loadingscreen.png" alt="loadingscreen.png" width="" height=""></span></p>
- </div>
- <div class="paragraph">
- <p>nifty_loading.xml</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><?xml version="1.0" encoding="UTF-8"?>
- <nifty>
- <useStyles filename="nifty-default-styles.xml" />
- <useControls filename="nifty-default-controls.xml" />
- <controlDefinition name = "loadingbar" controller = "jme3test.TestLoadingScreen">
- <image filename="Interface/border.png" childLayout="absolute"
- imageMode="resize:15,2,15,15,15,2,15,2,15,2,15,15">
- <image id="progressbar" x="0" y="0" filename="Interface/inner.png" width="32px"
- height="100%" imageMode="resize:15,2,15,15,15,2,15,2,15,2,15,15" />
- </image>
- </controlDefinition>
- <screen id="start" controller = "jme3test.TestLoadingScreen">
- <layer id="layer" childLayout="center">
- <panel id = "panel2" height="30%" width="50%" align="center" valign="center"
- childLayout="vertical" visibleToMouse="true">
- <control id="startGame" name="button" backgroundColor="#0000" label="Load Game"
- align="center">
- <interact onClick="showLoadingMenu()" />
- </control>
- </panel>
- </layer>
- </screen>
- <screen id="loadlevel" controller = "jme3test.TestLoadingScreen">
- <layer id="loadinglayer" childLayout="center" backgroundColor="#000000">
- <panel id = "loadingpanel" childLayout="vertical" align="center" valign="center"
- height="32px" width="70%">
- <control name="loadingbar" align="center" valign="center" width="100%"
- height="100%" />
- <control id="loadingtext" name="label" align="center"
- text=" "/>
- </panel>
- </layer>
- </screen>
- <screen id="end" controller = "jme3test.TestLoadingScreen">
- </screen>
- </nifty></code></pre>
- </div>
- </div>
- <div class="sect2">
- <h3 id="understanding-nifty-xml"><a class="anchor" href="#understanding-nifty-xml"></a>Understanding Nifty XML</h3>
- <div class="paragraph">
- <p>The progress bar and text is done statically using nifty XML.
- A custom control is created, which represents the progress bar.</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><controlDefinition name = "loadingbar" controller = "jme3test.TestLoadingScreen">
- <image filename="Interface/border.png" childLayout="absolute"
- imageMode="resize:15,2,15,15,15,2,15,2,15,2,15,15">
- <image id="progressbar" x="0" y="0" filename="Interface/inner.png" width="32px"
- height="100%" imageMode="resize:15,2,15,15,15,2,15,2,15,2,15,15"/>
- </image>
- </controlDefinition></code></pre>
- </div>
- </div>
- <div class="paragraph">
- <p>This screen simply displays a button in the middle of the screen, which could be seen as a simple main menu UI.</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><screen id="start" controller = "jme3test.TestLoadingScreen">
- <layer id="layer" childLayout="center">
- <panel id = "panel2" height="30%" width="50%" align="center" valign="center"
- childLayout="vertical" visibleToMouse="true">
- <control id="startGame" name="button" backgroundColor="#0000" label="Load Game"
- align="center"> <interact onClick="showLoadingMenu()" />
- </control>
- </panel>
- </layer>
- </screen></code></pre>
- </div>
- </div>
- <div class="paragraph">
- <p>This screen displays our custom progress bar control with a text control.</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><screen id="loadlevel" controller = "jme3test.TestLoadingScreen">
- <layer id="loadinglayer" childLayout="center" backgroundColor="#000000">
- <panel id = "loadingpanel" childLayout="vertical" align="center" valign="center"
- height="32px" width="400px">
- <control name="loadingbar" align="center" valign="center" width="400px"
- height="32px" />
- <control id="loadingtext" name="label" align="center"
- text=" "/>
- </panel>
- </layer>
- </screen></code></pre>
- </div>
- </div>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="creating-the-bindings-to-use-the-nifty-xml"><a class="anchor" href="#creating-the-bindings-to-use-the-nifty-xml"></a>Creating the bindings to use the Nifty XML</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p>There are 3 main ways to update a progress bar. To understand why these methods are necessary, an understanding of the graphics pipeline is needed.</p>
- </div>
- <div class="paragraph">
- <p>Something like this in a single thread will not work:</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">load_scene();
- update_bar(30%);
- load_characters();
- update_bar(60%);
- load_sounds();
- update_bar(100%);</code></pre>
- </div>
- </div>
- <div class="paragraph">
- <p>If you do all of this in a single frame, then it is sent to the graphics card only after the whole code block has executed. By this time the bar has reached 100% and the game has already begun – for the user, the progressbar on the screen would not have visibly changed.</p>
- </div>
- <div class="paragraph">
- <p>The 2 main good solutions are:</p>
- </div>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>Updating explicitly over many frames</p>
- </li>
- <li>
- <p>Multi-threading</p>
- </li>
- </ol>
- </div>
- <div class="sect2">
- <h3 id="updating-progress-bar-over-a-number-of-frames"><a class="anchor" href="#updating-progress-bar-over-a-number-of-frames"></a>Updating progress bar over a number of frames</h3>
- <div class="paragraph">
- <p>The idea is to break down the loading of the game into discrete parts.</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">package jme3test;
- import com.jme3.app.SimpleApplication;
- import com.jme3.material.Material;
- import com.jme3.niftygui.NiftyJmeDisplay;
- import static com.jme3.niftygui.NiftyJmeDisplay.newNiftyJmeDisplay;
- import com.jme3.renderer.Camera;
- import com.jme3.terrain.geomipmap.TerrainLodControl;
- import com.jme3.terrain.geomipmap.TerrainQuad;
- import com.jme3.terrain.heightmap.AbstractHeightMap;
- import com.jme3.terrain.heightmap.ImageBasedHeightMap;
- import com.jme3.texture.Texture;
- import com.jme3.texture.Texture.WrapMode;
- import de.lessvoid.nifty.Nifty;
- import de.lessvoid.nifty.controls.Controller;
- import de.lessvoid.nifty.controls.Parameters;
- import de.lessvoid.nifty.elements.Element;
- import de.lessvoid.nifty.elements.render.TextRenderer;
- import de.lessvoid.nifty.input.NiftyInputEvent;
- import de.lessvoid.nifty.screen.Screen;
- import de.lessvoid.nifty.screen.ScreenController;
- import de.lessvoid.nifty.tools.SizeValue;
- import java.util.ArrayList;
- import java.util.List;
- /**
- * This is the TestLoadingScreen Class of your Game. You should only do
- * initialization here. Move your Logic into AppStates or Controls
- *
- * @author normenhansen
- */
- public class TestLoadingScreen extends SimpleApplication implements
- ScreenController, Controller {
- private NiftyJmeDisplay niftyDisplay;
- private Nifty nifty;
- private Element progressBarElement;
- private TerrainQuad terrain;
- private Material mat_terrain;
- private float frameCount = 0;
- private boolean load = false;
- private TextRenderer textRenderer;
- public static void main(String[] args) {
- TestLoadingScreen app = new TestLoadingScreen();
- app.start();
- }
- @Override
- public void simpleInitApp() {
- flyCam.setEnabled(false);
- niftyDisplay = newNiftyJmeDisplay(assetManager,
- inputManager,
- audioRenderer,
- guiViewPort);
- nifty = niftyDisplay.getNifty();
- nifty.fromXml("Interface/nifty_loading.xml", "start", this);
- guiViewPort.addProcessor(niftyDisplay);
- }
- @Override
- public void simpleUpdate(float tpf) {
- if (load) { //loading is done over many frames
- if (frameCount == 1) {
- Element element = nifty.getScreen("loadlevel").findElementById(
- "loadingtext");
- textRenderer = element.getRenderer(TextRenderer.class);
- mat_terrain = new Material(assetManager,
- "Common/MatDefs/Terrain/Terrain.j3md");
- mat_terrain.setTexture("Alpha", assetManager.loadTexture(
- "Textures/Terrain/splat/alphamap.png"));
- setProgress(0.2f, "Loading grass");
- } else if (frameCount == 2) {
- Texture grass = assetManager.loadTexture(
- "Textures/Terrain/splat/grass.jpg");
- grass.setWrap(WrapMode.Repeat);
- mat_terrain.setTexture("Tex1", grass);
- mat_terrain.setFloat("Tex1Scale", 64f);
- setProgress(0.4f, "Loading dirt");
- } else if (frameCount == 3) {
- Texture dirt = assetManager.loadTexture(
- "Textures/Terrain/splat/dirt.jpg");
- dirt.setWrap(WrapMode.Repeat);
- mat_terrain.setTexture("Tex2", dirt);
- mat_terrain.setFloat("Tex2Scale", 32f);
- setProgress(0.5f, "Loading rocks");
- } else if (frameCount == 4) {
- Texture rock = assetManager.loadTexture(
- "Textures/Terrain/splat/road.jpg");
- rock.setWrap(WrapMode.Repeat);
- mat_terrain.setTexture("Tex3", rock);
- mat_terrain.setFloat("Tex3Scale", 128f);
- setProgress(0.6f, "Creating terrain");
- } else if (frameCount == 5) {
- AbstractHeightMap heightmap = null;
- Texture heightMapImage = assetManager.loadTexture(
- "Textures/Terrain/splat/mountains512.png");
- heightmap = new ImageBasedHeightMap(heightMapImage.getImage());
- heightmap.load();
- terrain = new TerrainQuad("my terrain", 65, 513, heightmap.
- getHeightMap());
- setProgress(0.8f, "Positioning terrain");
- } else if (frameCount == 6) {
- terrain.setMaterial(mat_terrain);
- terrain.setLocalTranslation(0, -100, 0);
- terrain.setLocalScale(2f, 1f, 2f);
- rootNode.attachChild(terrain);
- setProgress(0.9f, "Loading cameras");
- } else if (frameCount == 7) {
- List<Camera> cameras = new ArrayList<>();
- cameras.add(getCamera());
- TerrainLodControl control = new TerrainLodControl(terrain,
- cameras);
- terrain.addControl(control);
- setProgress(1f, "Loading complete");
- } else if (frameCount == 8) {
- nifty.gotoScreen("end");
- nifty.exit();
- guiViewPort.removeProcessor(niftyDisplay);
- flyCam.setEnabled(true);
- flyCam.setMoveSpeed(50);
- }
- frameCount++;
- }
- }
- public void setProgress(final float progress, String loadingText) {
- final int MIN_WIDTH = 32;
- int pixelWidth = (int) (MIN_WIDTH + (progressBarElement.getParent().
- getWidth() - MIN_WIDTH) * progress);
- progressBarElement.setConstraintWidth(new SizeValue(pixelWidth + "px"));
- progressBarElement.getParent().layoutElements();
- textRenderer.setText(loadingText);
- }
- public void showLoadingMenu() {
- nifty.gotoScreen("loadlevel");
- load = true;
- }
- @Override
- public void onStartScreen() {
- }
- @Override
- public void onEndScreen() {
- }
- @Override
- public void bind(Nifty nifty, Screen screen) {
- progressBarElement = nifty.getScreen("loadlevel").findElementById(
- "progressbar");
- }
- // methods for Controller
- @Override
- public boolean inputEvent(final NiftyInputEvent inputEvent) {
- return false;
- }
- @Override
- public void onFocus(boolean getFocus) {
- }
- @Override
- public void bind(Nifty nifty, Screen screen, Element elmnt,
- Parameters prmtrs) {
- progressBarElement = elmnt.findElementById("progressbar");
- }
- @Override
- public void init(Parameters prmtrs) {
- }
- }</code></pre>
- </div>
- </div>
- <div class="admonitionblock note">
- <table>
- <tr>
- <td class="icon">
- <i class="fa icon-note" title="Note"></i>
- </td>
- <td class="content">
- Try and add all controls near the end, as their update loops may begin executing.
- </td>
- </tr>
- </table>
- </div>
- </div>
- <div class="sect2">
- <h3 id="using-multithreading"><a class="anchor" href="#using-multithreading"></a>Using multithreading</h3>
- <div class="paragraph">
- <p>For more info on multithreading: <a href="multithreading.html" class="page">The jME3 Threading Model</a></p>
- </div>
- <div class="paragraph">
- <p>Make sure to change the XML file to point the controller to TestLoadingScreen*1*.</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">package jme3test;
- import com.jme3.app.SimpleApplication;
- import com.jme3.material.Material;
- import com.jme3.niftygui.NiftyJmeDisplay;
- import static com.jme3.niftygui.NiftyJmeDisplay.newNiftyJmeDisplay;
- import com.jme3.renderer.Camera;
- import com.jme3.terrain.geomipmap.TerrainLodControl;
- import com.jme3.terrain.geomipmap.TerrainQuad;
- import com.jme3.terrain.heightmap.AbstractHeightMap;
- import com.jme3.terrain.heightmap.ImageBasedHeightMap;
- import com.jme3.texture.Texture;
- import com.jme3.texture.Texture.WrapMode;
- import de.lessvoid.nifty.Nifty;
- import de.lessvoid.nifty.controls.Controller;
- import de.lessvoid.nifty.controls.Parameters;
- import de.lessvoid.nifty.elements.Element;
- import de.lessvoid.nifty.elements.render.TextRenderer;
- import de.lessvoid.nifty.input.NiftyInputEvent;
- import de.lessvoid.nifty.screen.Screen;
- import de.lessvoid.nifty.screen.ScreenController;
- import de.lessvoid.nifty.tools.SizeValue;
- import java.util.ArrayList;
- import java.util.List;
- import java.util.concurrent.Callable;
- import java.util.concurrent.ExecutorService;
- import java.util.concurrent.Executors;
- import java.util.concurrent.Future;
- import java.util.concurrent.ScheduledExecutorService;
- import java.util.concurrent.TimeUnit;
- import java.util.logging.Level;
- import java.util.logging.Logger;
- public class TestLoadingScreen1 extends SimpleApplication implements
- ScreenController, Controller {
- private NiftyJmeDisplay niftyDisplay;
- private Nifty nifty;
- private Element progressBarElement;
- private TerrainQuad terrain;
- private Material mat_terrain;
- private boolean load = false;
- private ScheduledExecutorService exec = Executors.newScheduledThreadPool(2);
- private Future loadFuture = null;
- private TextRenderer textRenderer;
- private static final Logger LOG = Logger.getLogger(TestLoadingScreen1.class.
- getName());
- public static void main(String[] args) {
- TestLoadingScreen1 app = new TestLoadingScreen1();
- app.start();
- }
- @Override
- public void simpleInitApp() {
- flyCam.setEnabled(false);
- niftyDisplay = newNiftyJmeDisplay(assetManager,
- inputManager,
- audioRenderer,
- guiViewPort);
- nifty = niftyDisplay.getNifty();
- nifty.fromXml("Interface/nifty_loading.xml", "start", this);
- guiViewPort.addProcessor(niftyDisplay);
- }
- @Override
- public void simpleUpdate(float tpf) {
- if (load) {
- if (loadFuture == null) {
- //if we have not started loading, submit Callable to executor
- loadFuture = exec.submit(loadingCallable);
- }
- //check if the execution on the other thread is done
- if (loadFuture.isDone()) {
- //these calls have to be done on the update loop thread,
- //especially attaching the terrain to the rootNode
- //after it is attached, it's managed by the update loop thread
- // and may not be modified from any other thread anymore!
- nifty.gotoScreen("end");
- nifty.exit();
- guiViewPort.removeProcessor(niftyDisplay);
- flyCam.setEnabled(true);
- flyCam.setMoveSpeed(50);
- rootNode.attachChild(terrain);
- load = false;
- }
- }
- }
- //This is the callable that contains the code that is run on the other
- //thread.
- //Since the assetmananger is threadsafe, it can be used to load data from
- //any thread.
- //We do *not* attach the objects to the rootNode here!
- Callable<Void> loadingCallable = new Callable<Void>() {
- @Override
- public Void call() {
- Element element = nifty.getScreen("loadlevel").findElementById(
- "loadingtext");
- textRenderer = element.getRenderer(TextRenderer.class);
- mat_terrain = new Material(assetManager,
- "Common/MatDefs/Terrain/Terrain.j3md");
- mat_terrain.setTexture("Alpha", assetManager.loadTexture(
- "Textures/Terrain/splat/alphamap.png"));
- //setProgress is thread safe (see below)
- setProgress(0.2f, "Loading grass");
- Texture grass = assetManager.loadTexture(
- "Textures/Terrain/splat/grass.jpg");
- grass.setWrap(WrapMode.Repeat);
- mat_terrain.setTexture("Tex1", grass);
- mat_terrain.setFloat("Tex1Scale", 64f);
- setProgress(0.4f, "Loading dirt");
- Texture dirt = assetManager.loadTexture(
- "Textures/Terrain/splat/dirt.jpg");
- dirt.setWrap(WrapMode.Repeat);
- mat_terrain.setTexture("Tex2", dirt);
- mat_terrain.setFloat("Tex2Scale", 32f);
- setProgress(0.5f, "Loading rocks");
- Texture rock = assetManager.loadTexture(
- "Textures/Terrain/splat/road.jpg");
- rock.setWrap(WrapMode.Repeat);
- mat_terrain.setTexture("Tex3", rock);
- mat_terrain.setFloat("Tex3Scale", 128f);
- setProgress(0.6f, "Creating terrain");
- AbstractHeightMap heightmap = null;
- Texture heightMapImage = assetManager.loadTexture(
- "Textures/Terrain/splat/mountains512.png");
- heightmap = new ImageBasedHeightMap(heightMapImage.getImage());
- heightmap.load();
- terrain = new TerrainQuad("my terrain", 65, 513, heightmap.
- getHeightMap());
- setProgress(0.8f, "Positioning terrain");
- terrain.setMaterial(mat_terrain);
- terrain.setLocalTranslation(0, -100, 0);
- terrain.setLocalScale(2f, 1f, 2f);
- setProgress(0.9f, "Loading cameras");
- List<Camera> cameras = new ArrayList<>();
- cameras.add(getCamera());
- TerrainLodControl control = new TerrainLodControl(terrain, cameras);
- terrain.addControl(control);
- setProgress(1f, "Loading complete");
- return null;
- }
- };
- public void setProgress(final float progress, final String loadingText) {
- //Since this method is called from another thread, we enqueue the
- //changes to the progressbar to the update loop thread.
- enqueue(() -> {
- final int MIN_WIDTH = 32;
- int pixelWidth = (int) (MIN_WIDTH + (progressBarElement.getParent().
- getWidth() - MIN_WIDTH) * progress);
- progressBarElement.setConstraintWidth(new SizeValue(pixelWidth
- + "px"));
- progressBarElement.getParent().layoutElements();
- textRenderer.setText(loadingText);
- return null;
- });
- }
- public void showLoadingMenu() {
- nifty.gotoScreen("loadlevel");
- load = true;
- }
- @Override
- public void onStartScreen() {
- }
- @Override
- public void onEndScreen() {
- }
- @Override
- public void bind(Nifty nifty, Screen screen) {
- progressBarElement = nifty.getScreen("loadlevel").findElementById(
- "progressbar");
- }
- // methods for Controller
- @Override
- public boolean inputEvent(final NiftyInputEvent inputEvent) {
- return false;
- }
- @Override
- public void onFocus(boolean getFocus) {
- }
- @Override
- public void destroy() {
- super.destroy();
- shutdownAndAwaitTermination(exec);
- }
- //standard shutdown process for executor
- private void shutdownAndAwaitTermination(ExecutorService pool) {
- pool.shutdown(); // Disable new tasks from being submitted
- try {
- // Wait a while for existing tasks to terminate
- if (!pool.awaitTermination(6, TimeUnit.SECONDS)) {
- pool.shutdownNow(); // Cancel currently executing tasks
- // Wait a while for tasks to respond to being cancelled
- if (!pool.awaitTermination(6, TimeUnit.SECONDS)) {
- LOG.log(Level.SEVERE, "Pool did not terminate {0}", pool);
- }
- }
- } catch (InterruptedException ie) {
- // (Re-)Cancel if current thread also interrupted
- pool.shutdownNow();
- // Preserve interrupt status
- Thread.currentThread().interrupt();
- }
- }
- @Override
- public void bind(Nifty nifty, Screen screen, Element elmnt,
- Parameters prmtrs) {
- progressBarElement = elmnt.findElementById("progressbar");
- }
- @Override
- public void init(Parameters prmtrs) {
- }
- }</code></pre>
- </div>
- </div>
- </div>
- </div>
- </div>
- </article>
- <aside class="toc sidebar" data-title="Contents" data-levels="2">
- <div class="toc-menu"></div>
- </aside>
- </div>
- </main>
- </div>
- <footer class="footer">
- <p>Copyright 2020 jMonkeyEngine Wiki Contributors. Licensed BSD-3.</p>
- </footer>
- <script src="../../../_/js/site.js"></script>
- <script async src="../../../_/js/vendor/highlight.js"></script>
- </body>
- </html>
|