navmeshelement.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/blobs/navmeshelementblob.h"

namespace Kaim
{

class NavCell;
class Database;

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

public:
    // ------------------------------ Functions -----------------------------

    bool IsStillLoaded() const { return m_navMeshElementBlob != nullptr; }

    const NavMeshElementBlob* GetNavMeshElementBlob() const
    {
        KY_DEBUG_ASSERTN(IsStillLoaded(), ("You Cannot call this function if NavMeshElement has been unloaded or not loaded yet"));
        return m_navMeshElementBlob;
    }

    const GuidCompound& GetGuidCompound() const
    {
        KY_DEBUG_ASSERTN(IsStillLoaded(), ("You Cannot call this function if NavMeshElement has been unloaded or not loaded yet"));
        return m_navMeshElementBlob->m_guidCompound;
    }

public: // internal
    void OnRemove(); // Call OnRemove on each NavCell

    KyUInt32 GetIndexInCollection() const { return m_indexInCollection; }                              // contract to be in a TrackedCollection
    void SetIndexInCollection(KyUInt32 indexInCollection) { m_indexInCollection = indexInCollection; } // contract to be in a TrackedCollection

    static Ptr<NavMeshElement> Create(const NavMeshElementBlob& navMeshElementBlob, Database* database, MemoryHeap* pheap = nullptr);

private:
    static KyUInt32 ComputeSizeForNavMeshElement(const NavMeshElementBlob& navMeshElementBlob)
    {
        return sizeof(NavMeshElement) + navMeshElementBlob.GetNavCellBlobCount() * (KyUInt32)sizeof(void*);
    }

    static KyUInt32 ComputeTotalSizeForNavMeshElement(const NavMeshElementBlob& navMeshElementBlob);

public: // internal
    Database* m_database;     // The Database in which the parentNavData has been added to. Do not modify.
    NavCell** m_navCells;     // The array of NavCells that make up this NavMeshElement. Do not modify.
    KyUInt32 m_numberOfCells; // The number of NavCells in #m_navCells. Do not modify.

    KyUInt32 m_indexInCollection; // For TrackedCollection
    KyUInt32 m_guidCompoundSortedIdx;
    bool m_guidCompoundIsCompatible;

private:
    const NavMeshElementBlob* m_navMeshElementBlob; // The NavMeshElementBlob that contains the static data for this NavMesh. Do not modify.
};
}