navgraphvertexrawptr.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_NavGraphVertexRawPtr_H
#define Navigation_NavGraphVertexRawPtr_H

#include "gwnavruntime/navgraph/identifiers/navgraphrawptr.h"
#include "gwnavruntime/navgraph/navgraph.h"
#include "gwnavruntime/navgraph/navgraphtypes.h"


namespace Kaim
{

class NavGraphVertex;
class GraphVertexData;
class NavTag;

class NavGraphVertexRawPtr
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)

public:
    NavGraphVertexRawPtr(); 

    NavGraphVertexRawPtr(const NavGraphRawPtr& navGraphRawPtr, NavGraphVertexIdx vertexIdx);

    bool IsValid() const;

    void Invalidate(); 
    
    bool operator ==(const NavGraphVertexRawPtr& rhs) const; 
    bool operator !=(const NavGraphVertexRawPtr& rhs) const; 
    bool operator < (const NavGraphVertexRawPtr& rhs) const;
    bool operator <=(const NavGraphVertexRawPtr& rhs) const;
    
    // ---------------------------------- Member Functions for valid instance ----------------------------------

    NavGraphVertexIdx     GetNavGraphVertexIdx()   const; 
    NavGraph*             GetNavGraph()            const; 
    const NavGraphBlob*   GetNavGraphBlob()        const; 
    KyUInt32              GetNeighborVertexCount() const; 
    GraphVertexData&      GetGraphVertexData()     const; 
    const NavTag&         GetNavTag()              const; 
    const NavGraphVertex& GetNavGraphVertex()      const; 
    const Vec3f&          GetGraphVertexPosition() const; 

public:
    NavGraphRawPtr m_navGraphRawPtr;
    CompactNavGraphVertexIdx m_vertexIdx;
};

KY_INLINE NavGraphVertexRawPtr::NavGraphVertexRawPtr() : m_vertexIdx(CompactNavGraphVertexIdx_MAXVAL) {}

KY_INLINE NavGraphVertexRawPtr::NavGraphVertexRawPtr(const NavGraphRawPtr& navGraphRawPtr, NavGraphVertexIdx vertexIdx) :
    m_navGraphRawPtr(navGraphRawPtr), m_vertexIdx((CompactNavGraphVertexIdx)vertexIdx) {}

KY_INLINE bool NavGraphVertexRawPtr::IsValid() const { return m_navGraphRawPtr.IsValid() && m_vertexIdx != CompactNavGraphVertexIdx_MAXVAL; }
KY_INLINE void NavGraphVertexRawPtr::Invalidate() { m_navGraphRawPtr.Invalidate(); m_vertexIdx = CompactNavGraphVertexIdx_MAXVAL; }

KY_INLINE NavGraphVertexIdx NavGraphVertexRawPtr::GetNavGraphVertexIdx() const { return (NavGraphVertexIdx)m_vertexIdx; }

KY_INLINE bool NavGraphVertexRawPtr::operator ==(const NavGraphVertexRawPtr& rhs) const { return m_navGraphRawPtr == rhs.m_navGraphRawPtr && m_vertexIdx == rhs.m_vertexIdx; }
KY_INLINE bool NavGraphVertexRawPtr::operator !=(const NavGraphVertexRawPtr& rhs) const { return !(*this == rhs); }
KY_INLINE bool NavGraphVertexRawPtr::operator < (const NavGraphVertexRawPtr& rhs) const { return m_navGraphRawPtr < rhs.m_navGraphRawPtr || (m_navGraphRawPtr == rhs.m_navGraphRawPtr && m_vertexIdx < rhs.m_vertexIdx); }
KY_INLINE bool NavGraphVertexRawPtr::operator <=(const NavGraphVertexRawPtr& rhs) const { return !(rhs < *this); }

KY_INLINE const NavGraphBlob* NavGraphVertexRawPtr::GetNavGraphBlob() const { return m_navGraphRawPtr.GetNavGraphBlob(); }
KY_INLINE NavGraph*           NavGraphVertexRawPtr::GetNavGraph()     const { return m_navGraphRawPtr.GetNavGraph();     }

KY_INLINE const NavGraphVertex& NavGraphVertexRawPtr::GetNavGraphVertex()      const { return GetNavGraphBlob()->GetNavGraphVertex(m_vertexIdx); }
KY_INLINE const Vec3f&          NavGraphVertexRawPtr::GetGraphVertexPosition() const { return GetNavGraphVertex().GetPosition();                 }
KY_INLINE GraphVertexData&      NavGraphVertexRawPtr::GetGraphVertexData()     const { return GetNavGraph()->GetGraphVertexData(m_vertexIdx);    }
KY_INLINE KyUInt32              NavGraphVertexRawPtr::GetNeighborVertexCount() const { return GetNavGraphVertex().GetNeighborVertexCount();      }

KY_INLINE const NavTag& NavGraphVertexRawPtr::GetNavTag() const
{
    const NavGraphBlob* navGraphBlob = GetNavGraphBlob();
    const NavTagIdx navTagIdx =  navGraphBlob->GetNavGraphVertexNavTagIdx(m_vertexIdx);
    return navGraphBlob->GetNavTag(navTagIdx);
}

}

#endif //Navigation_NavGraphVertexRawPtr_H