using System; using System.Collections.Generic; using System.Reflection; using System.Linq; using Encompass.Exceptions; using MoonTools.Core.Graph; using MoonTools.Core.Graph.Extensions; namespace Encompass { /// /// WorldBuilder is used to construct a World from Engines, Renderers, and an initial state of Entities, Components, and Messages. /// /// /// WorldBuilder enforces certain rules about Engine structure. It is forbidden to have messages create cycles between Engines, /// and no Component may be written by more than one Engine. /// The WorldBuilder uses Engines and their Message read/emit information to determine a valid ordering of the Engines, which is given to the World. /// public class WorldBuilder { private readonly List engines = new List(); private readonly DirectedGraph engineGraph = GraphBuilder.DirectedGraph(); private readonly ComponentStore startingComponentStoreForComponentManager = new ComponentStore(); private readonly ComponentStore startingComponentStoreForComponentUpdateManager = new ComponentStore(); private readonly ComponentManager componentManager; private readonly EntityManager entityManager; private readonly MessageManager messageManager; private readonly ComponentUpdateManager componentUpdateManager; private readonly TimeManager timeManager; private readonly DrawLayerManager drawLayerManager; private readonly RenderManager renderManager; private readonly Dictionary> typeToReaders = new Dictionary>(); private readonly HashSet senders = new HashSet(); private readonly HashSet componentTypesToRegister = new HashSet(); public WorldBuilder() { drawLayerManager = new DrawLayerManager(); timeManager = new TimeManager(); componentUpdateManager = new ComponentUpdateManager(); componentManager = new ComponentManager(drawLayerManager, componentUpdateManager); messageManager = new MessageManager(timeManager); entityManager = new EntityManager(componentManager); renderManager = new RenderManager(drawLayerManager); } /// /// Creates and returns a new empty Entity. /// public Entity CreateEntity() { return entityManager.CreateEntity(); } /// /// Specifies that the given Message should be sent immediately on the first World Update. /// public void SendMessage(TMessage message) where TMessage : struct, IMessage { messageManager.AddMessage(message); } /// /// Specifies that the given Message should be sent after the specified number of seconds after the first World Update. /// public void SendMessage(TMessage message, double time) where TMessage : struct, IMessage { messageManager.AddMessage(message, time); } /// /// Sets Component data for the specified Component Type on the specified Entity. /// public void SetComponent(Entity entity, TComponent component) where TComponent : struct, IComponent { RegisterComponentType(); startingComponentStoreForComponentManager.Set(entity, component); startingComponentStoreForComponentUpdateManager.Set(entity, component); if (component is IDrawableComponent drawableComponent) { componentManager.RegisterDrawableComponent(entity, component, drawableComponent.Layer); } } internal void RegisterComponentType() where TComponent : struct, IComponent { componentManager.RegisterComponentType(); componentUpdateManager.RegisterComponentType(); startingComponentStoreForComponentManager.RegisterComponentType(); startingComponentStoreForComponentUpdateManager.RegisterComponentType(); } internal void AddComponentTypeToRegister(Type componentType) { componentTypesToRegister.Add(componentType); } /// /// Adds the specified Engine to the World. /// /// An instance of an Engine. public Engine AddEngine(TEngine engine) where TEngine : Engine { engine.AssignEntityManager(entityManager); engine.AssignComponentManager(componentManager); engine.AssignMessageManager(messageManager); engine.AssignComponentUpdateManager(componentUpdateManager); engine.AssignTimeManager(timeManager); engines.Add(engine); engineGraph.AddNode(engine); var messageReceiveTypes = engine.receiveTypes; var messageSendTypes = engine.sendTypes; foreach (var writePendingType in engine.writePendingTypes.Intersect(engine.readPendingTypes)) { throw new EngineSelfCycleException("Engine {0} both writes and reads pending Component {1}", engine.GetType().Name, writePendingType.Name); } foreach (var messageType in messageReceiveTypes.Intersect(messageSendTypes)) { throw new EngineSelfCycleException("Engine {0} both receives and sends Message {1}", engine.GetType().Name, messageType.Name); } if (messageSendTypes.Count > 0 || engine.writePendingTypes.Count > 0) { senders.Add(engine); } foreach (var componentType in engine.readTypes.Union(engine.writeTypes).Union(engine.readPendingTypes)) { AddComponentTypeToRegister(componentType); } foreach (var receiveType in engine.receiveTypes.Union(engine.readPendingTypes)) { if (!typeToReaders.ContainsKey(receiveType)) { typeToReaders.Add(receiveType, new HashSet()); } typeToReaders[receiveType].Add(engine); } return engine; } /// /// Registers a draw layer. This must be done before any Renderers are registered. /// /// The draw layer to register. public void RegisterDrawLayer(int layer) { drawLayerManager.RegisterDrawLayer(layer); } /// /// Adds the specified OrderedRenderer to the World. /// public OrderedRenderer AddOrderedRenderer(OrderedRenderer renderer) where TComponent : struct, IComponent, IDrawableComponent { renderer.AssignEntityManager(entityManager); renderer.AssignComponentManager(componentManager); renderManager.RegisterOrderedRenderer(renderer.InternalRender); return renderer; } /// /// Adds the specified GeneralRenderer to the World at the specified layer. /// Higher layer numbers draw on top of lower layer numbers. /// /// An instance of a GeneralRenderer. /// The layer at which the GeneralRenderer should render. Higher numbers draw over lower numbers. public TRenderer AddGeneralRenderer(TRenderer renderer, int layer) where TRenderer : GeneralRenderer { renderer.AssignEntityManager(entityManager); renderer.AssignComponentManager(componentManager); renderManager.RegisterGeneralRendererWithLayer(renderer, layer); return renderer; } private void BuildEngineGraph() { foreach (var senderEngine in senders) { foreach (var messageType in senderEngine.sendTypes.Union(senderEngine.writePendingTypes)) { if (typeToReaders.ContainsKey(messageType)) { foreach (var readerEngine in typeToReaders[messageType]) { if (senderEngine != readerEngine) { if (!engineGraph.Exists(senderEngine, readerEngine)) { engineGraph.AddEdge(senderEngine, readerEngine); } } } } } } } /// /// Builds the World out of the state specified on the WorldBuilder. /// Validates and constructs an ordering of the given Engines. /// /// An instance of World. public World Build() { BuildEngineGraph(); if (engineGraph.Cyclic()) { var cycles = engineGraph.SimpleCycles(); var errorString = "Cycle(s) found in Engines: "; foreach (var cycle in cycles) { var reversed = cycle.Reverse(); errorString += "\n" + string.Join(" -> ", reversed.Select((engine) => engine.GetType().Name)) + " -> " + reversed.First().GetType().Name; } throw new EngineCycleException(errorString); } var writtenComponentTypesWithoutPriority = new HashSet(); var writtenComponentTypesWithPriority = new HashSet(); var duplicateWritesWithoutPriority = new List(); var duplicateWritesWithSamePriority = new List(); var writePriorities = new Dictionary>(); var writeMessageToEngines = new Dictionary>(); foreach (var engine in engines) { if (engine.GetType().GetCustomAttribute() != null) { engine.usesTimeDilation = false; } var defaultWritePriorityAttribute = engine.GetType().GetCustomAttribute(false); foreach (var writeType in engine.writeTypes) { int? priority = null; if (engine.writePriorities.ContainsKey(writeType)) { priority = engine.writePriorities[writeType]; } else if (defaultWritePriorityAttribute != null) { priority = defaultWritePriorityAttribute.writePriority; } if (priority.HasValue) { writtenComponentTypesWithPriority.Add(writeType); if (!writePriorities.ContainsKey(writeType)) { writePriorities[writeType] = new HashSet(); } if (writePriorities[writeType].Contains(priority.Value)) { duplicateWritesWithSamePriority.Add(writeType); } else if (writtenComponentTypesWithoutPriority.Contains(writeType)) { duplicateWritesWithoutPriority.Add(writeType); } else { writePriorities[writeType].Add(priority.Value); } } else { if (writtenComponentTypesWithoutPriority.Contains(writeType) || writtenComponentTypesWithPriority.Contains(writeType)) { duplicateWritesWithoutPriority.Add(writeType); } else { writtenComponentTypesWithoutPriority.Add(writeType); } } if (!writeMessageToEngines.ContainsKey(writeType)) { writeMessageToEngines[writeType] = new List(); } writeMessageToEngines[writeType].Add(engine); } } if (duplicateWritesWithoutPriority.Count > 0) { var errorString = "Multiple Engines write the same Component without declaring priority: "; foreach (var componentType in duplicateWritesWithoutPriority) { errorString += "\n" + componentType.Name + " written by: " + string.Join(", ", writeMessageToEngines[componentType].Select((engine) => engine.GetType().Name)); } errorString += "\nTo resolve the conflict, add priority arguments to the Writes declarations or use a DefaultWritePriority attribute."; throw new EngineWriteConflictException(errorString); } if (duplicateWritesWithSamePriority.Count > 0) { var errorString = "Multiple Engines write the same Component with the same priority: "; foreach (var componentType in duplicateWritesWithSamePriority) { errorString += "\n" + componentType.Name + " written by: " + string.Join(", ", writeMessageToEngines[componentType].Select(engine => engine.GetType().Name)); } errorString += "\nTo resolve the conflict, add priority arguments to the Writes declarations or use a DefaultWritePriority attribute."; throw new EngineWriteConflictException(errorString); } var engineOrder = new List(); foreach (var registeredComponentType in componentTypesToRegister) { var method = typeof(WorldBuilder).GetMethod("RegisterComponentType", BindingFlags.NonPublic | BindingFlags.Instance); var generic = method.MakeGenericMethod(registeredComponentType); generic.Invoke(this, null); var emitterEngine = (Engine)Activator.CreateInstance(typeof(ComponentEmitter<>).MakeGenericType(registeredComponentType)); AddEngine(emitterEngine); engineOrder.Add(emitterEngine); } foreach (var engine in engineGraph.TopologicalSort()) { engineOrder.Add(engine); } var world = new World( engineOrder, entityManager, componentManager, messageManager, componentUpdateManager, timeManager, renderManager ); componentUpdateManager.SetStartingComponentStore(startingComponentStoreForComponentUpdateManager); componentManager.SetComponentStore(startingComponentStoreForComponentManager); return world; } } }