[WIP] Sectors

engine/src/main/java/org/terasology/entitySystem/entity/EntityBuilder.java

@@ -16,10 +16,13 @@
 package org.terasology.entitySystem.entity;
 
 import com.google.common.collect.Maps;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.terasology.entitySystem.Component;
 import org.terasology.entitySystem.MutableComponentContainer;
 import org.terasology.entitySystem.entity.internal.EngineEntityManager;
 import org.terasology.entitySystem.entity.internal.EntityInfoComponent;
+import org.terasology.entitySystem.prefab.Prefab;
 
 import java.util.Map;
 
@@ -30,11 +33,59 @@
  */
 public class EntityBuilder implements MutableComponentContainer {
 
+
+    private static final Logger logger = LoggerFactory.getLogger(EntityBuilder.class);
+
     private Map<Class<? extends Component>, Component> components = Maps.newHashMap();
-    private EngineEntityManager manager;
+    private EntityCache cache;
+    private EngineEntityManager entityManager;
+
+    private boolean sendLifecycleEvents = true;
+
+    public EntityBuilder(EngineEntityManager entityManager) {
+        this.entityManager = entityManager;
+        this.cache = entityManager.getGlobalCache();
+    }
 
-    public EntityBuilder(EngineEntityManager manager) {
-        this.manager = manager;
+    public EntityBuilder(EngineEntityManager entityManager, EntityCache cache) {
+        this.entityManager = entityManager;
+        this.cache = cache;
+    }
+
+    /**
+     * Adds all of the components from a prefab to this builder
+     *
+     * @param prefabName the name of the prefab to add
+     * @return whether the prefab was successfully added
+     */
+    public boolean addPrefab(String prefabName) {
+        if (prefabName != null && !prefabName.isEmpty()) {
+            Prefab prefab = entityManager.getPrefabManager().getPrefab(prefabName);
+            if (prefab == null) {
+                logger.warn("Unable to instantiate unknown prefab: \"{}\"", prefabName);
+                return false;
+            }
+            addPrefab(prefab);
+            return true;
+        } else {
+            return false;
+        }
+    }
+    /**
+     * Adds all of the components from a prefab to this builder
+     *
+     * @param prefab the prefab to add
+     * @return whether the prefab was successfully added
+     */
+    public void addPrefab(Prefab prefab) {
+        if (prefab != null) {
+            for (Component component : prefab.iterateComponents()) {
+                addComponent(entityManager.getComponentLibrary().copy(component));
+            }
+            addComponent(new EntityInfoComponent(prefab, prefab.isPersisted(), prefab.isAlwaysRelevant()));
+        } else {
+            addComponent(new EntityInfoComponent());
+        }
     }
 
     /**
@@ -43,11 +94,11 @@ public EntityBuilder(EngineEntityManager manager) {
      * @return The built entity.
      */
     public EntityRef build() {
-        return manager.create(components.values());
+        return cache.create(components.values(), sendLifecycleEvents);
     }
 
     public EntityRef buildWithoutLifecycleEvents() {
-        return manager.createEntityWithoutLifecycleEvents(components.values());
+        return cache.create(components.values(), false);
     }
 
     @Override
@@ -113,4 +164,12 @@ private EntityInfoComponent getEntityInfo() {
         return entityInfo;
     }
 
+    public boolean willSendLifecycleEvents() {
+        return sendLifecycleEvents;
+    }
+
+    public void setSendLifecycleEvents(boolean sendLifecycleEvents) {
+        this.sendLifecycleEvents = sendLifecycleEvents;
+    }
+
 }

engine/src/main/java/org/terasology/entitySystem/entity/EntityCache.java

@@ -0,0 +1,181 @@
+/*
+ * Copyright 2017 MovingBlocks
+ *
+ * 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.terasology.entitySystem.entity;
+
+import org.terasology.entitySystem.Component;
+import org.terasology.entitySystem.prefab.Prefab;
+import org.terasology.math.geom.Quat4f;
+import org.terasology.math.geom.Vector3f;
+
+/**
+ */
+public interface EntityCache {
+
+    /**
+     * Removes all entities from the cache.
+     */
+    void clear();
+
+    /**
+     * Creates an EntityBuilder.
+     *
+     * @return A new entity builder
+     */
+    EntityBuilder newBuilder();
+
+    /**
+     * Creates an EntityBuilder, from a prefab
+     *
+     * @return A new entity builder
+     */
+    EntityBuilder newBuilder(String prefabName);
+
+    /**
+     * Creates an EntityBuilder, from a prefab
+     *
+     * @return A new entity builder
+     */
+    EntityBuilder newBuilder(Prefab prefab);
+
+    /**
+     * @return A references to a new, unused entity
+     */
+    EntityRef create();
+
+    /**
+     * @return A references to a new, unused entity with the desired components
+     */
+    EntityRef create(Component... components);
+
+    /**
+     * @return A references to a new, unused entity with the desired components
+     */
+    EntityRef create(Iterable<Component> components);
+
+
+    /**
+     * Creates a new entity from the given components.
+     *
+     * @param components the components to create this entity from
+     * @param sendLifecycleEvents will only send lifecycle events if this is true
+     * @return
+     */
+    EntityRef create(Iterable<Component> components, boolean sendLifecycleEvents);
+
+    /**
+     * @param prefabName The name of the prefab to create.
+     * @return A new entity, based on the the prefab of the given name. If the prefab doesn't exist, just a new entity.
+     */
+    EntityRef create(String prefabName);
+
+    /**
+     * @param prefab
+     * @return A new entity, based on the given prefab
+     */
+    EntityRef create(Prefab prefab);
+
+    // TODO: Review. Probably better to move these into a static helper
+
+    /**
+     * @param prefab
+     * @param position
+     * @return A new entity, based on the given prefab, at the desired position
+     */
+    EntityRef create(String prefab, Vector3f position);
+
+    /**
+     * @param prefab
+     * @param position
+     * @return A new entity, based on the given prefab, at the desired position
+     */
+    EntityRef create(Prefab prefab, Vector3f position);
+
+    /**
+     * @param prefab
+     * @param position
+     * @param rotation
+     * @return
+     */
+    EntityRef create(Prefab prefab, Vector3f position, Quat4f rotation);
+
+    /**
+     * Creates an entity but doesn't send any lifecycle events.
+     * <br><br>
+     * This is used by the block entity system to give an illusion of permanence to temporary block entities.
+     *
+     * @param components
+     * @return The newly created entity ref.
+     */
+    EntityRef createEntityWithoutLifecycleEvents(Iterable<Component> components);
+
+    /**
+     * Creates an entity but doesn't send any lifecycle events.
+     * <br><br>
+     * This is used by the block entity system to give an illusion of permanence to temporary block entities.
+     *
+     * @param prefab
+     * @return The newly created entity ref.
+     */
+    EntityRef createEntityWithoutLifecycleEvents(String prefab);
+
+    EntityRef createEntityWithoutLifecycleEvents(Prefab prefab);
+
+    /**
+     * Allows the creation of an entity with a given id - this is used
+     * when loading persisted entities
+     *
+     * @param id
+     * @param components
+     * @return The entityRef for the newly created entity
+     */
+    EntityRef createEntityWithId(long id, Iterable<Component> components);
+
+    /**
+     * Creates an entity ref with the given id. This is used when loading components with references.
+     *
+     * @param id
+     * @return The entityRef for the given id
+     */
+    EntityRef createEntityRefWithId(long id);
+
+    Iterable<EntityRef> getAllEntities();
+
+    /**
+     * @param componentClasses
+     * @return An iterable over all entities with the provided component types.
+     */
+    Iterable<EntityRef> getEntitiesWith(Class<? extends Component>... componentClasses);
+
+    /**
+     * @param componentClasses
+     * @return A count of entities with the provided component types
+     */
+    int getCountOfEntitiesWith(Class<? extends Component>... componentClasses);
+
+    /**
+     * @return A count of currently active entities
+     */
+    int getActiveEntityCount();
+
+    /**
+     * Gets an entity, if it already exists.
+     *
+     * @param id the id of the desired entity
+     * @return the {@link EntityRef}, if it exists; {@link EntityRef#NULL} otherwise
+     */
+    EntityRef getExistingEntity(long id);
+
+}