PLMath::GraphPath Class Reference

A path can be set of links to graph nodes or owning it's own private nodes. More...

#include <GraphPath.h>

Inheritance diagram for PLMath::GraphPath:

List of all members.

Public Member Functions
PLMATH_API	GraphPath (const PLCore::String &sName, PLCore::ResourceManager< GraphPath > *pManager=nullptr)
	Constructor.
PLMATH_API	GraphPath (Graph *pOwnerGraph=nullptr)
	Constructor.
virtual PLMATH_API	~GraphPath ()
	Destructor.
PLMATH_API Graph *	GetOwnerGraph () const
	Returns the owner graph of the path.
PLMATH_API PLCore::uint32	GetNumOfNodes () const
	Returns the number of nodes.
PLMATH_API bool	AddNode (GraphNode &cNode)
	Adds a node.
PLMATH_API bool	RemoveNode (PLCore::uint32 nNode=0)
	Removes a node.
PLMATH_API const GraphNode *	GetNode (PLCore::uint32 nID=0) const
	Returns a node.
PLMATH_API GraphNode *	GetNode (PLCore::uint32 nID=0)
	Returns a node.
PLMATH_API float	GetLength () const
	Returns the length of the path.
PLMATH_API bool	IsClosed () const
	Returns whether the path is closed or not.
PLMATH_API void	SetClosed (bool bClosed=false)
	Sets if the path is closed or not.
PLMATH_API Vector3	GetPosByNodeIndex (float fNodeIndex, bool bLinear=true) const
	Calculates the position at the given node index.
PLMATH_API Vector3	GetPosByPercentageAlongPath (float fPercentageAlongPath, bool bLinear=true) const
	Calculates the position by using percentage along the path.
virtual PLMATH_API GraphPath &	operator= (const GraphPath &cSource)
virtual PLMATH_API bool	Unload () override
	Unloads the loadable.
virtual PLMATH_API PLCore::String	GetLoadableTypeName () const override
	Returns the loadable type name.

---

Detailed Description

A path can be set of links to graph nodes or owning it's own private nodes.

---

Constructor & Destructor Documentation

PLMATH_API PLMath::GraphPath::GraphPath	(	const PLCore::String &	sName,
		PLCore::ResourceManager< GraphPath > *	pManager = nullptr
	)

Constructor.

Parameters:

[in]	sName	Resource name to set
[in]	pManager	Resource manager using this resource, can be a null pointer

PLMATH_API PLMath::GraphPath::GraphPath

(

Graph *

pOwnerGraph = nullptr

)

Constructor.

Parameters:

[in]

pOwnerGraph

Owner graph, if a null pointer the path has it's own private nodes

Note:

• A path is linking to graph nodes if it's created from for instance Graph::FindShortestPath()

virtual PLMATH_API PLMath::GraphPath::~GraphPath

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLMATH_API Graph* PLMath::GraphPath::GetOwnerGraph

(

)

const

Returns the owner graph of the path.

Returns:

Owner graph of the path, a null pointer if the path is independent

PLMATH_API PLCore::uint32 PLMath::GraphPath::GetNumOfNodes

(

)

const

Returns the number of nodes.

Returns:

Number of path nodes

PLMATH_API bool PLMath::GraphPath::AddNode

(

GraphNode &

cNode

)

Adds a node.

Parameters:

[in]

cNode

Node which should be added, if the path has no owner graph it will delete the node after it is no longer required.

Returns:

'true' if all went fine, else 'false'

PLMATH_API bool PLMath::GraphPath::RemoveNode

(

PLCore::uint32

nNode = 0

)

Removes a node.

Parameters:

[in]

nNode

ID of the node which should be removed

Returns:

'true' if all went fine, else 'false'

PLMATH_API const GraphNode* PLMath::GraphPath::GetNode

(

PLCore::uint32

nID = 0

)

const

Returns a node.

Parameters:

[in]

nID

ID of the node which should be returned

Returns:

The path node, a null pointer if there was an error

PLMATH_API GraphNode* PLMath::GraphPath::GetNode

(

PLCore::uint32

nID = 0

)

Returns a node.

Parameters:

[in]

nID

ID of the node which should be returned

Returns:

The path node, a null pointer if there was an error

PLMATH_API float PLMath::GraphPath::GetLength

(

)

const

Returns the length of the path.

Returns:

Path length

PLMATH_API bool PLMath::GraphPath::IsClosed

(

)

const

Returns whether the path is closed or not.

Returns:

'true' if the path is closed, else 'false'

Note:

• If a path is closed the first node is taken after the last one

PLMATH_API void PLMath::GraphPath::SetClosed

(

bool

bClosed = false

)

Sets if the path is closed or not.

Parameters:

[in]

bClosed

Should the path be closed?

See also:

• IsClosed()

PLMATH_API Vector3 PLMath::GraphPath::GetPosByNodeIndex	(	float	fNodeIndex,
		bool	bLinear = true
	)		const

Calculates the position at the given node index.

Parameters:

[in]	fNodeIndex	Node index (0-<number of="" nodes>="">, automatically wrapped into that range)
[in]	bLinear	Linear interpolation? Else a catmull rom curve is used.

Returns:

The path position corresponding to the given node index

Remarks:

If the position isn't linear interpolated the first and last node are skipped. (only required for the curve progression) Therefore at node index 0 the position will be the position node 2.

PLMATH_API Vector3 PLMath::GraphPath::GetPosByPercentageAlongPath	(	float	fPercentageAlongPath,
		bool	bLinear = true
	)		const

Calculates the position by using percentage along the path.

Parameters:

[in]	fPercentageAlongPath	Percentage along the path (0-1, automatically wrapped into that range)
[in]	bLinear	Linear interpolation? Else a catmull rom curve is used.

Returns:

The path position corresponding to the given percentage along the path

Remarks:

If the position isn't linear interpolated the first and last node are skipped. (only required for the curve progression) Therefore at node index 0 the position will be the position node 2.

virtual PLMATH_API GraphPath& PLMath::GraphPath::operator=

(

const GraphPath &

cSource

)

[virtual]

virtual PLMATH_API bool PLMath::GraphPath::Unload

(

)

[override, virtual]

Unloads the loadable.

Returns:

'true' if all went fine, else 'false'

Reimplemented from PLCore::Loadable.

virtual PLMATH_API PLCore::String PLMath::GraphPath::GetLoadableTypeName

(

)

const [override, virtual]

Returns the loadable type name.

Returns:

The loadable type name

Reimplemented from PLCore::Loadable.

---

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

• GraphPath.h