PathEngine home previous: iCollisionContext::updatePathfindingPreprocessFor()next: iObstacleSet::addAgent()
Contents, API Reference, Interfaces, iObstacleSet

Interface iObstacleSet

Description

Used to create free standing sets of obstacles, that can then be combined in collision contexts.

Defined in SDKRoot/code/externalAPI/i_pathengine.h.

Refer to this page for a discussion of run-time obstacle management.

Construction and Deletion

iObstacleSet objects can be constructed with iMesh::newObstacleSet() or iMesh::newObstacleSet_WithAttributes().
iObstacleSet objects can be released explicitly by calling delete on the pointer or by calling the object's release() function. A pointer to an iObstacleSet object must not be used after the object has been deleted.

Methods:

addAgent

Adds a specified agent to this obstacle set.

addExternalRef

Increments the internal reference count for this API object.

clear

Removes all agents.

connectedRegionPreprocessNeedsUpdate

Checks the validity of preprocess, on obstacle sets marked for preprocessing.

empty

Returns true if the set is empty.

getAgent

Provided for iterating through the agents in the set.

getConnectedRegionFor

Returns an index for the connected region at a given position. This can be used to quickly determine the reachability between positions.

getConnectedRegionForAgent

Returns an index for the connected region for an agent's current position.

getNumberOfAgents

Tells you how many agents are currently included in the set.

getNumberOfConnectedRegions

Returns the number of distinct regions in connected region preprocess for the specified shape.

hasRefs

Enables you to check whether there are any outstanding references on this object, other than the interface reference through which you are calling, and therefore whether this object will actually be deleted if you call it's release method.

includes

Tells you if a specified agent is included in this set.

loadPathfindPreprocessFor

Loads preprocess from persistent storage.

pathfindPreprocessNeedsUpdate

Checks the validity of preprocess, on obstacle sets marked for preprocessing.

refAgent

Provided for iterating through the agents in an obstacle set.

release

Releases the API object pointer.

removeAgent

Removes a specified agent from this set.

restoreTemporarilyIgnoredAgent

Restores an agent that was previously marked as excluded from collision state.

savePathfindPreprocessFor

Saves preprocess to persistent storage.

size

Equivalent to calling getNumberOfAgents()

temporarilyIgnoreAgent

Flags a specified agent as excluded from the obstacle set collision state, without invalidating cached state data.

updateConnectedRegionPreprocessFor

Enables the application to force generation of pathfind preprocess associated with the obstacle set, for preprocessed obstacle sets.

updatePathfindPreprocessFor

Enables the application to force generation of pathfind preprocess associated with the obstacle set, for preprocessed obstacle sets.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iObstacleSet::addAgent()