navdata.h

Go to the documentation of this file.

/*
* Copyright 2015 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

// primary contact: JUBA - secondary contact: GUAL
#ifndef Navigation_NavData_H
#define Navigation_NavData_H

#include "gwnavruntime/blob/blobaggregate.h"
#include "gwnavruntime/world/worldelement.h"
#include "gwnavruntime/navmesh/navmeshtypes.h"
#include "gwnavruntime/navdata/sectordescriptor.h"

namespace Kaim
{

class NavMeshElement;
class NavMeshElementBlob;
class NavGraph;
class NavGraphBlob;
class NavGraphBlobBuilder;
class AbstractGraph;
class AbstractGraphBlob;
class Database;
class VisualDebugServer;
class KyGuid;

class NavData : public WorldElement
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
    KY_CLASS_WITHOUT_COPY(NavData)

public:
    static  WorldElementType GetStaticType()       { return TypeNavData; }
    virtual WorldElementType GetType()       const { return TypeNavData; }
    virtual const char*      GetTypeName()   const { return "NavData";   }
    virtual void DoSendVisualDebug(VisualDebugServer& server, VisualDebugSendChangeEvent changeEvent);

    // ---------------------------------- Public Member Functions ----------------------------------


    enum DatabaseStatus
    {
        NotReferencedInAnyDatabase = 0, 
        ToBeAdded_NotAlive         = 1, 
        BeingAdded_NotAlive        = 2, 
        AddedToDabase_Alive        = 3, 
        ToBeRemoved_Alive          = 4, 
        BeingRemoved_Alive         = 5  
    };


    NavData(Database* database = KY_NULL); // call Init
    virtual ~NavData();

    Database*      GetDatabase()       const;
    DatabaseStatus GetDatabaseStatus() const;
    
    const KyGuid*  GetMainGuid()       const;
    
    const String& GetSectorName() const;
    const String& GetGeneratorRelativeOutputDirectory() const;

    // ---------------------------------- Memory loading or sharing Functions ----------------------------------

    KyResult Load(const char* fileName, FileOpenerBase* fileOpener = KY_NULL);
    KyResult Load(File* file);
    KyResult LoadFromMemory(void* memory);

    KyResult Save(const char* fileName, FileOpenerBase* fileOpener = KY_NULL, Endianness::Type endianness = Endianness::BigEndian);

    void SetBlobAggregate(BlobAggregate* BlobAggregate);


    // ---------------------------------- Main API Functions ----------------------------------

    KyResult Init(Database* database);

    KyResult AddNavGraph(NavGraphBlobBuilder* navGraphBlobBuilder);

    KyResult AddToDatabaseAsync(); 

    KyResult RemoveFromDatabaseAsync();

    KyResult AddToDatabaseImmediate();

    KyResult RemoveFromDatabaseImmediate();

    bool IsAliveInDatabase() const;

    bool IsCompatibleWith(const NavData& navData) const;

public: //internal 
    void ComputeCellBoxOfNavMeshes();
    void ComputeCellBoxOfNavGraphs();
    void ComputeCellBoxOfAbstractGraphs();

    void OnNavDataBeeingAdded();
    void OnNavDataAdditionFinished();
    void OnNavDataBeeingRemoved();
    void OnNavDataRemoveFinished();

    BlobAggregate::Collection<NavMeshElementBlob>  GetNavMeshElementBlobCollection()  const;
    BlobAggregate::Collection<NavGraphBlob> GetNavGraphBlobCollection() const;
    BlobAggregate::Collection<AbstractGraphBlob> GetAbstractGraphBlobCollection() const;

    void OnLinkInfoChange();

    void AddSectorDescriptorToBlobAggregate();
    KyUInt32 GetMainNavMeshElementIndexInCollection() const;

public: //internal 
    Database* m_database;
    DatabaseStatus m_databaseStatus;
    Ptr<BlobAggregate> m_blobAggregate; // do not set m_blobAggregate directly, use SetBlobAggregate()
    KyArrayPOD<NavMeshElement* , MemStat_NavData> m_navMeshElements;
    KyArrayPOD<NavGraph*, MemStat_NavData> m_navGraphs;
    KyArrayPOD<AbstractGraph*, MemStat_NavData> m_abstractGraphs;
    CellBox m_navDataCellBox;
    SectorDescriptor m_sectorDescriptor;

    enum VisualDebugStatus { VisualDebugStatus_NothingToSend, VisualDebugStatus_SendALL, VisualDebugStatus_SendGraphLinkInfo };
    VisualDebugStatus m_visualDebugStatus; // visual debug purpose
};

KY_INLINE NavData::NavData(Database* database) 
    : m_database(KY_NULL)
    , m_databaseStatus(NotReferencedInAnyDatabase)
    , m_visualDebugStatus(VisualDebugStatus_NothingToSend)
{
    Init(database);
}

KY_INLINE NavData::~NavData() {}

KY_INLINE bool NavData::IsAliveInDatabase() const 
{ return m_databaseStatus == AddedToDabase_Alive || m_databaseStatus == ToBeRemoved_Alive || m_databaseStatus == BeingRemoved_Alive; }

KY_INLINE NavData::DatabaseStatus NavData::GetDatabaseStatus() const { return m_databaseStatus; }
KY_INLINE Database*               NavData::GetDatabase()       const { return m_database;       }

KY_INLINE void NavData::OnNavDataBeeingAdded()                         { m_databaseStatus = NavData::BeingAdded_NotAlive;   }
KY_INLINE void NavData::OnNavDataBeeingRemoved()                       { m_databaseStatus = NavData::BeingRemoved_Alive; }

KY_INLINE void NavData::OnNavDataAdditionFinished()
{
    m_databaseStatus = NavData::AddedToDabase_Alive;
    m_visualDebugStatus = VisualDebugStatus_SendALL;
    RegisterToVisualDebug();
}

KY_INLINE void NavData::OnNavDataRemoveFinished()
{
    m_databaseStatus = NavData::NotReferencedInAnyDatabase; 
    UnRegisterFromVisualDebug();
}

KY_INLINE void NavData::OnLinkInfoChange()
{
    if (m_visualDebugStatus == VisualDebugStatus_NothingToSend)
        m_visualDebugStatus = VisualDebugStatus_SendGraphLinkInfo;
}


}


#endif