navgraphedgerawptr.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_NavGraphEdgeRawPtr_H
#define Navigation_NavGraphEdgeRawPtr_H

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

namespace Kaim
{

class NavTag;

class NavGraphEdgeRawPtr
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)

public:
    NavGraphEdgeRawPtr(); 
    NavGraphEdgeRawPtr(const NavGraphRawPtr& navGraphRawPtr, NavGraphEdgeSmartIdx edgeSmartIdx);
    NavGraphEdgeRawPtr(const NavGraphVertexRawPtr& navGraphVertexRawPtr, KyUInt32 neighborIndex);

    bool IsValid() const;

    void Invalidate(); 

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

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

    KyUInt32 GetEdgeNumberAroundStartVertex() const;

    NavGraphEdgeRawPtr GetOppositeNavGraphEdgeRawPtr() const;

    NavGraph*             GetNavGraph()                    const; 
    const NavGraphBlob*   GetNavGraphBlob()                const; 
    NavGraphVertexIdx     GetStartVertexIdx()              const; 
    NavGraphVertexIdx     GetEndNavGraphVertexIdx()        const; 
    NavGraphVertexRawPtr  GetStartNavGraphVertexRawPtr()   const; 
    NavGraphVertexRawPtr  GetEndNavGraphVertexRawPtr()     const; 
    const NavGraphVertex& GetStartNavGraphVertex()         const; 
    const NavGraphVertex& GetEndNavGraphVertex()           const; 
    const Vec3f&          GetStartNavGraphVertexPosition() const; 
    const Vec3f&          GetEndNavGraphVertexPosition()   const; 
    const NavTag&         GetNavTag()                      const; 

    template<class TraverseLogic>
    bool CanBeTraversed(void* traverseLogicUserData, KyFloat32* costMultiplier = KY_NULL) const;

public: // internal
    template<class TraverseLogic>
    bool CanBeTraversed(void* traverseLogicUserData, KyFloat32* costMultiplier, const LogicWithoutCostMultipler&) const;
    template<class TraverseLogic>
    bool CanBeTraversed(void* traverseLogicUserData, KyFloat32* costMultiplier, const LogicWithCostMultiplerPerNavTag&) const;
    template<class TraverseLogic>
    bool CanBeTraversed(void* traverseLogicUserData, KyFloat32* costMultiplier, const LogicWithCostMultiplerPerTriangle&) const;

public:
    NavGraphRawPtr m_navGraphRawPtr;
    NavGraphEdgeSmartIdx m_edgeSmartIdx;
};

}

#include "gwnavruntime/navgraph/identifiers/navgraphedgerawptr.inl"

#endif //Navigation_NavGraphEdgeRawPtr_H