#include <navgraphblobbuilder.h>

Class Description

This class allows you to build a NavGraph, which you can then add to the NavData for a sector.

This class is typically used in a custom post-processing phase after generating the NavMesh for a terrain.

Examples:: gamekit/Tutorial_CrowdDispersion.cpp, Tutorial_Generation_postProcess.cpp, and Tutorial_NavTag.cpp.

Inherits Kaim::BaseBlobBuilder< NavGraphBlob >.

Public Member Functions
KyUInt32	AddNavTag (const DynamicNavTag *dynamicNavTag)
	Adds a NavTag that will be associated to edge and/or vertices. More...

bool	IsWriteMode ()
	Indicates whether the builder is operating in COUNT mode or in WRITE mode. More...

NavGraphBlob *	Build (BlobHandler< NavGraphBlob > &blobHandler)
	This method: Calls DoBuild() in COUNT mode to determine the amount of memory needed for the blob to be built. More...

KyUInt32	ComputeBlobSize ()
	Simply Compute BlobSize. More...

void	BuildFlatBlob (NavGraphBlob &blob)
	Simple way to use DoBuild in case of flat blob (that is, a blob that does not have a BlobArray or BlobRef) More...

void	DoBuildAllocatedBlob (BlobBuffer blobBuffer, NavGraphBlob blob)
	For internal use. Use BLOB_BUILD instead. More...

void	DoAllocAndBuildReferencedBlob (BlobBuffer blobBuffer, BlobRef< NavGraphBlob > blobRef)
	For internal use. Use BUILD_REFERENCED_BLOB instead. More...

BlobBuffer *	GetBlobBufferToBuildThis ()
	For internal use. Check if m_buildingPart == BUILDING_SHALLOW_PART and return this. More...

Public Attributes
BlobBuffer *	m_blobBuffer
	For internal use. Use BLOB_SET and BLOB_ARRAY instead. More...

NavGraphBlob *	m_blob
	The blob maintained by this builder. Only modify using the macros listed under DoBuild(). More...

Private Member Functions
virtual void	DoBuild ()
	Implement this function in any class that derives from BaseBlobBuilder. More...

Add vertices
KyUInt32	AddVertexWithoutNavTag (const Vec3f &position, NavGraphVertexLinkType vertexType=NavGraphVertexLinkType_LinkToNavMesh)
	Adds a new vertex to the Graph with no associated NavTag. More...

KyUInt32	AddVertexWithUnsharedNavTag (const Vec3f &position, DynamicNavTag *dynamicNavTag, NavGraphVertexLinkType vertexType=NavGraphVertexLinkType_LinkToNavMesh)
	Adds a new vertex to the Graph with an associated NavTag that is not supposed to be associated to other vertices or edges. More...

KyUInt32	AddVertexWithNavTag (const Vec3f &position, KyUInt32 navTagIdx, NavGraphVertexLinkType vertexType=NavGraphVertexLinkType_LinkToNavMesh)
	Adds a new vertex to the Graph with an associated NavTag that has already been added to the graph. More...

Add Monodirectional edges
KyUInt32	AddMonodirectionalEdgeWithoutNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx)
	Adds a new edge that connects the specified vertices. More...

KyUInt32	AddMonodirectionalEdgeWithUnsharedNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag *dynamicNavTag)
	Adds a new edge that connects the specified vertices. More...

KyUInt32	AddMonodirectionalEdgeWithNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, KyUInt32 navTagIdx)
	Adds a new edge that connects the specified vertices. More...

Add Bidirectional edges
void	AddBidirectionalEdgeWithoutNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx)
	Adds a bidirectional edge that connects the specified vertices. More...

KyResult	AddBidirectionalEdgeWithUnsharedNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag *dynamicNavTag)
	Adds a bidirectional edge that connects the specified vertices. More...

void	AddBidirectionalEdgeWithNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, KyUInt32 navTagIdx)
	Adds a bidirectional edge that connects the specified vertices. More...

void	SetName (const char *graphName)
	// optional, only for Visual Debug More...

Deprecated ExclusiveNavTag
KyUInt32	AddVertexWithExclusiveNavTag (const Vec3f &position, DynamicNavTag *dynamicNavTag, NavGraphVertexLinkType vertexType=NavGraphVertexLinkType_LinkToNavMesh)
	The term 'ExclusiveNavTag' was confusing or ambiguous, it is not exclusive as in DynamicNavTag::IsExclusive(). More...

KyUInt32	AddMonodirectionalEdgeWithExclusiveNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag *dynamicNavTag)

void	AddBidirectionalEdgeWithExclusiveNavTag (KyUInt32 startVertexIdx, KyUInt32 endVertexIdx, DynamicNavTag *dynamicNavTag)

For internal use only
KyUInt32	m_visualDebugId

String	m_name

KyArrayPOD< const DynamicNavTag * >	m_navTags

KyArray< NavGraphBlobBuilder_Vertex >	m_vertices

KyArray< NavGraphBlobBuilder_Edge >	m_edges

Member Function Documentation

void Kaim::NavGraphBlobBuilder::AddBidirectionalEdgeWithNavTag	(	KyUInt32	startVertexIdx,
		KyUInt32	endVertexIdx,
		KyUInt32	navTagIdx
	)

Adds a bidirectional edge that connects the specified vertices.

NOTE: this function will create two mono-directional edges. One from startVertexIdx to endVertexIdx and One from endVertexIdx to startVertexIdx the edge will be associated to the NavTag that is not supposed to be associated to other vertices or edges

Parameters

startVertexIdx	The index of the starting vertex for the edge, which was returned by AddVertex().
endVertexIdx	The index of the ending vertex for the edge, which was returned by AddVertex().
navTagIdx	The associated navTag index that has already been added to Graph

Examples:: gamekit/Tutorial_CrowdDispersion.cpp, and Tutorial_NavTag.cpp.

void Kaim::NavGraphBlobBuilder::AddBidirectionalEdgeWithoutNavTag	(	KyUInt32	startVertexIdx,
		KyUInt32	endVertexIdx
	)

Adds a bidirectional edge that connects the specified vertices.

NOTE: this function will create two mono-directional edges. One from startVertexIdx to endVertexIdx and One from endVertexIdx to startVertexIdx. No navTag will be associated to this edge.

Parameters

startVertexIdx	The index of the starting vertex for the edge, which was returned by AddVertex().
endVertexIdx	The index of the ending vertex for the edge, which was returned by AddVertex().

Examples:: Tutorial_Generation_postProcess.cpp.

KyResult Kaim::NavGraphBlobBuilder::AddBidirectionalEdgeWithUnsharedNavTag	(	KyUInt32	startVertexIdx,
		KyUInt32	endVertexIdx,
		DynamicNavTag *	dynamicNavTag
	)

Adds a bidirectional edge that connects the specified vertices.

NOTE: this function will create two mono-directional edges. One from startVertexIdx to endVertexIdx and one from endVertexIdx to startVertexIdx. The edge will be associated to the NavTag that is not supposed to be associated to other vertices or edges

Parameters

startVertexIdx	The index of the starting vertex for the edge, which was returned by AddVertex().
endVertexIdx	The index of the ending vertex for the edge, which was returned by AddVertex().
dynamicNavTag	A pointer to the associated dynamicNavTag that will be added to the NavGraph

Returns: KY_ERROR if NavTag is exclusive which is not valid for NavGraphs.

KyUInt32 Kaim::NavGraphBlobBuilder::AddMonodirectionalEdgeWithNavTag	(	KyUInt32	startVertexIdx,
		KyUInt32	endVertexIdx,
		KyUInt32	navTagIdx
	)

Adds a new edge that connects the specified vertices.

Note that the edge is mono-directional, from the startVertex to the endVertex. If you want your characters to be able to plan paths that go between the two vertices in either direction, you must add a second edge from the endVertex to the startVertex, or use AddBidirectionalEdgeWithoutNavTag() instead. the edge will be associated to the NavTag that is not supposed to be associated to other vertices or edges

Parameters

startVertexIdx	The index of the starting vertex for the edge, which was returned by AddVertex().
endVertexIdx	The index of the ending vertex for the edge, which was returned by AddVertex().
navTagIdx	The associated navTag index that has already been added to Graph

Returns: the index of the newly created edge.

KyUInt32 Kaim::NavGraphBlobBuilder::AddMonodirectionalEdgeWithoutNavTag	(	KyUInt32	startVertexIdx,
		KyUInt32	endVertexIdx
	)

Adds a new edge that connects the specified vertices.

NOTE: the edge is mono-directional, from the startVertex to the endVertex. If you want your characters to be able to plan paths that go between the two vertices in either direction, you must add a second edge from the endVertex to the startVertex, or use AddBidirectionalEdgeWithoutNavTag() instead. No navTag will be associated to this edge.

Parameters

startVertexIdx	The index of the starting vertex for the edge, which was returned by AddVertex().
endVertexIdx	The index of the ending vertex for the edge, which was returned by AddVertex().

Returns: the index of the newly created edge.

KyUInt32 Kaim::NavGraphBlobBuilder::AddMonodirectionalEdgeWithUnsharedNavTag	(	KyUInt32	startVertexIdx,
		KyUInt32	endVertexIdx,
		DynamicNavTag *	dynamicNavTag
	)

Adds a new edge that connects the specified vertices.

NOTE: the edge is mono-directional, from the startVertex to the endVertex. If you want your characters to be able to plan paths that go between the two vertices in either direction, you must add a second edge from the endVertex to the startVertex, or use AddBidirectionalEdgeWithoutNavTag() instead. The edge will be associated to the NavTag that is not supposed to be associated to other vertices or edges.

Parameters

startVertexIdx	The index of the starting vertex for the edge, which was returned by AddVertex().
endVertexIdx	The index of the ending vertex for the edge, which was returned by AddVertex().
dynamicNavTag	A pointer to the associated dynamicNavTag that will be added to the NavGraph

Returns: the index of the newly created edge, or KyUInt32MAXVAL if NavTag is exclusive which is not valid for NavGraphs.

KyUInt32 Kaim::NavGraphBlobBuilder::AddNavTag ( const DynamicNavTag * dynamicNavTag )

Adds a NavTag that will be associated to edge and/or vertices.

Parameters

dynamicNavTag A pointer to the associated dynamicNavTag that will be added to the NavGraph.

Returns: the index of the NavTag that should pass as parameters to associate this NavTag to vertices and/or edges, or KyUInt32MAXVAL if NavTag is exclusive which is not valid for NavGraphs.

Examples:: gamekit/Tutorial_CrowdDispersion.cpp, and Tutorial_NavTag.cpp.

KyUInt32 Kaim::NavGraphBlobBuilder::AddVertexWithExclusiveNavTag	(	const Vec3f &	position,
		DynamicNavTag *	dynamicNavTag,
		NavGraphVertexLinkType	vertexType = `NavGraphVertexLinkType_LinkToNavMesh`
	)

The term 'ExclusiveNavTag' was confusing or ambiguous, it is not exclusive as in DynamicNavTag::IsExclusive().

It means a uniquely used NavTag in the NavGraph, no other edge or vertex is expected to use this NavTag. Please use the Add*WithUnsharedNavTag functions instead.

KyUInt32 Kaim::NavGraphBlobBuilder::AddVertexWithNavTag	(	const Vec3f &	position,
		KyUInt32	navTagIdx,
		NavGraphVertexLinkType	vertexType = `NavGraphVertexLinkType_LinkToNavMesh`
	)

Adds a new vertex to the Graph with an associated NavTag that has already been added to the graph.

Parameters

position	The position of the vertex in 3D space.
navTagIdx	The associated navTag index that has already been added to Graph .
vertexType	A tag provides the way the vertex will be connected or not at run-time.

Returns: the index of the newly created vertex.

Examples:: Tutorial_NavTag.cpp.

KyUInt32 Kaim::NavGraphBlobBuilder::AddVertexWithoutNavTag	(	const Vec3f &	position,
		NavGraphVertexLinkType	vertexType = `NavGraphVertexLinkType_LinkToNavMesh`
	)

Adds a new vertex to the Graph with no associated NavTag.

Parameters

position	The position of the vertex in 3D space.
vertexType	A tag provides the way the vertex will be connected or not at run-time.

Returns: the index of the newly created vertex.

Examples:: gamekit/Tutorial_CrowdDispersion.cpp, and Tutorial_Generation_postProcess.cpp.

KyUInt32 Kaim::NavGraphBlobBuilder::AddVertexWithUnsharedNavTag	(	const Vec3f &	position,
		DynamicNavTag *	dynamicNavTag,
		NavGraphVertexLinkType	vertexType = `NavGraphVertexLinkType_LinkToNavMesh`
	)

Adds a new vertex to the Graph with an associated NavTag that is not supposed to be associated to other vertices or edges.

Parameters

position	The position of the vertex in 3D space.
dynamicNavTag	A pointer to the associated dynamicNavTag that will be added to the NavGraph.
vertexType	A tag providing the way the vertex will be connected at run-time (if connected).

Returns: the index of the newly created vertex, or KyUInt32MAXVAL if NavTag is exclusive which is not valid for NavGraphs.

NavGraphBlob * Kaim::BaseBlobBuilder< NavGraphBlob >::Build ( BlobHandler< NavGraphBlob > & blobHandler )

inherited

This method:

Calls DoBuild() in COUNT mode to determine the amount of memory needed for the blob to be built.

Allocates the amount of memory in the specified BlobHandler.
Calls DoBuild() again, in WRITE mode, to actually build the blob in the buffer allocated by the BlobHandler.

Examples:: gamekit/Tutorial_CrowdDispersion.cpp, and Tutorial_NavTag.cpp.

void Kaim::BaseBlobBuilder< NavGraphBlob >::BuildFlatBlob ( NavGraphBlob & blob )

inherited

Simple way to use DoBuild in case of flat blob (that is, a blob that does not have a BlobArray or BlobRef)

KyUInt32 Kaim::BaseBlobBuilder< NavGraphBlob >::ComputeBlobSize ( )

inherited

Simply Compute BlobSize.

void Kaim::BaseBlobBuilder< NavGraphBlob >::DoAllocAndBuildReferencedBlob	(	BlobBuffer *	blobBuffer,
		BlobRef< NavGraphBlob > *	blobRef
	)

inherited

For internal use. Use BUILD_REFERENCED_BLOB instead.

void Kaim::NavGraphBlobBuilder::DoBuild ( )

privatevirtual

Implement this function in any class that derives from BaseBlobBuilder.

Its responsibility is to set the data for each class member maintained by m_blob. In your implementation, use one of the macros sets supplied for this purpose:

BLOB_SET, sets the value of a single class member of m_blob.
BLOB_ARRAY and BLOB_ARRAY_COPY, sets up BlobArray members of m_blob.
BLOB_STRING, copies a string into a char* class member of m_blob.
BLOB_BUILD, recursively builds class members of m_blob that need to be built by their own BaseBlobBuilder class.

Implements Kaim::BaseBlobBuilder< NavGraphBlob >.

void Kaim::BaseBlobBuilder< NavGraphBlob >::DoBuildAllocatedBlob	(	BlobBuffer *	blobBuffer,
		NavGraphBlob *	blob
	)

inherited

For internal use. Use BLOB_BUILD instead.

BlobBuffer* Kaim::BaseBlobBuilder< NavGraphBlob >::GetBlobBufferToBuildThis ( )

inlineinherited

For internal use. Check if m_buildingPart == BUILDING_SHALLOW_PART and return this.

bool Kaim::BaseBlobBuilder< NavGraphBlob >::IsWriteMode ( )

inlineinherited

Indicates whether the builder is operating in COUNT mode or in WRITE mode.

This can be used in implementations of DoBuild().

void Kaim::NavGraphBlobBuilder::SetName ( const char * graphName )

// optional, only for Visual Debug

Member Data Documentation

NavGraphBlob * Kaim::BaseBlobBuilder< NavGraphBlob >::m_blob

inherited

The blob maintained by this builder. Only modify using the macros listed under DoBuild().

BlobBuffer* Kaim::BaseBlobBuilder< NavGraphBlob >::m_blobBuffer

inherited

For internal use. Use BLOB_SET and BLOB_ARRAY instead.

The documentation for this class was generated from the following files:

gwnavruntime/navgraph/blobs/navgraphblobbuilder.h
gwnavruntime/navgraph/blobs/navgraphblobbuilder.cpp

Kaim::NavGraphBlobBuilder Class Reference

Class Description

Public Member Functions

Public Attributes

Private Member Functions

Add vertices

Add Monodirectional edges

Add Bidirectional edges

Deprecated ExclusiveNavTag

For internal use only

Member Function Documentation

Member Data Documentation