positionInSectionNear3DPoint

previous: iMesh::positionInSectionInShape()

next: iMesh::positionIsBlockedBySurfaceTypeTraverseCosts()

Contents, API Reference, Interfaces, iMesh, positionInSectionNear3DPoint

iMesh::positionInSectionNear3DPoint()

Description

Variation on iMesh::positionNear3DPoint() enabling the resulting position to be restricted to a specified section.

Syntax

cPosition positionInSectionNear3DPoint(tSigned32 sectionID, const tSigned32* point, tSigned32 horizontalRange, tSigned32 verticalRange) const;

Parameters

	sectionID		The section to which the resulting position should be restricted. A value of -1 may be passed in to indicate the entire mesh.
	point		This parameter must point to an array of three elements. These are interpreted as x,y,z, where z is height.
	horizontalRange		Looks for a position with x and y components within plus or minus horizontalRange of the target point x and y.
	verticalRange		Looks for a position with ground height within plus or minus verticalRange of the target point z.

Requirements

The range resulting from adding and subtracting horizontalRange to the horizontal components of point must not overflow the supported range for world coordinates.
(See PathEngine Coordinates.)

Return Value

A cPosition representing a point on the mesh and in the specified section within (approximately) the specified range.
If there is no such position then an explicitly invalid position is returned (i.e. a cPosition with cell set to -1).

Remarks

This method works in a similar way to iMesh::positionNear3DPoint(), so refer to the remarks for that method for details about the actual approach used for resolving a ground point, and limitations resulting from this approach.

See Converting to and from PathEngine's Position Representation for an overview of all the position conversion methods.

next: iMesh::positionIsBlockedBySurfaceTypeTraverseCosts()