fix(sdk): reworking the groups to fix 4164

Author: NaejDoree

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/BufferedGroup.java

@@ -7,7 +7,7 @@
  * This reduces artifacts caused by rounding errors at the cost of lower performance.
  * </p>
  */
-public class BufferedGroup extends Group {
+public class BufferedGroup extends ContainerBasedEntity<BufferedGroup> {
     @Override
     Entity.Type getType() {
         return Entity.Type.BUFFERED_GROUP;

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/ContainerBasedEntity.java

@@ -0,0 +1,63 @@
+package com.codingame.gameengine.module.entities;
+
+import java.util.HashSet;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+/**
+ * 
+ *
+ * @param <T> a subclass inheriting Entity, used in order to return <b>this</b> as a T instead of a <code>ContainerBasedEntity</code>.
+ */
+public abstract class ContainerBasedEntity<T extends Entity<?>> extends Entity<T> {
+
+    private Set<Entity<?>> entities;
+    
+    ContainerBasedEntity() {
+        super();
+
+        entities = new HashSet<>();
+    }
+    /**
+     * Separates the given entity from this <code>ContainerBasedEntity</code>.
+     * 
+     * @param entity
+     *            the <code>Entity</code> to be removed from this ContainerBasedEntity, if it is part of it.
+     */
+    public void remove(Entity<?> entity) {
+        if (entity.parent == this) {
+            entity.parent = null;
+            entities.remove(entity);
+            set("children", asString(entities), null);
+        }
+    }
+
+    /**
+     * Adds the given <code>Entity</code> instances to this <code>ContainerBasedEntity</code>.
+     * <p>
+     * The entities will be displayed within a container controlled by this <code>ContainerBasedEntity</code>.
+     * 
+     * @param entities
+     *            the <code>Entity</code> instances to be added to this ContainerBasedEntity.
+     * @exception IllegalArgumentException
+     *                if at least one given <code>Entity</code> is already in a <code>ContainerBasedEntity</code>.
+     */
+    public void add(Entity<?>... entities) {
+        Stream.of(entities).forEach(entity -> {
+            if (entity.parent != null) {
+                throw new IllegalArgumentException();
+            }
+            this.entities.add(entity);
+        });
+
+        set("children", asString(this.entities), null);
+    }
+
+    private String asString(Set<Entity<?>> entities) {
+        return entities.stream()
+                .map(e -> String.valueOf(e.getId()))
+                .collect(Collectors.joining(","));
+    }
+
+}

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Entity.java

@@ -19,7 +19,7 @@ public abstract class Entity<T extends Entity<?>> {
     private double scaleX = 1, scaleY = 1;
     private boolean visible = true;
     private double rotation, alpha = 1;
-    Group parent;
+    ContainerBasedEntity parent;
     Mask mask;
 
     static enum Type {

engine/modules/entities/src/main/java/com/codingame/gameengine/module/entities/Group.java

@@ -1,61 +1,12 @@
 package com.codingame.gameengine.module.entities;
 
-import java.util.HashSet;
-import java.util.Set;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
 /**
  * A Group is an Entity which acts as a container for other entities.
  */
-public class Group extends Entity<Group> {
-
-    private Set<Entity<?>> entities;
+public class Group extends ContainerBasedEntity<Group> {
 
     Group() {
         super();
-        entities = new HashSet<>();
-    }
-
-    /**
-     * Separates the given entity from this <code>Group</code>.
-     * 
-     * @param entity
-     *            the <code>Entity</code> to be removed from this group, if it is part of it.
-     */
-    public void remove(Entity<?> entity) {
-        if (entity.parent == this) {
-            entity.parent = null;
-            entities.remove(entity);
-            set("children", asString(entities), null);
-        }
-    }
-
-    /**
-     * Adds the given <code>Entity</code> instances to this <code>Group</code>.
-     * <p>
-     * The entities will be displayed within a container controlled by this <code>Group</code>.
-     * 
-     * @param entities
-     *            the <code>Entity</code> instances to be added to this group.
-     * @exception IllegalArgumentException
-     *                if at least one given <code>Entity</code> is already in a <code>Group</code>.
-     */
-    public void add(Entity<?>... entities) {
-        Stream.of(entities).forEach(entity -> {
-            if (entity.parent != null) {
-                throw new IllegalArgumentException();
-            }
-            this.entities.add(entity);
-        });
-
-        set("children", asString(this.entities), null);
-    }
-
-    private String asString(Set<Entity<?>> entities) {
-        return entities.stream()
-                .map(e -> String.valueOf(e.getId()))
-                .collect(Collectors.joining(","));
     }
 
     @Override

engine/modules/entities/src/main/resources/view/entity-module/BufferedGroup.js

@@ -1,10 +1,10 @@
-import { Group } from './Group.js'
 import { getRenderer, flagForDestructionOnReinit } from '../core/rendering.js'
 import { WIDTH, HEIGHT } from '../core/constants.js'
+import { ContainerBasedEntity } from './ContainerBasedEntity.js'
 
 /* global PIXI */
 
-export class BufferedGroup extends Group {
+export class BufferedGroup extends ContainerBasedEntity {
   initDisplay () {
     super.initDisplay()
     this.gameTexture = PIXI.RenderTexture.create(WIDTH, HEIGHT)
@@ -14,10 +14,6 @@ export class BufferedGroup extends Group {
     this.needsRender = true
   }
 
-  updateDisplay (state, changed, globalData) {
-    super.updateDisplay(state, changed, globalData)
-  }
-
   postUpdate () {
     if (this.needsRender) {
       getRenderer().render(this.buffer, this.gameTexture)

engine/modules/entities/src/main/resources/view/entity-module/ContainerBasedEntity.js

@@ -0,0 +1,25 @@
+import { Entity } from './Entity.js'
+
+/* global PIXI */
+
+export class ContainerBasedEntity extends Entity {
+  constructor () {
+    super()
+    Object.assign(this.defaultState, {
+      children: []
+    })
+  }
+
+  initDisplay () {
+    super.initDisplay()
+    this.graphics = new PIXI.Container()
+  }
+
+  updateDisplay (state, changed, globalData) {
+    super.updateDisplay(state, changed, globalData)
+  }
+
+  get childrenContainer () {
+    return this.graphics
+  }
+}

engine/modules/entities/src/main/resources/view/entity-module/Group.js

@@ -1,25 +1,4 @@
-import { Entity } from './Entity.js'
+import { ContainerBasedEntity } from './ContainerBasedEntity.js'
 
-/* global PIXI */
-
-export class Group extends Entity {
-  constructor () {
-    super()
-    Object.assign(this.defaultState, {
-      children: []
-    })
-  }
-
-  initDisplay () {
-    super.initDisplay()
-    this.graphics = new PIXI.Container()
-  }
-
-  updateDisplay (state, changed, globalData) {
-    super.updateDisplay(state, changed, globalData)
-  }
-
-  get childrenContainer () {
-    return this.graphics
-  }
+export class Group extends ContainerBasedEntity {
 }