getShape

Contents, API Reference, Interfaces, iAgent, getShape

iAgent::getShape()

Description

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

Syntax

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.

Remarks

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.

next: iAgent::getTraverseCost()