navfloor.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_NavFloor_H
#define Navigation_NavFloor_H

#include "gwnavruntime/blob/blobref.h"
#include "gwnavruntime/navmesh/blobs/flooraltituderange.h"
#include "gwnavruntime/navmesh/blobs/navfloorblob.h"
#include "gwnavruntime/containers/collection.h"

namespace Kaim
{

class NavCell;
class DynamicNavFloor;
class NavHalfEdgeRawPtr;
class NavFloorToNavGraphLinks;
class Database;
class SpatializedPoint;
class NavFloor;
class NavFloor1To1StitchData;



class NavFloor
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
    KY_CLASS_WITHOUT_COPY(NavFloor)
    KY_REFCOUNT_MALLOC_FREE(NavFloor)

public:
    // ---------------------------------- Public Member Functions ----------------------------------

    const NavFloorBlob* GetNavFloorBlob() const; 
    const CellPos& GetCellPos() const;  
    bool IsStillLoaded() const; 

    bool IsActive() const;

public: //Internal
    
    NavFloor* GetAssociatedStaticNavFloor() const; // returns the associated static NavFloor if "this" is a dynamic NavFloor. Else it just returns "this".
    bool IsStaticVersion() const;
    
    const ConnectedComponentId& GetConnexConnectedComponentId(KyUInt32 navConnexIdx) const;  // used in generation
    void SetConnexConnectedComponentId(KyUInt32 navConnexIdx, ConnectedComponentId connectedComponentId);  // used in generation
    NavHalfEdgeRawPtr* GetLinksBuffer() const;

    bool HasAnUnconnectedLink() const;

    void OnRemove();
    void OnDeActivate();

    NavFloorToNavGraphLinks* GetNavFloorToNavGraphLinks() const;

    class CreateConfig
    {
    public:
        CreateConfig() : m_navFloorBlob(KY_NULL), m_database(KY_NULL), m_navCell(KY_NULL), m_floor1To1StitchData(KY_NULL) {}

        NavFloorBlob* m_navFloorBlob;
        Database* m_database;
        NavCell* m_navCell;
        NavFloor1To1StitchData* m_floor1To1StitchData;
        CellPos m_cellPos;
    };

    static Ptr<NavFloor> Create(const CreateConfig& navFloorCongig, MemoryHeap* pheap = KY_NULL);
    static KyUInt32 ComputeSizeForNavFloor(const NavFloorBlob& navFloorBlob);

    KyUInt32 GetIndexInCollection() const;
    void SetIndexInCollection(KyUInt32 indexInCollection);

    // SpatializedPoint management
    const Collection<SpatializedPoint*>& GetSpatializedPoints() const;
    void AddSpatializedPoint(SpatializedPoint* spatializedPoint);
    void RemoveSpatializedPoint(SpatializedPoint* spatializedPoint);
    void RemoveAllSpatializedPoints();

    void UnstitchStaticLinks();
private:
    static Ptr<NavFloor> PlaceNavFloorInBuffer(const CreateConfig& navFloorCongig, char*& currentMemoryPlace);

public: // internal
    Database* m_database;
    NavCell* m_navCell;

    NavFloor1To1StitchData* m_floor1To1StitchData;
    const NavFloorBlob* m_navFloorBlob;
    NavTag* m_navTags; // the navTag presents in the NavFloorBlob are copied in the NavFloor. 1 per NavConnex
    ConnectedComponentId* m_connexConnectedComponents; // used in generation. 1 per NavConnex

    CellPos m_cellPos; // The position of this NavFloor within the grid of NavData cells. Do not modify. 
    FloorAltitudeRange m_floorAltitudeRange;

    Collection<SpatializedPoint*> m_spatializedPoints;

    KyUInt16 m_floorLinksOffset; // bytes offsets to NavHalfEdgeRawPtr buffer
    KyUInt16 m_graphLinksOffset; // bytes offsets to NavFloorToNavGraphLinks buffer
    KyUInt16 m_numberOfLink;
    KyUInt16 m_numberOfUnconnectedLink;
    KyUInt16 m_idxInActiveNavFloorCollection; 
    KyUInt16 m_idxInTheNavCellBuffer; 
};

KY_INLINE const NavFloorBlob* NavFloor::GetNavFloorBlob() const
{
    KY_DEBUG_ASSERTN(m_navFloorBlob != KY_NULL,("the SizedPtr is not valid"));
    return m_navFloorBlob;
}

KY_INLINE KyUInt32 NavFloor::GetIndexInCollection() const { return m_idxInActiveNavFloorCollection; }
KY_INLINE void NavFloor::SetIndexInCollection(KyUInt32 indexInCollection) { m_idxInActiveNavFloorCollection = (KyUInt16)indexInCollection; }

KY_INLINE bool NavFloor::IsStillLoaded() const { return m_navFloorBlob != KY_NULL;                         }
KY_INLINE bool NavFloor::IsActive()      const { return m_idxInActiveNavFloorCollection != KyUInt16MAXVAL; }

KY_INLINE const CellPos&              NavFloor::GetCellPos() const { return m_cellPos; }
KY_INLINE const ConnectedComponentId& NavFloor::GetConnexConnectedComponentId(KyUInt32 navConnexIdx)  const { return m_connexConnectedComponents[navConnexIdx];                                 }

KY_INLINE NavHalfEdgeRawPtr*          NavFloor::GetLinksBuffer()             const { return       (NavHalfEdgeRawPtr*)((char*)this + m_floorLinksOffset); }
KY_INLINE NavFloorToNavGraphLinks*    NavFloor::GetNavFloorToNavGraphLinks() const { return (NavFloorToNavGraphLinks*)((char*)this + m_graphLinksOffset); }

KY_INLINE bool NavFloor::HasAnUnconnectedLink() const { return m_numberOfUnconnectedLink != 0; }

KY_INLINE void NavFloor::SetConnexConnectedComponentId(KyUInt32 navConnexIdx, ConnectedComponentId connectedComponentId) { m_connexConnectedComponents[navConnexIdx] = connectedComponentId; }

KY_INLINE const Collection<SpatializedPoint*>& NavFloor::GetSpatializedPoints() const { return m_spatializedPoints; }
KY_INLINE void NavFloor::AddSpatializedPoint(SpatializedPoint* spatializedPoint)     { m_spatializedPoints.PushBack(spatializedPoint); }
KY_INLINE void NavFloor::RemoveSpatializedPoint(SpatializedPoint* spatializedPoint)  { m_spatializedPoints.RemoveFirstOccurrence(spatializedPoint); }

KY_INLINE bool NavFloor::IsStaticVersion() const { return GetAssociatedStaticNavFloor() == this; }

}

#endif //Navigation_NavFloor_H