testPointCollision

Contents, API Reference, Interfaces, iMesh, testPointCollision

iMesh::testPointCollision()

Description

Tests whether the specified position is obstructed for agents with the given collision shape.

Syntax

bool testPointCollision(const iShape* shape, const iCollisionContext* context, const cPosition& position) const;

Parameters

	shape		The collision shape to use for this query.
	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.
	position		The position to be tested. This position must be a valid position on this mesh

Requirements

Requires that collision preprocess has been generated on this mesh for the collision shape specified.
(But see also Performing Collision Queries without Preprocess.)

Return Value

true if the specified position would be obstructed for an agent with the specified and with the specified state of dynamic collision, otherwise false.

Remarks

See The PathEngine Movement Model for details about PathEngine collision.

next: Interface iAgent