Initial Integration of NUI (Relates to #455)

engine/build.gradle

@@ -6,19 +6,29 @@ import org.reflections.Reflections;
 import org.reflections.scanners.SubTypesScanner;
 import org.reflections.scanners.TypeAnnotationsScanner;
 import org.reflections.util.ConfigurationBuilder;
+import org.reflections.util.ClasspathHelper;
 
 // Dependencies needed for what our Gradle scripts themselves use. It cannot be included via an external Gradle file :-(
 buildscript {
     repositories {
         // External libs - jcenter is Bintray and is supposed to be a superset of Maven Central, but do both just in case
         jcenter()
         mavenCentral()
+
+        // HACK: Needed for NUI reflections
+        mavenLocal()
+        google()
+        maven { url "http://artifactory.terasology.org/artifactory/virtual-repo-live" }
     }
 
     dependencies {
         // Needed for caching reflected data during builds
         classpath 'org.reflections:reflections:0.9.10'
         classpath 'dom4j:dom4j:1.6.1'
+
+        // HACK: Needed for NUI reflections
+        classpath group: 'org.terasology.nui', name: 'nui', version: '2.0.0-SNAPSHOT'
+        classpath group: 'javax.servlet', name: 'javax.servlet-api', version: '3.0.1'
     }
 }
 
@@ -31,6 +41,8 @@ dependencies {
     compile(group: 'org.terasology.gestalt', name: 'gestalt-entity-system', version: '7.0.6-SNAPSHOT')
     compile(group: 'org.terasology.gestalt', name: 'gestalt-module', version: '7.0.6-SNAPSHOT')
     compile(group: 'org.terasology.gestalt', name: 'gestalt-util', version: '7.0.6-SNAPSHOT')
+    compile group: 'org.terasology.nui', name: 'nui', version: '2.0.0'
+    compile group: 'org.terasology.nui', name: 'nui-libgdx', version: '2.0.0'
 
     compile group: 'com.google.protobuf', name: 'protobuf-java', version: '3.4.0'
 
@@ -64,6 +76,7 @@ task cacheReflections {
         dirToReflect.mkdirs()
         Reflections reflections = new Reflections(new ConfigurationBuilder()
                 .addUrls(dirToReflect.toURI().toURL())
+                .addUrls(ClasspathHelper.forPackage("org.terasology.nui.widgets"))
                 .setScanners(new TypeAnnotationsScanner(), new SubTypesScanner()))
         reflections.save(sourceSets.main.output.classesDir.toString() + "/reflections.cache")
     }

engine/src/main/java/org/destinationsol/GameOptions.java

@@ -133,6 +133,7 @@ public Volume advance() {
     public static final int DEFAULT_BUTTON_RIGHT = -1;
     public static final int DEFAULT_MAP_SCROLL_SPEED = 10;
     public static final int DEFAULT_MOBILE_MAP_SCROLL_SPEED = 5;
+    private static final float DEFAULT_NUI_UI_SCALE = 1.0f;
 
     public int x;
     public int y;
@@ -177,6 +178,7 @@ public Volume advance() {
     private int controllerButtonUp;
     private int controllerButtonDown;
     private int mapScrollSpeed;
+    public float nuiUiScale;
 
     private ResolutionProvider resolutionProvider;
 
@@ -226,6 +228,7 @@ public GameOptions(boolean mobile, SolFileReader solFileReader) {
         controllerButtonDown = reader.getInt("controllerButtonDown", DEFAULT_BUTTON_DOWN);
         canSellEquippedItems = reader.getBoolean("canSellEquippedItems", false);
         mapScrollSpeed = reader.getInt("mapScrollSpeed", mobile ? DEFAULT_MOBILE_MAP_SCROLL_SPEED : DEFAULT_MAP_SCROLL_SPEED);
+        nuiUiScale = reader.getFloat("nuiUiScale", DEFAULT_NUI_UI_SCALE);
     }
 
     public void advanceResolution() {
@@ -268,6 +271,13 @@ public void advanceMapScrollSpeed() {
         }
     }
 
+    public void advanceNuiUiScale() {
+        nuiUiScale += 0.25f;
+        if (nuiUiScale > 2.0f) {
+            nuiUiScale = 0.25f;
+        }
+    }
+
     /**
      * Save the configuration settings to file.
      */
@@ -286,7 +296,7 @@ public void save() {
                 "controllerButtonShoot2", getControllerButtonShoot2(), "controllerButtonAbility", getControllerButtonAbility(),
                 "controllerButtonLeft", getControllerButtonLeft(), "controllerButtonRight", getControllerButtonRight(),
                 "controllerButtonUp", getControllerButtonUp(), "controllerButtonDown", getControllerButtonDown(),
-                "mapScrollSpeed", getMapScrollSpeed());
+                "mapScrollSpeed", getMapScrollSpeed(), "nuiUiScale", getNuiUiScale());
     }
 
     /**
@@ -1005,4 +1015,12 @@ public int getMapScrollSpeed() {
     public void setMapScrollSpeed(int mapScrollSpeed) {
         this.mapScrollSpeed = mapScrollSpeed;
     }
+
+    public float getNuiUiScale() {
+        return nuiUiScale;
+    }
+
+    public void setNuiUiScale(float nuiUiScale) {
+        this.nuiUiScale = nuiUiScale;
+    }
 }

engine/src/main/java/org/destinationsol/SolApplication.java

@@ -65,6 +65,7 @@
 import org.destinationsol.ui.SolInputManager;
 import org.destinationsol.ui.SolLayouts;
 import org.destinationsol.ui.UiDrawer;
+import org.destinationsol.ui.nui.NUIManager;
 import org.destinationsol.util.FramerateLimiter;
 import org.destinationsol.util.InjectionHelper;
 import org.slf4j.Logger;
@@ -106,6 +107,7 @@ public class SolApplication implements ApplicationListener {
     private String fatalErrorTrace;
     private SolGame solGame;
     private ParameterAdapterManager parameterAdapterManager;
+    private NUIManager nuiManager;
     private Context context;
     // TODO: Make this non-static.
     public static DisplayDimensions displayDimensions;
@@ -162,6 +164,8 @@ public void create() {
 
         inputManager.setScreen(this, menuScreens.main);
         parameterAdapterManager = ParameterAdapterManager.createCore(this);
+
+        nuiManager = new NUIManager(this, commonDrawer, options);
     }
 
     @Override
@@ -236,6 +240,7 @@ private void update() {
         }
 
         inputManager.update(this);
+        nuiManager.update(this);
 
         if (solGame != null) {
             solGame.update();
@@ -288,6 +293,8 @@ private void draw() {
         }
         uiDrawer.updateMtx();
         inputManager.draw(uiDrawer, this);
+        nuiManager.draw(commonDrawer);
+        inputManager.drawCursor(uiDrawer);
 
         if (solGame != null) {
             solGame.drawDebugUi(uiDrawer);
@@ -400,6 +407,10 @@ public MenuBackgroundManager getMenuBackgroundManager() {
         return menuBackgroundManager;
     }
 
+    public NUIManager getNuiManager() {
+        return nuiManager;
+    }
+
     // TODO: Make this non-static.
     public static void addResizeSubscriber(ResizeSubscriber resizeSubscriber) {
         resizeSubscribers.add(resizeSubscriber);

engine/src/main/java/org/destinationsol/assets/AssetHelper.java

@@ -16,15 +16,18 @@
 package org.destinationsol.assets;
 
 import org.destinationsol.assets.music.AndroidOggMusicFileFormat;
-import org.destinationsol.assets.music.OggMusic;
-import org.destinationsol.assets.music.OggMusicData;
 import org.destinationsol.assets.sound.AndroidOggSoundFileFormat;
-import org.destinationsol.assets.sound.OggSound;
 import org.destinationsol.assets.sound.OggSoundData;
+import org.destinationsol.assets.music.OggMusicData;
+import org.destinationsol.assets.music.OggMusic;
+import org.destinationsol.assets.sound.OggSound;
+import org.destinationsol.assets.ui.UIFormat;
+import org.destinationsol.assets.ui.UISkinFormat;
 import org.terasology.gestalt.assets.Asset;
 import org.terasology.gestalt.assets.AssetData;
 import org.terasology.gestalt.assets.AssetType;
 import org.terasology.gestalt.assets.ResourceUrn;
+import org.terasology.gestalt.assets.format.producer.AssetFileDataProducer;
 import org.terasology.gestalt.assets.module.ModuleAwareAssetTypeManager;
 import org.terasology.gestalt.assets.module.ModuleAwareAssetTypeManagerImpl;
 import org.terasology.gestalt.assets.module.ModuleDependencyResolutionStrategy;
@@ -35,6 +38,13 @@
 import org.terasology.gestalt.entitysystem.prefab.PrefabJsonFormat;
 import org.terasology.gestalt.module.ModuleEnvironment;
 import org.terasology.gestalt.naming.Name;
+import org.terasology.nui.UIWidget;
+import org.terasology.nui.asset.UIElement;
+import org.terasology.nui.reflection.WidgetLibrary;
+import org.terasology.nui.skin.UISkin;
+import org.terasology.reflection.copy.CopyStrategyLibrary;
+import org.terasology.reflection.reflect.ReflectFactory;
+import org.terasology.reflection.reflect.ReflectionReflectFactory;
 
 import java.util.Optional;
 import java.util.Set;
@@ -63,6 +73,20 @@ public void init(ModuleEnvironment environment, ComponentManager componentManage
                                 new ModuleEnvironmentDependencyProvider(environment))),
                 componentManager, assetTypeManager.getAssetManager()).create());
 
+        // The NUI widgets are loaded here so that they can be found when reading the UI JSON files (in UIFormat.UIWidgetTypeAdapter)
+        ReflectFactory reflectFactory = new ReflectionReflectFactory();
+        WidgetLibrary widgetLibrary = new WidgetLibrary(environment, reflectFactory, new CopyStrategyLibrary(reflectFactory));
+        for (Class<? extends UIWidget> widgetClass : environment.getSubtypesOf(UIWidget.class)) {
+            Name moduleName = environment.getModuleProviding(widgetClass);
+            widgetLibrary.register(new ResourceUrn(moduleName, new Name(widgetClass.getSimpleName())), widgetClass);
+        }
+
+        assetTypeManager.createAssetType(UISkin.class, UISkin::new, "skins");
+        ((AssetFileDataProducer)assetTypeManager.getAssetType(UISkin.class).get().getProducers().get(0)).addAssetFormat(new UISkinFormat(widgetLibrary));
+
+        assetTypeManager.createAssetType(UIElement.class, UIElement::new, "ui");
+        ((AssetFileDataProducer)assetTypeManager.getAssetType(UIElement.class).get().getProducers().get(0)).addAssetFormat(new UIFormat(widgetLibrary));
+
         assetTypeManager.switchEnvironment(environment);
     }
 

engine/src/main/java/org/destinationsol/assets/fonts/FontData.java

@@ -17,11 +17,13 @@
 
 import com.badlogic.gdx.graphics.g2d.BitmapFont;
 import org.terasology.gestalt.assets.AssetData;
+import org.terasology.nui.backends.libgdx.LibGDXFont;
 
-public class FontData implements AssetData {
+public class FontData extends LibGDXFont implements AssetData {
     private BitmapFont bitmapFont;
 
     public FontData(BitmapFont bitmapFont) {
+        super(bitmapFont);
         this.bitmapFont = bitmapFont;
     }
 

engine/src/main/java/org/destinationsol/assets/fonts/FontFileFormat.java

@@ -15,8 +15,10 @@
  */
 package org.destinationsol.assets.fonts;
 
+import com.badlogic.gdx.graphics.Texture;
 import com.badlogic.gdx.graphics.g2d.BitmapFont;
 import com.badlogic.gdx.graphics.g2d.TextureRegion;
+import com.badlogic.gdx.utils.Array;
 import org.destinationsol.assets.AssetDataFileHandle;
 import org.destinationsol.assets.Assets;
 import org.terasology.gestalt.assets.ResourceUrn;
@@ -38,12 +40,17 @@ public FontData load(ResourceUrn urn, List<AssetDataFile> inputs) throws IOExcep
         AssetDataFileHandle fontDataHandle = new AssetDataFileHandle(inputs.get(0));
         BitmapFont.BitmapFontData fontData = new BitmapFont.BitmapFontData(fontDataHandle, true);
 
-        String[] fontTexturePath = fontData.imagePaths[0].split("/");
-        String fontTextureName = fontTexturePath[fontTexturePath.length - 1];
-        fontTextureName = fontTextureName.substring(0, fontTextureName.lastIndexOf('.'));
-        TextureRegion fontTexture = new TextureRegion(Assets.getDSTexture(urn.getModuleName() + ":" + fontTextureName).getTexture());
+        TextureRegion[] fontTextures = new TextureRegion[fontData.imagePaths.length];
+        for (int textureNo = 0; textureNo < fontData.imagePaths.length; textureNo++){
+            String[] pathSegments = fontData.imagePaths[textureNo].split("/");
+            String fontTextureName = pathSegments[pathSegments.length - 1];
+            fontTextureName = fontTextureName.substring(0, fontTextureName.lastIndexOf('.'));
+            Texture texture = Assets.getDSTexture(urn.getModuleName() + ":" + fontTextureName).getTexture();
+            TextureRegion fontTexture = new TextureRegion(texture);
+            fontTextures[textureNo] = fontTexture;
+        }
 
-        BitmapFont bitmapFont = new BitmapFont(fontData, fontTexture, false);
+        BitmapFont bitmapFont = new BitmapFont(fontData, Array.with(fontTextures), false);
         bitmapFont.setUseIntegerPositions(false);
         return new FontData(bitmapFont);
     }

engine/src/main/java/org/destinationsol/assets/fonts/UIFont.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright 2020 The Terasology Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.destinationsol.assets.fonts;
+
+import com.badlogic.gdx.graphics.g2d.BitmapFont;
+import com.badlogic.gdx.graphics.g2d.GlyphLayout;
+import org.joml.Vector2i;
+import org.terasology.nui.backends.libgdx.LibGDXFont;
+
+import java.util.List;
+
+/**
+ * This class wraps a {@link Font} asset in order to adapt it to NUI's LibGDX back-end. It handles font scaling,
+ * so that NUI renders correctly.
+ */
+public class UIFont extends LibGDXFont {
+    private float fontScale;
+    private float previousFontScaleX;
+    private float previousFontScaleY;
+    private static final float FONT_SCALE = 8.0f;
+
+    public UIFont(Font font) {
+        super(font.getBitmapFont());
+
+        fontScale = FONT_SCALE / super.getGdxFont().getData().xHeight;
+    }
+
+    private void scale() {
+        scale(fontScale, fontScale);
+    }
+
+    private void scale(float scaleX, float scaleY) {
+        previousFontScaleX = super.getGdxFont().getScaleX();
+        previousFontScaleY = super.getGdxFont().getScaleY();
+        super.getGdxFont().getData().setScale(scaleX, scaleY);
+    }
+
+    private void reset() {
+        super.getGdxFont().getData().setScale(previousFontScaleX, previousFontScaleY);
+    }
+
+    @Override
+    public Vector2i getSize(List<String> lines) {
+        scale();
+        Vector2i result = super.getSize(lines);
+        reset();
+        return result;
+    }
+
+    @Override
+    public int getWidth(Character c) {
+        scale();
+        int result = super.getWidth(c);
+        reset();
+        return result;
+    }
+
+    @Override
+    public int getLineHeight() {
+        scale();
+        int result = super.getLineHeight();
+        reset();
+        return result;
+    }
+
+    @Override
+    public int getHeight(String text) {
+        scale();
+        int result = super.getHeight(text);
+        reset();
+        return result;
+    }
+
+    @Override
+    public int getBaseHeight() {
+        scale();
+        int result = super.getBaseHeight();
+        reset();
+        return result;
+    }
+
+    @Override
+    public int getWidth(String text) {
+        scale();
+        int result = super.getWidth(text);
+        reset();
+        return result;
+    }
+
+    @Override
+    public BitmapFont getGdxFont() {
+        super.getGdxFont().getData().setScale(fontScale, -fontScale);
+        return super.getGdxFont();
+    }
+
+    @Override
+    public GlyphLayout getGlyphLayout() {
+        super.getGdxFont().getData().setScale(fontScale, -fontScale);
+        return super.getGlyphLayout();
+    }
+}