navgraphblobbuilder.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: LASI - secondary contact: NONE
#ifndef Navigation_NavGraphBlobBuilder_H
#define Navigation_NavGraphBlobBuilder_H

#include "gwnavruntime/blob/baseblobbuilder.h"
#include "gwnavruntime/navgraph/blobs/navgraphblobbuildertypes.h"
#include "gwnavruntime/kernel/SF_String.h"


namespace Kaim
{

class NavGraphBlob;

class NavGraphBlobBuilder : public BaseBlobBuilder<NavGraphBlob>
{
public:
    NavGraphBlobBuilder();

    KyUInt32 GetEdgeCount()   const;
    KyUInt32 GetVertexCount() const;
    KyUInt32 GetNavTagCount() const;


    KyUInt32 AddNavTag(const DynamicNavTag* dynamicNavTag);


    // ---- Add vertices ----

    KyUInt32 AddVertexWithoutNavTag(const Vec3f& position, NavGraphVertexLinkType vertexType = NavGraphVertexLinkType_LinkToNavMesh);

    KyUInt32 AddVertexWithUnsharedNavTag(const Vec3f& position, DynamicNavTag* dynamicNavTag, NavGraphVertexLinkType vertexType = NavGraphVertexLinkType_LinkToNavMesh);
    
    KyUInt32 AddVertexWithNavTag(const Vec3f& position, KyUInt32 navTagIdx, NavGraphVertexLinkType vertexType = NavGraphVertexLinkType_LinkToNavMesh);

    // ---- Add Monodirectional edges --- 

    KyUInt32 AddMonodirectionalEdgeWithoutNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx);

    KyUInt32 AddMonodirectionalEdgeWithUnsharedNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag* dynamicNavTag);
    
    KyUInt32 AddMonodirectionalEdgeWithNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, KyUInt32 navTagIdx);

    // ---- Add Bidirectional edges --- 

    void AddBidirectionalEdgeWithoutNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx);

    KyResult AddBidirectionalEdgeWithUnsharedNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag* dynamicNavTag);

    void AddBidirectionalEdgeWithNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, KyUInt32 navTagIdx);

    void SetName(const char* graphName); 

public: // DEPRECATED functions
    
    // ---------  Deprecated ExclusiveNavTag ---------

    KY_DEPRECATED(KyUInt32 AddVertexWithExclusiveNavTag(const Vec3f& position, DynamicNavTag* dynamicNavTag, NavGraphVertexLinkType vertexType = NavGraphVertexLinkType_LinkToNavMesh));
    KY_DEPRECATED(KyUInt32 AddMonodirectionalEdgeWithExclusiveNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag* dynamicNavTag));
    KY_DEPRECATED(void AddBidirectionalEdgeWithExclusiveNavTag(KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag* dynamicNavTag));

private:
    virtual void DoBuild();

public: // internal
    KyUInt32 m_visualDebugId; // unused since NavGraphBlobs were sent into NavGraphArray blob from a NavData
    String m_name; // optional, only for Visual Debug
    KyArrayPOD<const DynamicNavTag*> m_navTags;
    KyArray<NavGraphBlobBuilder_Vertex> m_vertices; //< Graph Vertices.
    KyArray<NavGraphBlobBuilder_Edge> m_edges; //< Graph Edges.
};


KY_INLINE KyUInt32 NavGraphBlobBuilder::GetEdgeCount()   const { return m_edges.GetCount();    }
KY_INLINE KyUInt32 NavGraphBlobBuilder::GetVertexCount() const { return m_vertices.GetCount(); }
KY_INLINE KyUInt32 NavGraphBlobBuilder::GetNavTagCount() const { return m_navTags.GetCount();  }

}

#endif // Navigation_NavGraphBlobBuilder_H