generateCurvedPath

next: iAgent::generateCurvedPath_WithEndVector()

Contents, API Reference, Interfaces, iAgent, generateCurvedPath

iAgent::generateCurvedPath()

Description

Post process path smoothing.
Returns a new path based on a 'base path', but with corners smoothed according to supplied parameters.

Syntax

iPath* generateCurvedPath(iPath* basePath, const iCollisionContext* context, tSigned32 startVectorX, tSigned32 startVectorY, tSigned32 sectionLength, float turnRatio1, float turnRatio2) const;

Parameters

	basePath		A straight line path from which to generate the curved path.
	context		The state of dynamic collision that will apply for this query. An empty context can be specified by passing a value of zero for this argument. Note that the agent is not considered to obstruct itself even if included in this context.
	startVectorX		X component of a start vector to incorporate into the curved path. Must be in the range -1500000 to 1500000.
	startVectorY		Y component of a start vector to incorporate into the curved path. Must be in the range -1500000 to 1500000.
	sectionLength		Desired minimum section length for the curved path.
	turnRatio1		Desired maximum turn angle for a first pass, specified as a ratio.
	turnRatio2		Desired maximum turn angle for a second pass, specified as a ratio.

Requirements

Requires that the agent is moveable and that collision preprocess has been generated on the agent's mesh for the agent's collision shape.

Return Value

If basePath is not a null pointer then this method always returns a newly created Interface iPath object for the smoothed path.
If basePath is a null pointer then a null pointer will be returned

Remarks

Legacy version of iAgent::generateCurvedPath_WithEndVector().
Equivalent to calling that method with both end vector parameters set to zero.

next: iAgent::generateCurvedPath_WithEndVector()