PathEngine home previous: iAgent::generateCurvedPath_WithEndVector()next: iAgent::getMesh()
Contents, API Reference, Interfaces, iAgent, getAllAgentsOverlapped

iAgent::getAllAgentsOverlapped()

Description

Fills a buffer with the set of agents in a given context overlapped by this agent.

Syntax

void getAllAgentsOverlapped(const iCollisionContext* context, iAgent** resultsBuffer, tSigned32& numberOverlapped) const;

Parameters

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.
resultsBufferA pointer to a buffer to be filled with the results of the query. The buffer must be large enough to hold the maximum number of agents that could potentially be returned by the query.
numberOverlappedReturns the number of agents overlapped.

Requirements

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

Remarks

This method is equivalent to calling through to iMesh::getAllAgentsOverlapped() on the agent's mesh with the agent's position and collision shape.


Documentation for PathEngine release 5.17 - Copyright © 2002-2008 PathEnginenext: iAgent::getMesh()