navfloorptr.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_NavFloorPtr_H
#define Navigation_NavFloorPtr_H

#include "gwnavruntime/navmesh/identifiers/navfloorrawptr.h"

namespace Kaim
{

class NavFloorPtr
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
public:
    // ---------------------------------- Main API Functions ----------------------------------

    NavFloorPtr(NavFloor* navFloor = KY_NULL);

    explicit NavFloorPtr(const NavFloorRawPtr& navFloorRawPtr);

    bool IsValid() const; 

    void Invalidate(); 

    bool operator==(const NavFloorPtr& rhs) const; 
    bool operator!=(const NavFloorPtr& rhs) const; 

    NavFloor*           GetNavFloor()     const; 
    const NavFloorBlob* GetNavFloorBlob() const; 

    // ---------------------------------- Member Functions for valid instance ----------------------------------

    NavFloor* GetNavFloor_Unsafe() const;

    const NavFloorBlob* GetNavFloorBlob_Unsafe() const;

    NavFloorRawPtr GetRawPtr() const;

    const CellPos& GetCellPos() const;

private:
    mutable Ptr<NavFloor> m_navFloorPtr;
};

KY_INLINE NavFloorPtr::NavFloorPtr(NavFloor* navFloor) : m_navFloorPtr(navFloor) {}
KY_INLINE NavFloorPtr::NavFloorPtr(const NavFloorRawPtr& navFloorRawPtr) : m_navFloorPtr(navFloorRawPtr.GetNavFloor()) {}
KY_INLINE void NavFloorPtr::Invalidate() { m_navFloorPtr = KY_NULL; }
KY_INLINE bool NavFloorPtr::IsValid() const
{
    if(m_navFloorPtr != KY_NULL)
    {
        if(m_navFloorPtr->IsStillLoaded())
            return m_navFloorPtr->IsActive();

        m_navFloorPtr = KY_NULL;
    }

    return false;
}


KY_INLINE NavFloor*           NavFloorPtr::GetNavFloor()     const { return IsValid() ? GetNavFloor_Unsafe()     : KY_NULL; }
KY_INLINE const NavFloorBlob* NavFloorPtr::GetNavFloorBlob() const { return IsValid() ? GetNavFloorBlob_Unsafe() : KY_NULL; }

KY_INLINE NavFloor*           NavFloorPtr::GetNavFloor_Unsafe()     const { return m_navFloorPtr;                    }
KY_INLINE const NavFloorBlob* NavFloorPtr::GetNavFloorBlob_Unsafe() const { return m_navFloorPtr->GetNavFloorBlob(); }

KY_INLINE NavFloorRawPtr NavFloorPtr::GetRawPtr() const { return NavFloorRawPtr(m_navFloorPtr.GetPtr()); }

KY_INLINE bool NavFloorPtr::operator==(const NavFloorPtr& rhs) const { return m_navFloorPtr == rhs.m_navFloorPtr; }
KY_INLINE bool NavFloorPtr::operator!=(const NavFloorPtr& rhs) const { return m_navFloorPtr != rhs.m_navFloorPtr; }

KY_INLINE const CellPos& NavFloorPtr::GetCellPos() const { return GetRawPtr().GetCellPos(); }

}

#endif //Navigation_NavFloorPtr_H