navgraphedgeptr.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_NavGraphEdgePtr_H
#define Navigation_NavGraphEdgePtr_H

#include "gwnavruntime/navgraph/identifiers/navgraphvertexptr.h"
#include "gwnavruntime/navgraph/identifiers/navgraphedgerawptr.h"

namespace Kaim
{

class NavGraphEdgePtr
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
public:
    NavGraphEdgePtr(); 
    NavGraphEdgePtr(const NavGraphPtr& navGraphPtr, const NavGraphEdgeSmartIdx& edgeSmartIdx);
    NavGraphEdgePtr(const NavGraphVertexPtr& navGraphVertexPtr, KyUInt32 neighborIndex);

    bool IsValid() const;

    void Invalidate(); 

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

    NavGraph* GetNavGraph() const;

    const NavGraphBlob* GetNavGraphBlob() const;

    KyUInt32 GetEdgeNumberAroundStartVertex() const;

    NavGraphVertexIdx GetStartVertexIdx() const;

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

    NavGraph* GetNavGraph_UnSafe() const;

    const NavGraphBlob* GetNavGraphBlob_UnSafe() const;

    NavGraphVertexIdx GetEndNavGraphVertexIdx() const;

    NavGraphVertexPtr GetStartNavGraphVertexPtr() const;

    NavGraphVertexPtr GetEndNavGraphVertexPtr() const;

    const NavGraphVertex& GetStartNavGraphVertex() const;

    const NavGraphVertex& GetEndNavGraphVertex() const;

    const Vec3f& GetStartNavGraphVertexPosition() const;

    const Vec3f& GetEndNavGraphVertexPosition() const;

    const NavTag& GetNavTag() const;

    NavGraphEdgeRawPtr GetRawPtr() const;

    NavGraphEdgePtr GetOppositeNavGraphEdgePtr() const;

public:
    NavGraphPtr m_navGraphPtr;
    NavGraphEdgeSmartIdx m_edgeSmartIdx;
};

KY_INLINE NavGraphEdgePtr::NavGraphEdgePtr() : m_navGraphPtr(), m_edgeSmartIdx() {}
KY_INLINE NavGraphEdgePtr::NavGraphEdgePtr(const NavGraphPtr& navGraphPtr, const NavGraphEdgeSmartIdx& edgeSmartIdx) :
    m_navGraphPtr(navGraphPtr), m_edgeSmartIdx(edgeSmartIdx) {}
KY_INLINE NavGraphEdgePtr::NavGraphEdgePtr(const NavGraphVertexPtr& navGraphVertexPtr, KyUInt32 neighborIndex) :
    m_navGraphPtr(navGraphVertexPtr.m_navGraphPtr), m_edgeSmartIdx(navGraphVertexPtr.GetNavGraphVertexIdx(), neighborIndex) {}

KY_INLINE bool NavGraphEdgePtr::IsValid() const { return m_navGraphPtr.IsValid() && m_edgeSmartIdx.IsValid(); }
KY_INLINE void NavGraphEdgePtr::Invalidate() { m_navGraphPtr.Invalidate(); m_edgeSmartIdx.Invalidate(); }

KY_INLINE NavGraphEdgeRawPtr    NavGraphEdgePtr::GetRawPtr()                      const { return NavGraphEdgeRawPtr(GetNavGraph(), m_edgeSmartIdx);             }
KY_INLINE NavGraph*             NavGraphEdgePtr::GetNavGraph()                    const { return m_navGraphPtr.GetNavGraph();                                   }
KY_INLINE const NavGraphBlob*   NavGraphEdgePtr::GetNavGraphBlob()                const { return m_navGraphPtr.GetNavGraphBlob();                               }
KY_INLINE NavGraph*             NavGraphEdgePtr::GetNavGraph_UnSafe()             const { return m_navGraphPtr.GetNavGraph_UnSafe();                            }
KY_INLINE const NavGraphBlob*   NavGraphEdgePtr::GetNavGraphBlob_UnSafe()         const { return m_navGraphPtr.GetNavGraphBlob_UnSafe();                        }
KY_INLINE NavGraphVertexIdx     NavGraphEdgePtr::GetStartVertexIdx()              const { return m_edgeSmartIdx.GetStartVertexIdx();                            }
KY_INLINE KyUInt32              NavGraphEdgePtr::GetEdgeNumberAroundStartVertex() const { return m_edgeSmartIdx.GetNeighborVertexIdx();                        }
KY_INLINE NavGraphVertexIdx     NavGraphEdgePtr::GetEndNavGraphVertexIdx()        const { return GetRawPtr().GetEndNavGraphVertexIdx();                         }
KY_INLINE const NavGraphVertex& NavGraphEdgePtr::GetStartNavGraphVertex()         const { return GetRawPtr().GetStartNavGraphVertex();                          }
KY_INLINE const NavGraphVertex& NavGraphEdgePtr::GetEndNavGraphVertex()           const { return GetRawPtr().GetEndNavGraphVertex();                            }
KY_INLINE const Vec3f&          NavGraphEdgePtr::GetStartNavGraphVertexPosition() const { return GetRawPtr().GetStartNavGraphVertexPosition();                  }
KY_INLINE const Vec3f&          NavGraphEdgePtr::GetEndNavGraphVertexPosition()   const { return GetRawPtr().GetEndNavGraphVertexPosition();                    }
KY_INLINE const NavTag&         NavGraphEdgePtr::GetNavTag()                      const { return GetRawPtr().GetNavTag();                                       }

KY_INLINE bool NavGraphEdgePtr::operator ==(const NavGraphEdgePtr& rhs) const { return m_navGraphPtr == rhs.m_navGraphPtr && m_edgeSmartIdx == rhs.m_edgeSmartIdx; }
KY_INLINE bool NavGraphEdgePtr::operator < (const NavGraphEdgePtr& rhs) const { return m_navGraphPtr < rhs.m_navGraphPtr || (m_navGraphPtr == rhs.m_navGraphPtr && m_edgeSmartIdx < rhs.m_edgeSmartIdx); }
KY_INLINE bool NavGraphEdgePtr::operator !=(const NavGraphEdgePtr& rhs) const { return !(*this == rhs); }
KY_INLINE bool NavGraphEdgePtr::operator <=(const NavGraphEdgePtr& rhs) const { return !(rhs < *this);  }
// avoid warning C471 : marked as __forceinline not inlined
inline NavGraphVertexPtr     NavGraphEdgePtr::GetStartNavGraphVertexPtr()      const { return NavGraphVertexPtr(GetRawPtr().GetStartNavGraphVertexRawPtr()); }
inline NavGraphVertexPtr     NavGraphEdgePtr::GetEndNavGraphVertexPtr()        const { return NavGraphVertexPtr(GetRawPtr().GetEndNavGraphVertexRawPtr());   }

}

#endif //Navigation_NavGraphEdgePtr_H