PathEngine home previous: iAgent::getPosition()next: iAgent::getTraverseCost()
Contents, API Reference, Interfaces, iAgent, getShape



A helper function to obtain the Interface iShape that was used to place the agent.


std::unique_ptr<const iShape> getShape() const

Return Value

If the agent was created with an iShape instance (e.g. for agents placed with iMesh::placeAgent()) then a pointer to that iShape instance is returned.

If the agent was created in some other way, without an iShape instance (e.g. for agents placed with iMesh::placeLargeStaticObstacle()) then zero is returned.


To access the underlying agent geometry in the general case, whether or not an iShape object was used to create the agent, iAgent::getNumberOfVertices() and iAgent::getVertexCoordinates() can be used.

C# Mapping

Shape getShape();

Java Mapping

Shape getShape();

Documentation for PathEngine release 6.03 - Copyright © 2002-2021 PathEnginenext: iAgent::getTraverseCost()