Refactor RewardActor, remove holdtooltip and use CardZoom via ViewRewardScene (#11737)

* Refactor RewardActor, remove holdtooltip and use CardZoom via ViewRewardScene

* remove unnecesary changes

* rename batch, add comment

* return generated image for cardpacks if cached image is not found

* use RewardActor object reference for CardView image

* clear CardView Object, update Zoom renders

* refactor Graphics, cached CardView with objects to clear, limit graphics spritebatch capacity

Author: kevlahnota

forge-game/src/main/java/forge/game/card/CardView.java

@@ -59,6 +59,13 @@ public static CardView getCardForUi(IPaperCard pc) {
         return Card.getCardForUi(pc).getView();
     }
 
+    public Object getObject() {
+        return get(TrackableProperty.Object);
+    }
+    public void clearObject() {
+        set(TrackableProperty.Object, null);
+    }
+
     public static TrackableCollection<CardView> getCollection(Iterable<Card> cards) {
         TrackableCollection<CardView> collection = new TrackableCollection<>();
         if (cards != null) {
@@ -86,6 +93,14 @@ public CardView(final int id0, final Tracker tracker) {
         super(id0, tracker);
         set(TrackableProperty.CurrentState, new CardStateView(id0, CardStateName.Original, tracker));
     }
+    public CardView(final int id0, final Tracker tracker, final String name0, final String description, final Object object) {
+        super(id0, tracker);
+        set(TrackableProperty.CurrentState, new CardStateView(id0, CardStateName.Original, tracker));
+        getCurrentState().setName(name0);
+        getCurrentState().setOracleText(description);
+        set(TrackableProperty.Name, name0);
+        set(TrackableProperty.Object, object);
+    }
     public CardView(final int id0, final Tracker tracker, final String name0) {
         this(id0, tracker);
         getCurrentState().setName(name0);
@@ -94,10 +109,8 @@ public CardView(final int id0, final Tracker tracker, final String name0) {
         set(TrackableProperty.ChangedTypes, new HashMap<String, String>());
         set(TrackableProperty.Sickness, true);
     }
-    public CardView(final int id0, final Tracker tracker, final String name0, final PlayerView ownerAndController, final String imageKey) {
+    public CardView(final int id0, final Tracker tracker, final String name0, final String imageKey) {
         this(id0, tracker, name0);
-        set(TrackableProperty.Owner, ownerAndController);
-        set(TrackableProperty.Controller, ownerAndController);
         set(TrackableProperty.ImageKey, imageKey);
     }
 

forge-game/src/main/java/forge/trackable/TrackableProperty.java

@@ -257,6 +257,7 @@ public enum TrackableProperty {
     PoisonCountersToLose(TrackableTypes.IntegerType),
     PlayerTurn(TrackableTypes.PlayerViewType, FreezeMode.IgnoresFreeze),
     Phase(TrackableTypes.EnumType(PhaseType.class), FreezeMode.IgnoresFreeze),
+    Object(TrackableTypes.ObjectType, FreezeMode.IgnoresFreeze),
     Dependencies(TrackableTypes.StringType);
 
     public enum FreezeMode {

forge-game/src/main/java/forge/trackable/TrackableTypes.java

@@ -133,6 +133,7 @@ protected void copyChangedProps(TrackableObject from, TrackableObject to, Tracka
     public static final TrackableType<Integer> IntegerType = new TrackableType<Integer>(0);
     public static final TrackableType<Float> FloatType = new TrackableType<Float>(0f);
     public static final TrackableType<String> StringType = new TrackableType<String>("");
+    public static final TrackableType<Object> ObjectType = new TrackableType<Object>(null);
 
     //make this quicker than having to define a new class for every single enum
     private static Map<Class<? extends Enum<?>>, TrackableType<?>> enumTypes = Maps.newHashMap();

forge-gui-mobile/src/forge/Adventure.java

@@ -8,14 +8,17 @@
 
 public class Adventure implements Disposable {
     private static Adventure instance;
-    private float animationTimeout;
+    private float transitionTimeout;
     boolean sceneWasSwapped;
-    private SpriteBatch animationBatch, adventureBatch;
+    private SpriteBatch transitionBatch, adventureBatch;
+    public boolean renderTransitionScreen = true;
 
     private Adventure() {
         sceneWasSwapped = false;
-        animationBatch = new SpriteBatch(30);
-        adventureBatch = new SpriteBatch(600);
+        transitionBatch = new SpriteBatch(Forge.LOW_SPRITES_CAP);
+        // adventureBatch is used on UIScene so every scene passed will use this shared batch
+        // instead of creating new SpriteBatch each with default 1000 capacity (14 scenes currently)
+        adventureBatch = new SpriteBatch(Forge.HIGH_SPRITES_CAP);
     }
 
     public SpriteBatch getAdventureBatch() {
@@ -28,41 +31,45 @@ public static Adventure getInstance() {
 
     void render(float delta) {
         try {
-            float transitionTime = 0.12f;
-            if (sceneWasSwapped) {
-                sceneWasSwapped = false;
-                animationTimeout = transitionTime;
-                clear();
-                return;
-            }
-            if (animationTimeout >= 0) {
-                clear();
-                animationBatch.begin();
-                animationTimeout -= delta;
-                animationBatch.setColor(1, 1, 1, 1);
-                animationBatch.draw(ScreenUtil.getInstance().getLastScreenTexture(), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
-                animationBatch.setColor(1, 1, 1, 1 - (1 / transitionTime) * animationTimeout);
-                animationBatch.draw(Forge.getAssets().fallback_skins().get("transition"), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
-                animationBatch.end();
-                if (animationTimeout < 0) {
-                    Forge.currentScene.render();
-                    Forge.storeScreen();
-                    clear();
-                } else {
+            if (renderTransitionScreen) {
+                // Transition Overlay
+                float transitionTime = 0.12f;
+                if (sceneWasSwapped) {
+                    sceneWasSwapped = false;
+                    transitionTimeout = transitionTime;
+                    clearScreen();
+                    return;
+                }
+                if (transitionTimeout >= 0) {
+                    clearScreen();
+                    transitionBatch.begin();
+                    transitionTimeout -= delta;
+                    transitionBatch.setColor(1, 1, 1, 1);
+                    transitionBatch.draw(ScreenUtil.getInstance().getLastScreenTexture(), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
+                    transitionBatch.setColor(1, 1, 1, 1 - (1 / transitionTime) * transitionTimeout);
+                    transitionBatch.draw(Forge.getAssets().fallback_skins().get("transition"), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
+                    transitionBatch.end();
+                    if (transitionTimeout < 0) {
+                        Forge.currentScene.render();
+                        Forge.storeScreen();
+                        clearScreen();
+                    } else {
+                        return;
+                    }
+                }
+                if (transitionTimeout >= -transitionTime) {
+                    clearScreen();
+                    transitionBatch.begin();
+                    transitionTimeout -= delta;
+                    transitionBatch.setColor(1, 1, 1, 1);
+                    transitionBatch.draw(ScreenUtil.getInstance().getLastScreenTexture(), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
+                    transitionBatch.setColor(1, 1, 1, (1 / transitionTime) * (transitionTimeout + transitionTime));
+                    transitionBatch.draw(Forge.getAssets().fallback_skins().get("transition"), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
+                    transitionBatch.end();
                     return;
                 }
             }
-            if (animationTimeout >= -transitionTime) {
-                clear();
-                animationBatch.begin();
-                animationTimeout -= delta;
-                animationBatch.setColor(1, 1, 1, 1);
-                animationBatch.draw(ScreenUtil.getInstance().getLastScreenTexture(), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
-                animationBatch.setColor(1, 1, 1, (1 / transitionTime) * (animationTimeout + transitionTime));
-                animationBatch.draw(Forge.getAssets().fallback_skins().get("transition"), 0, 0, Gdx.graphics.getWidth(), Gdx.graphics.getHeight());
-                animationBatch.end();
-                return;
-            }
+            // Adventure UIScene
             Forge.currentScene.render();
             Forge.currentScene.act(delta);
         } catch (IllegalStateException | NullPointerException ie) {
@@ -71,14 +78,14 @@ void render(float delta) {
         }
     }
 
-    void clear() {
+    void clearScreen() {
         Gdx.gl.glClearColor(0, 0, 0, 1);
         Gdx.gl.glClear(GL20.GL_COLOR_BUFFER_BIT);
     }
     @Override
     public void dispose() {
-        if (animationBatch != null)
-            animationBatch.dispose();
+        if (transitionBatch != null)
+            transitionBatch.dispose();
         if (adventureBatch != null)
             adventureBatch.dispose();
     }

forge-gui-mobile/src/forge/Forge.java

@@ -66,13 +66,7 @@
 import forge.toolbox.FGestureAdapter;
 import forge.toolbox.FOptionPane;
 import forge.toolbox.FOverlay;
-import forge.util.CardTranslation;
-import forge.util.FileUtil;
-import forge.util.HWInfo;
-import forge.util.Localizer;
-import forge.util.OperatingSystem;
-import forge.util.ScreenUtil;
-import forge.util.Utils;
+import forge.util.*;
 import io.sentry.ScopeType;
 import io.sentry.Sentry;
 
@@ -151,6 +145,8 @@ public class Forge implements ApplicationListener {
     public static boolean createNewAdventureMap = false;
     private static Localizer localizer;
     private static boolean desktopAutoOrientation = true;
+    public static final int LOW_SPRITES_CAP = 30; // max capacity for transition, generated image renders
+    public static final int HIGH_SPRITES_CAP = 700; // max sprite capacity for adventure, classic renders
 
     public static ApplicationListener getApp(HWInfo hwInfo, Clipboard clipboard0, IDeviceAdapter deviceAdapter0, String assetDir0, boolean androidOrientation, boolean isTablet, int AndroidAPI) {
         if (app == null) {
@@ -205,7 +201,7 @@ public void create() {
         if (!GuiBase.isAndroid() || (androidVersion > 25 && totalDeviceRAM > 3400)) {
             allowCardBG = true;
         }
-        graphics = new Graphics();
+        graphics = new Graphics(Forge.HIGH_SPRITES_CAP);
         splashScreen = new SplashScreen();
         inputProcessor = new MainInputProcessor();
 
@@ -672,8 +668,11 @@ public static void back(boolean clearLastMatch) {
             exit(false); //prompt to exit if attempting to go back from home screen
             return;
         }
-        if(currentScreen == null)
+        if (currentScreen == null)
             return;
+        // trigger leave
+        if (currentScene instanceof ForgeScene forgeScene)
+            forgeScene.leave();
         currentScreen.onClose(result -> {
             if (result) {
                 Dscreens.pollFirst();
@@ -1029,6 +1028,7 @@ public void dispose() {
         AdventureScreen.dispose();
         Adventure.getInstance().dispose();
         ScreenUtil.getInstance().dispose();
+        ShaderUtil.getInstance().dispose();
         try {
             ExceptionHandler.unregisterErrorHandling();
             if (lastPreview != null)