PathEngine home previous: iMesh::positionIsBlockedBySurfaceTypeTraverseCosts()next: iMesh::positionNear3DPoint()
Contents, API Reference, Interfaces, iMesh, positionIsValid

iMesh::positionIsValid()

Description

Returns whether or not the specified position is a valid position on this mesh.

Syntax

bool positionIsValid(const cPosition& p) const;

Parameters

p The position to test for validity.

Return Value

true, if the position is a valid position on this mesh, otherwise false.

Remarks

All positions set by PathEngine (with positionFor3DPoint(), for example) are guaranteed to be valid or explicitly marked as invalid by having cell set to -1.
So most of the time this method is not required.
It can be useful, however, as a safety check when restoring positions from persistent store, or when working with multiple meshes simultaneously.

See Also

iMesh::positionFor3DPoint()

C# Mapping

bool positionIsValid(PathEngine.Position p);

Java Mapping

boolean positionIsValid(Position p);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::positionNear3DPoint()