/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

// Description : Handles management for loading of entities


#ifndef CRYINCLUDE_CRYENTITYSYSTEM_ENTITYLOADMANAGER_H
#define CRYINCLUDE_CRYENTITYSYSTEM_ENTITYLOADMANAGER_H
#pragma once


#include "EntitySystem.h"

class CEntityLoadManager
{
public:
    CEntityLoadManager(CEntitySystem* pEntitySystem);
    ~CEntityLoadManager();

    void Reset();

    bool LoadEntities(XmlNodeRef& entitesNode, bool bIsLoadingLevelFile, std::vector<IEntity*>* outGlobalEntityIds = 0, std::vector<IEntity*>* outLocalEntityIds = 0);

    void HoldLayerEntities(const char* pLayerName);
    void CloneHeldLayerEntities(const char* pLayerName, const Vec3& localOffset, const Matrix34& l2w, const char** pIncludeLayers, int numIncludeLayers);
    void ReleaseHeldEntities();

    void PrepareBatchCreation(int nSize);
    bool CreateEntity(SEntityLoadParams& loadParams, EntityId& outUsingId, bool bIsLoadingLevellFile);
    void OnBatchCreationCompleted();


    // Given a cloned layer id and the original entity id of an entity in that layer, this
    // returns the id of the cloned copy of that entity.
    EntityId GetClonedId(int clonedLayerId, EntityId originalId);

    EntityId FindEntityByEditorGuid(const char* pGuid) const;


    void GetMemoryStatistics(ICrySizer* pSizer) const
    {
        pSizer->Add(*this);
        pSizer->AddContainer(m_queuedAttachments);
    }

    bool    ExtractEntityLoadParams(XmlNodeRef& entityNode, SEntitySpawnParams& outLoadParams) const;
    bool    CreateEntity(XmlNodeRef& entityNode, SEntitySpawnParams& pParams, EntityId& outUsingId);

private:
    // Loading helpers
    bool ReserveEntityIds(XmlNodeRef& entityNode);
    bool CanParseEntity(XmlNodeRef& entityNode, std::vector<IEntity*>* outGlobalEntityIds);
    bool ParseEntities(XmlNodeRef& entityNode, bool bIsLoadingLevelFile, std::vector<IEntity*>* outGlobalEntityIds, std::vector<IEntity*>* outLocalEntityIds);

    bool ExtractEntityLoadParams(XmlNodeRef& entityNode, SEntityLoadParams& outLoadParams, bool bWarningMsg) const;

    // Batch creation helpers
    void AddQueuedAttachment(EntityId nParent, EntityGUID nParentGuid, EntityId nChild, const Vec3& pos, const Quat& rot, const Vec3& scale, bool guid, const int flags, const char* target);
    void AddQueuedEntityLink(IEntity* pEntity, XmlNodeRef& pNode);

    void ResolveLinks();

    bool IsHeldLayer(XmlNodeRef& entityNode);
    void SetupHeldLayer(const char* pLayerName);

    // Attachment queue for post Entity batch creation
    typedef std::vector<SEntityAttachment> TQueuedAttachments;
    TQueuedAttachments m_queuedAttachments;

    // Flowgraph queue for Flowgraph initiation at post Entity batch creation
    struct SQueuedFlowGraph
    {
        IEntity* pEntity;
        XmlNodeRef pNode;

        SQueuedFlowGraph()
            : pEntity(NULL)
            , pNode() {}
    };
    typedef std::vector<SQueuedFlowGraph> TQueuedFlowgraphs;

    TQueuedFlowgraphs m_queuedEntityLinks;
    typedef std::map<uint32, EntityId>  TGuidToId;
    TGuidToId m_guidToId;

    CEntitySystem* m_pEntitySystem;

    struct SHeldLayer
    {
        string m_layerName;
        std::vector<XmlNodeRef> m_entities;
    };
    std::vector<SHeldLayer> m_heldLayers;
    std::map<uint32, int> m_layerNameMap;

    typedef std::map<EntityId, EntityId>    TClonedIds;
    typedef std::vector<TClonedIds>         TClonedLayerEntities;
    TClonedLayerEntities m_clonedLayerIds;
    std::vector<EntityId> m_clonedEntitiesTemp;
};

#endif // CRYINCLUDE_CRYENTITYSYSTEM_ENTITYLOADMANAGER_H