iMesh::placeAgent()

Description

Constructs an Interface iAgent object to represent placement of an object of a given shape at a point on the surface of this mesh.

Syntax

iAgent* placeAgent(const iShape* shape, const cPosition& position) const;

Parameters

Return Value

Remarks

When an iAgent object is going to be used purely as an obstruction (i.e. the agent will not subsequently be moved, and no collision or pathfinding queries are going to be made through the agent), consider using iMesh::placeLargeStaticObstacle() instead, as this avoids the need to construct an iShape object and bypasses query related range constraints.

The created Interface iAgent can be explicitly deleted when no longer required, but will also be deleted when this mesh is destroyed.

Some discussion of PathEngine's runtime shape management functionality, in general, can be found here.

See Also