connectionIndex

Contents, API Reference, Interfaces, iPath, connectionIndex

iPath::connectionIndex()

Description

Enables the client application to determine whether a given segment in a path corresponds to an 'off-mesh connection'.

Syntax

tSigned32 connectionIndex(tSigned32 segmentIndex) const;

Parameters

segmentIndex

The index for the point at the beginning of the path segment to be queried.

Return Value

-1 if the segment being queried is a standard 'on-mesh' path segment, or else the index of the off-mesh connection corresponding to the segment being queried.

Remarks

The index returned for an off-mesh connection corresponds with the value returned by iMesh::addOffMeshConnection() when adding the connection.

See Off‑Mesh Connections for an overview of the off-mesh connection functionality.

If you are not using off-mesh connections then you don't need to call this method.

next: iPath::getConnectionIndexArray()