navgraphvertexptr.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_NavGraphVertexPtr_H
#define Navigation_NavGraphVertexPtr_H

#include "gwnavruntime/navgraph/identifiers/navgraphptr.h"
#include "gwnavruntime/navgraph/identifiers/navgraphvertexrawptr.h"


namespace Kaim
{

class NavGraphVertexPtr
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)

public:
    NavGraphVertexPtr(); 

    NavGraphVertexPtr(const NavGraphPtr& navGraphPtr, NavGraphVertexIdx vertexIdx);

    explicit NavGraphVertexPtr(const NavGraphVertexRawPtr& navGraphVertexRawPtr);

    bool IsValid() const;

    void Invalidate(); 

    bool operator ==(const NavGraphVertexPtr& rhs) const; 
    bool operator !=(const NavGraphVertexPtr& rhs) const; 
    bool operator < (const NavGraphVertexPtr& rhs) const;
    bool operator <=(const NavGraphVertexPtr& rhs) const;

    NavGraphVertexIdx GetNavGraphVertexIdx() const;

    NavGraph* GetNavGraph() const;

    const NavGraphBlob* GetNavGraphBlob() const;

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

    NavGraph* GetNavGraph_UnSafe() const;

    const NavGraphBlob* GetNavGraphBlob_UnSafe() const;

    KyUInt32 GetNeighborVertexCount() const;

    GraphVertexData& GetGraphVertexData() const;

    const NavTag& GetNavTag() const;

    const NavGraphVertex& GetNavGraphVertex() const;

    const Vec3f& GetGraphVertexPosition() const;

    NavGraphVertexRawPtr GetRawPtr() const;

public:
    NavGraphPtr m_navGraphPtr;
    NavGraphVertexIdx m_vertexIdx;
};


KY_INLINE NavGraphVertexPtr::NavGraphVertexPtr() :
    m_navGraphPtr(), m_vertexIdx(NavGraphVertexIdx_Invalid) {}
KY_INLINE NavGraphVertexPtr::NavGraphVertexPtr(const NavGraphPtr& navGraphPtr, NavGraphVertexIdx vertexIdx) :
    m_navGraphPtr(navGraphPtr), m_vertexIdx(vertexIdx) {}
KY_INLINE NavGraphVertexPtr::NavGraphVertexPtr(const NavGraphVertexRawPtr& navGraphVertexRawPtr) :
    m_navGraphPtr(navGraphVertexRawPtr.GetNavGraph()), m_vertexIdx(navGraphVertexRawPtr.GetNavGraphVertexIdx()) {}

KY_INLINE bool NavGraphVertexPtr::IsValid() const { return m_navGraphPtr.IsValid() && m_vertexIdx != NavGraphVertexIdx_Invalid; }
KY_INLINE void NavGraphVertexPtr::Invalidate() { m_navGraphPtr.Invalidate(); m_vertexIdx = NavGraphVertexIdx_Invalid; }

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

KY_INLINE NavGraphVertexIdx     NavGraphVertexPtr::GetNavGraphVertexIdx()   const { return m_vertexIdx;                                                 }
KY_INLINE NavGraph*             NavGraphVertexPtr::GetNavGraph()            const { return m_navGraphPtr.GetNavGraph();                                 }
KY_INLINE NavGraph*             NavGraphVertexPtr::GetNavGraph_UnSafe()     const { return m_navGraphPtr.GetNavGraph_UnSafe();                          }
KY_INLINE const NavGraphBlob*   NavGraphVertexPtr::GetNavGraphBlob()        const { return m_navGraphPtr.GetNavGraphBlob();                             }
KY_INLINE const NavGraphBlob*   NavGraphVertexPtr::GetNavGraphBlob_UnSafe() const { return m_navGraphPtr.GetNavGraphBlob_UnSafe();                      }
KY_INLINE NavGraphVertexRawPtr  NavGraphVertexPtr::GetRawPtr()              const { return NavGraphVertexRawPtr(GetNavGraph(), GetNavGraphVertexIdx()); }
KY_INLINE KyUInt32              NavGraphVertexPtr::GetNeighborVertexCount() const { return GetRawPtr().GetNeighborVertexCount();                        }
KY_INLINE GraphVertexData&      NavGraphVertexPtr::GetGraphVertexData()     const { return GetRawPtr().GetGraphVertexData();                            }
KY_INLINE const NavTag&         NavGraphVertexPtr::GetNavTag()              const { return GetRawPtr().GetNavTag();                                     }
KY_INLINE const NavGraphVertex& NavGraphVertexPtr::GetNavGraphVertex()      const { return GetRawPtr().GetNavGraphVertex();                             }
KY_INLINE const Vec3f&          NavGraphVertexPtr::GetGraphVertexPosition() const { return GetRawPtr().GetGraphVertexPosition();                        }

}

#endif //Navigation_NavGraphVertexPtr_H