iShape

PathEngine home

previous: iPathEngine::totalMemoryAllocated()

next: iShape::size()

Contents, API Reference, Interfaces, iShape

Interface iShape

Description

Define a collision shape that can then be used to create multiple agents.

Defined in SDKRoot/include/i_pathengine.h.

Agents created from the same iShape will share collision and pathfinding preprocess.

Construction and Deletion

iShape objects can be constructed with iPathEngine::newShape().
iShape objects can be deleted explicitly by calling delete on the pointer or by calling the object's destroy() function. All iShape objects are deleted by a call to iPathEngine::deleteAllObjects().
A pointer to an iShape object must not be used after the object has been deleted.

Any shapes not deleted get cleaned up automatically when PathEngine is shut down.

Validation constraints

Refer to Shape Validation for information about constraints on the set of vertices for iShape instances.

Methods:

size		Helper function to return the number of vertices in the shape.
vertex		Helper function for obtaining coordinates of vertices in the shape.

next: iShape::size()