navcell.h

Go to the documentation of this file.

/*
* Copyright 2016 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.
*/

#pragma once

#include "gwnavruntime/navmesh/navmeshelement.h"
#include "gwnavruntime/containers/collection.h"
#include "gwnavruntime/navmesh/navfloor1to1stitchdata.h"

namespace Kaim
{

class ActiveNavFloorCollection;
class NavFloorPtr;
class NavFloor;
class Database;
class DynamicNavMeshQuery;
class StaticToDynamicHalfEdge;

class NavCell
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
    KY_CLASS_WITHOUT_COPY(NavCell)
public:
    // ------------------------------ Functions -----------------------------

    const CellPos& GetCellPos() const { return m_navCellBlob->GetCellPos(); }

    KyUInt32 GetNavFloorCount() const { return m_numberOfFloors; }

    NavFloor* GetNavFloor(NavFloorIdx floorIdx) const { return m_metaNavFloorBuffer[floorIdx].m_activeNavFloor; }

    const GuidCompound& GetGuidCompound() const { return m_parentNavMeshElement->GetGuidCompound(); }

    NavMeshElement* GetParentNavMeshElement() const { return m_parentNavMeshElement; } 

    bool IsNavCellBlobEmpty() const { return GetNavFloorCount() == 0; } 

    bool IsNavCellActive() const { return GetActivenessStatus() == ACTIVE; }

public: // internal
    enum ActivenessStatus
    {
        NOT_PROCESSED ,
        ACTIVE        ,
        INACTIVE      ,
        REMOVED
    };

    NavCell(const NavCellBlob& navCellBlob);
    ~NavCell();

    void OnRemove();
    void OnDeActivate();

    static KyUInt32 ComputeSizeForNavCell(const NavCellBlob& navCellBlob);
    static NavCell* PlaceNavCellInBuffer(const BlobRef<NavCellBlob>& navCellRef, Database* database, NavMeshElement* navMeshElement, char*& currentMemoryPlace);

    KyUInt32 GetIndexInCollection() const { return m_idxOfNavCellVersionCollection; }

    void SetIndexInCollection(KyUInt32 indexInCollection) { m_idxOfNavCellVersionCollection = (KyUInt16)indexInCollection; }

    NavFloor* GetStaticNavFloorVersion(NavFloorIdx floorIdx) const { return m_metaNavFloorBuffer[floorIdx].m_staticNavFloor; }

    void RestoreStaticNavFloorAsActive(NavFloorIdx floorIdx);
    void SetNewDynamicVersionOfNavFloor(NavFloorIdx floorIdx, BlobHandler<NavFloorBlob>* navFloorBlobHandler);

    ActivenessStatus GetActivenessStatus() const { return (ActivenessStatus)m_currentActivenessStatus; }

    ActivenessStatus GetNextActivenessStatus() const { return (ActivenessStatus)m_nextActivenessStatus; }

    void SetActivenessStatus(ActivenessStatus status) { m_currentActivenessStatus = (KyUInt8)status; }

    void SetNextActivenessStatus(ActivenessStatus status) { m_nextActivenessStatus = (KyUInt8)status; }

    class MetaNavFloor
    {
    public:
        MetaNavFloor();
        ~MetaNavFloor();
        Ptr<NavFloor> m_staticNavFloor;                      
        Ptr<NavFloor> m_activeNavFloor;                      
        Ptr<BaseBlobHandler> m_blobHandlerOfDynamicNavFloor; 
        NavFloor1To1StitchData m_floor1To1StitchData;
    };

    const NavFloorBlob* GetFutureActiveNavFloorBlob(KyUInt32 floorIdx);

public: // internal
    NavMeshElement* m_parentNavMeshElement;               
    const NavCellBlob* m_navCellBlob;                     

    MetaNavFloor* m_metaNavFloorBuffer; 

    Ptr<DynamicNavMeshQuery> m_dynamicNavMeshQuery; // The dynamicNavMesh query that is running or that has finished on this Cell. Keep it to retrieve its result when computing run-time stitch

    KyUInt32 m_navCellIdxInNavMesh;           
    KyUInt16 m_idxOfNavCellVersionCollection; 
    KyUInt16 m_numberOfFloors;                
    KyUInt16 m_numberOfActiveDynamicFloors;   
    KyUInt8 m_currentActivenessStatus;        
    KyUInt8 m_nextActivenessStatus;           
    bool m_navFloorsAreStitched;              
    bool m_mustLaunchRuntimStitchQuery;
};

}