PathEngine home previous: iMesh::findPathAway_WithQueryCallBack()next: iMesh::findShortestPath6()
Contents, API Reference, Interfaces, iMesh, findShortestPath

iMesh::findShortestPath()

Description

Finds the shortest path from a given start position to a given end position for agents with a specified collision shape.

Syntax

iPath* findShortestPath(const iShape* shape, const iCollisionContext* context, const cPosition& start, const cPosition& goal) const;

Parameters

shape The collision shape to use for this query.
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.
start The start point for pathfinding.
This position must be a valid position on this mesh, and must not be obstructed by the base mesh or burnt-in obstacles.
goal The target point for pathfinding.
This position must be a valid position on this mesh.

Requirements

Requires that pathfind preprocess has been generated on this mesh for the collision shape specified.

Return Value

A newly created Interface iPath object, if a path can be found.
Otherwise a zero pointer is returned.

Remarks

Calling this method is functionally equivalent to calling iMesh::findShortestPath_WithQueryCallBack(), with null for the callback parameter.

C# Mapping

Path findShortestPath(Shape shape, CollisionContext context, PathEngine.Position start, PathEngine.Position goal);

Java Mapping

Path findShortestPath(Shape shape, CollisionContext context, Position start, Position goal);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::findShortestPath6()