navcellgrid.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: NOBODY
#ifndef Navigation_NavcellGrid_H
#define Navigation_NavcellGrid_H

#include "gwnavruntime/containers/iterablepool.h"
#include "gwnavruntime/navgraph/identifiers/navgraphvertexptr.h"
#include "gwnavruntime/database/activedata.h"
#include "gwnavruntime/database/navfloorstitcher.h"
#include "gwnavruntime/database/activenavfloorcollection.h"
#include "gwnavruntime/database/smallptrtrackedcollection.h"
#include "gwnavruntime/querysystem/iquery.h"


namespace Kaim
{

class NavCellBlob;
class NavCell;
class NavMeshElement;
class NavGraphManager;
class NavGraphLinker;
class ActiveGuids;
class Database;
class DynamicNavMeshQuery;
class TagVolume;
class StaticToDynamicHalfEdge;

typedef Collection<NavGraphVertexRawPtr, MemStat_NavData> NavGraphVertexCollection;
typedef Collection<Ptr<TagVolume>, MemStat_NavData> TagVolumeCollection;

class NavCellPosInfo
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
public:
    NavCellPosInfo();
    ~NavCellPosInfo();
    void Clear();
    void CopyFrom(NavCellPosInfo& other);

public:
    SmallPtrTrackedCollection<NavCell> m_navCellVersions;
    Pool<NavGraphVertexCollection>::Key m_navGraphVertexCollectionKey;
    Pool<TagVolumeCollection>::Key m_integratedTagVolumeCollectionKey;
    bool m_navCellActivenessChanged;
    bool m_onlyActiveFloorVersionChange;
};

class NavCellGrid
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_WorldFwk)
    KY_CLASS_WITHOUT_COPY(NavCellGrid)
public:
    NavCellGrid(Database* database);
    ~NavCellGrid();

    void Clear();

    void EnlargeGrid(const CellBox& cellBox);

    // This function insert all the navCell of a NavMeshElement in the grid.
    void InsertNavMeshElement(NavMeshElement* navMeshElement);

    // This function remove all the navCell of the NavMeshElement from the grid.
    void RemoveNavMeshElement(NavMeshElement* navMeshElement);

    void UpdateStitchOneToOneAndLaunchRuntimeStitchQueries(CellBox& cellBox, QueryProcessMode queryProcessMode);
    void UnStitch1To1EdgesInNavCellToRemoveOrInactivate(const CellBox& cellBox);
    void StitchAllNew1To1EdgesInNavCellToActivateAndTagPotentialRunTimeStitchNeed(const CellBox& cellBox);
    void LaunchAllRunTimeStitchQuery(const CellBox& cellBox, QueryProcessMode queryProcessMode);

    void ComputeCellNextActivenessStatusAndLaunchDynamicNavMeshQueries(const CellBox& cellBox, QueryProcessMode queryProcessMode);

    void UpdateAndStitchActiveData(const CellBox& cellBox);

    void InsertNavGraphVertexPtrAtCellPos(const NavGraphVertexRawPtr& navGraphVertexRawPtr, const CellPos& cellPos);
    void RemoveNavGraphVertexPtrFromCellPos(const NavGraphVertexRawPtr& navGraphVertexRawPtr, const CellPos& cellPos);

    void UpdateWithDynamicNavFloors(KyArray<Ptr<DynamicNavMeshQuery> >& queries, const CellBox& enlargeUpdateCellBox);

    TagVolumeCollection* GetTagVolumeCollection(NavCellPosInfo& navCellPosInfo);
    const TagVolumeCollection* GetTagVolumeCollection(const NavCellPosInfo& navCellPosInfo) const;
    TagVolumeCollection* CreateTagVolumeCollection(NavCellPosInfo& navCellPosInfo);

    void ProcessNavCellToRemoveOrInactivate(const CellBox& cellBox);
    void PostProcessRunTimeStitchQueries(CellBox& enlargedCellBox);
    void UpdateAvailableNavFloorsInNavCell(NavCell* navCell, Ptr<BlobHandler<NavFloorBlob> >* resultNavfloorHandlers);
    void UpdateActiveNavFloorsInActiveData(const CellBox& cellBox, const CellBox& enlargedCellBox);
    void StitchAllActiveNavFloors(const CellBox& enlargedCellBox);
    void RemoveAllFloorFromCorrespondingActiveCell(NavCell* navCell);
private:
    void InsertNavCell(NavCell* navCell);
    void RemoveNavCell(NavCell* navCell);

    void ComputeCellNextActivenessStatus(NavCellPosInfo& navCellPosInfo);
    void LaunchDynamicNavMeshQueries(NavCellPosInfo& navCellPosInfo, TagVolumeCollection* integratedTagVolumes, QueryProcessMode queryProcessMode);
    void SelectGuidCompoundCompatibleVersions(NavCellPosInfo& navCellPosInfo);
    void SortCompatibleVersionsAndWhichNavCellToActivate(NavCellPosInfo& navCellPosInfo);

    void TryToConnectAllUnConnectedNavGraphVertexInCell(NavCellPosInfo& navCellPosInfo);
    void DeleteNavGraphVertexCollectionOfNavCellPosInfo(NavCellPosInfo& navCellPosInfo);

    void DeleteTagVolumeCollectionOfNavCellPosInfo(NavCellPosInfo& navCellPosInfo);

    void UpdateActiveDataWithNewNavfloors(const CellBox& cellBox);

    void BuildAndStoreDynamicFloorsAtCellPosBlob(NavCell** navCells, KyUInt32 navCellCount);
public:
    Database* m_database;
    NavFloorStitcher m_floorStitcher;
    NavCellPosInfo* m_bufferOfNavCellPosInfo;

private :
    MemoryHeap* m_memoryHeapForActiveNavFloorArray;
    Pool<NavGraphVertexCollection> m_poolOfNavGraphVertexCollection;
    Pool<TagVolumeCollection> m_poolOfTagVolumeCollection;
    BitFieldMemStat<MemStat_NavData> m_stitchedCellIsDiscarded;
    KyArrayPOD<NavCell*, MemStat_NavData> m_stitchedCellVersions;
};

KY_INLINE void NavCellGrid::DeleteNavGraphVertexCollectionOfNavCellPosInfo(NavCellPosInfo& navCellPosInfo)
{
    m_poolOfNavGraphVertexCollection.Delete(navCellPosInfo.m_navGraphVertexCollectionKey);
    navCellPosInfo.m_navGraphVertexCollectionKey.Invalidate();
}

KY_INLINE TagVolumeCollection* NavCellGrid::GetTagVolumeCollection(NavCellPosInfo& navCellPosInfo)
{
    return navCellPosInfo.m_integratedTagVolumeCollectionKey.IsValid() ? &m_poolOfTagVolumeCollection.Get(navCellPosInfo.m_integratedTagVolumeCollectionKey) : KY_NULL;
}

KY_INLINE const TagVolumeCollection*NavCellGrid:: GetTagVolumeCollection(const NavCellPosInfo& navCellPosInfo) const
{
    return navCellPosInfo.m_integratedTagVolumeCollectionKey.IsValid() ? &m_poolOfTagVolumeCollection.Get(navCellPosInfo.m_integratedTagVolumeCollectionKey) : KY_NULL;
}

}

#endif //Navigation_NavcellGrid_H