feat: Change ScreenManager to no longer reuse screen instances & improve GWT support. (#26)

Author: crykn

.github/workflows/build-and-test.yml

@@ -0,0 +1,29 @@
+name: Build & Test
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 11
+      uses: actions/setup-java@v3
+      with:
+        java-version: '11'
+        distribution: 'temurin'
+    - name: Fix permissions
+      run: chmod +x gradlew
+    - name: Build with Gradle
+      uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
+      with:
+        arguments: build

README.md

@@ -9,17 +9,16 @@ This library is a screen manager for libGDX games. It allows comfortably changin
 ![](https://raw.githubusercontent.com/crykn/libgdx-screenmanager/master/showcase/gl_transitions_2.gif)
 > ###### A small example using different transitions. Look at the [showcases folder](https://github.com/crykn/libgdx-screenmanager/tree/master/showcase) for more gifs.
 
-* Allows easily **changing the rendered screen**: `game.getScreenManager().pushScreen("screen_name", "transition_name")`
+* Allows easily **changing the rendered screen**: `game.getScreenManager().pushScreen(screen, transition)`
 * Adds **screen transition effects** for when a screen is changed. The included transitions can be found [here](https://github.com/crykn/libgdx-screenmanager/wiki/Available-transitions). Furthermore, transition shaders are supported as well. See the [GL Transitions](https://gl-transitions.com/gallery) project for a collection of some very well made ones.
 * **Automatically registers/unregisters** a screen's **input processors** whenever the screen is shown/hidden
-* There are `create()` methods for screens and transitions that are called _once_ before a screen/transition is shown. This allows easily initializing them, when everything else has already been loaded
 * The whole library is [well documented](https://github.com/crykn/libgdx-screenmanager/wiki) and includes [tests](https://github.com/crykn/libgdx-screenmanager/tree/master/src/test/java) for  everything that isn't graphical
 
 ## Example code
 
-The following example shows how to use libgdx-screenmanager in your code. You can find the full example [here](https://github.com/crykn/libgdx-screenmanager/tree/master/example). 
+The following example shows how to use libgdx-screenmanager in your code. You can find the full example [here](https://github.com/crykn/libgdx-screenmanager/tree/master/src/example). 
 
-The library is very easy to use: The game has to extend `ManagedGame`, all screen have to inherit from `ManagedScreen`. Screens and transitions have to be registered with the screen manager before they can be used. To push a screen `game.getScreenManager().pushScreen("screen-name", "transition-name")` has to be called. If no transition should be used, just call `pushScreen("screen-name", null)`.
+The library is very easy to use: The game has to extend `ManagedGame`, all screen have to inherit from `ManagedScreen`. To push a screen, `game.getScreenManager().pushScreen(screen, transition)` has to be called. If no transition should be used, just call `pushScreen(screen, null)`.
 
 ```java
 public class MyGdxGame extends ManagedGame<ManagedScreen, ScreenTransition> {
@@ -31,18 +30,8 @@ public class MyGdxGame extends ManagedGame<ManagedScreen, ScreenTransition> {
 		// Do some basic stuff
 		this.batch = new SpriteBatch();
 
-		// Add screens
-		this.screenManager.addScreen("green", new GreenScreen());
-		this.screenManager.addScreen("blue", new BlueScreen());
-		// ...
-
-		// Add transitions
-		BlendingScreenTransition blendingTransition = new BlendingScreenTransition(batch, 1F);
-		screenManager.addScreenTransition("blending_transition", blendingTransition);
-		// ... 
-
 		// Push the first screen using a blending transition
-		this.screenManager.pushScreen("green", "blending_transition");
+		this.screenManager.pushScreen(new GreenScreen(), new BlendingScreenTransition(batch, 1F));
 
 		Gdx.app.debug("Game", "Initialization finished.");
 	}
@@ -52,7 +41,7 @@ public class MyGdxGame extends ManagedGame<ManagedScreen, ScreenTransition> {
 
 **Some additional notes:**
 
-* Input processors have to be added in a screen via `ManagedScreen#addInputProcessor(...)`. This is needed so the input processors can be automatically registered/unregistered when the screen is shown/hidden.
+* Input processors should be added in a screen via `ManagedScreen#addInputProcessor(...)`. This has the advantage that they are automatically registered/unregistered when the screen is shown/hidden.
 
 
 ## Documentation

build.gradle

@@ -1,14 +1,18 @@
 apply plugin: "java-library"
 apply plugin: "eclipse"
 apply plugin: "idea"
-apply plugin: "jacoco"
-apply plugin: "maven"
 
-version '0.6.9'
+version '0.7.0'
 
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
+if (JavaVersion.current().isJava9Compatible()) {
+    tasks.withType(Javadoc) {
+        options.addStringOption("-release", "8");
+    }
+}
+
 repositories {
         mavenCentral()
         maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
@@ -35,64 +39,56 @@ task javadocJar(type: Jar, dependsOn: javadoc) {
 artifacts {
     archives sourcesJar
     archives javadocJar
-}
+}	
 
-install {
-  repositories.mavenInstaller {
-    pom.project {
-      licenses {
-        license {
-          name "The Apache Software License, Version 2.0"
-          url "http://www.apache.org/licenses/LICENSE-2.0.txt"
-          distribution "repo"
+// EXAMPLES
+sourceSets {
+    example {
+        compileClasspath += sourceSets.main.output
+        runtimeClasspath += sourceSets.main.output
+        java {
         }
-      }
     }
-  }
 }
 
 // DEPENDENCIES
 ext {
-	gdxVersion = "1.12.0"
-	guacamoleVersion = "0.3.3"
+	gdxVersion = "1.12.1"
+	guacamoleVersion = "v0.3.5"
 
 	// Test dependencies
-	junitVersion = "5.6.0"
-	mockitoVersion = "3.4.4"
+	junitVersion = "5.10.0"
+	mockitoVersion = "4.11.0"
 }
 
 dependencies {
 	implementation "com.badlogicgames.gdx:gdx:$gdxVersion"
 	api "com.github.crykn.guacamole:gdx:$guacamoleVersion" // is exposed because of NestableFrameBuffer
 
-	//testCompile "org.junit.platform:junit-platform-launcher:1.2.0" // needed for a bug in older eclipse versions
-
+	testImplementation "org.junit.platform:junit-platform-launcher:1.2.0" // needed for a bug in older eclipse versions
 	testImplementation "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
-	testImplementation "org.mockito:mockito-core:$mockitoVersion"
+	testImplementation "org.mockito:mockito-inline:$mockitoVersion"
 	testImplementation "com.badlogicgames.gdx:gdx:$gdxVersion"
 	testImplementation "com.badlogicgames.gdx:gdx-backend-headless:$gdxVersion"
 	testImplementation "com.badlogicgames.gdx:gdx-platform:$gdxVersion:natives-desktop"
+	
+	exampleImplementation "com.badlogicgames.gdx:gdx-backend-lwjgl3:$gdxVersion"
+	exampleImplementation "com.badlogicgames.gdx:gdx-platform:$gdxVersion:natives-desktop"
 }
 
-// TESTS & CI
+
+// TESTS
 test {
+	useJUnitPlatform()
     testLogging {
         events "failed"
         exceptionFormat "full"
     }
-    
-    finalizedBy(tasks.jacocoTestReport)
 }
 
-jacocoTestReport {
-    reports {
-        xml.enabled true
-        html.enabled false
-    }
-}
-
-check.dependsOn jacocoTestReport
-
+// Clearing Eclipse project data in root folder
 tasks.eclipse.doLast {
-    delete ".project"
+	delete '.project'
+	delete '.classpath'
+	delete '.settings/'
 }

codecov.yml

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.jar

@@ -1,17 +1,9 @@
+package com.mygame;
+
 import de.eskalon.commons.screen.ManagedScreen;
 
 public class BlankScreen extends ManagedScreen {
 
-	@Override
-	protected void create() {
-		// do nothing
-	}
-
-	@Override
-	public void hide() {
-		// do nothing
-	}
-
 	@Override
 	public void render(float delta) {
 		// do nothing except having the screen cleared

gradle/wrapper/gradle-wrapper.properties

@@ -1,3 +1,5 @@
+package com.mygame;
+
 import com.badlogic.gdx.Gdx;
 import com.badlogic.gdx.InputAdapter;
 import com.badlogic.gdx.graphics.Color;
@@ -7,6 +9,9 @@
 import com.badlogic.gdx.utils.viewport.Viewport;
 
 import de.eskalon.commons.screen.ManagedScreen;
+import de.eskalon.commons.screen.transition.impl.HorizontalSlicingTransition;
+import de.eskalon.commons.screen.transition.impl.SlidingDirection;
+import de.eskalon.commons.screen.transition.impl.SlidingOutTransition;
 
 public class BlueScreen extends ManagedScreen {
 
@@ -16,24 +21,27 @@ public class BlueScreen extends ManagedScreen {
 
 	public BlueScreen() {
 		this.game = (MyGdxGame) Gdx.app.getApplicationListener();
-	}
 
-	@Override
-	protected void create() {
 		this.shapeRenderer = new ShapeRenderer();
 		this.addInputProcessor(new InputAdapter() {
 			@Override
-			public boolean touchDown(int screenX, int screenY, int pointer, int button) {
+			public boolean touchDown(int screenX, int screenY, int pointer,
+					int button) {
 				/*
 				 * Switch using two transitions that are queued.
 				 */
-				game.getScreenManager().pushScreen("blank", "slicing_transition");
-				game.getScreenManager().pushScreen("green", "sliding_out_transition");
+				game.getScreenManager().pushScreen(new BlankScreen(),
+						new HorizontalSlicingTransition(game.getBatch(), 5,
+								1F));
+				game.getScreenManager().pushScreen(new GreenScreen(),
+						new SlidingOutTransition(game.getBatch(),
+								SlidingDirection.DOWN, 0.35F));
 				return true;
 			}
 		});
 
-		this.viewport = new ScreenViewport(); // a ScreenViewport provides the default behaviour
+		this.viewport = new ScreenViewport(); // a ScreenViewport provides the
+												// default behaviour
 	}
 
 	@Override
@@ -46,24 +54,19 @@ public void render(float delta) {
 		 */
 		shapeRenderer.begin(ShapeType.Filled);
 		shapeRenderer.setColor(Color.BLUE);
-		shapeRenderer.triangle(50, 50, game.getWidth() - 50, 50, game.getWidth() / 2, game.getHeight() - 50);
+		shapeRenderer.triangle(50, 50, Gdx.graphics.getWidth() - 50, 50,
+				Gdx.graphics.getWidth() / 2, Gdx.graphics.getHeight() - 50);
 		shapeRenderer.end();
 	}
 
-	@Override
-	public void dispose() {
-		if (isInitialized())
-			shapeRenderer.dispose();
-	}
-
 	@Override
 	public void resize(int width, int height) {
 		viewport.update(width, height, true);
 	}
 
 	@Override
-	public void hide() {
-		// not needed
+	public void dispose() {
+		shapeRenderer.dispose();
 	}
 
 	@Override

example/README.md renamed to src/example/README.md

@@ -1,3 +1,4 @@
+package com.mygame;
 
 import com.badlogic.gdx.backends.lwjgl3.Lwjgl3Application;
 import com.badlogic.gdx.backends.lwjgl3.Lwjgl3ApplicationConfiguration;
@@ -16,7 +17,9 @@ public static void main(String[] args) {
 			// Start the game
 			new Lwjgl3Application(new MyGdxGame(), config);
 		} catch (Exception e) {
-			System.err.println("An unexpected error occurred while starting the game: " + e.getLocalizedMessage());
+			System.err.println(
+					"An unexpected error occurred while starting the game:");
+			e.printStackTrace();
 			System.exit(-1);
 		}
 	}