PathEngine home previous: iMesh::getNumberOfSections()next: iMesh::getOrigin()
Contents, API Reference, Interfaces, iMesh, getOffMeshConnectionInfo

iMesh::getOffMeshConnectionInfo()

Description

Helper function for retrieving information about off-mesh connections stored with a mesh.

Syntax

void getOffMeshConnectionInfo(int32_t index, int32_t& fromEndPoint, int32_t& toEndPoint, int32_t& penalty) const;

Parameters

index The index of the connection for which information is to be retrieved.
fromEndPoint The index for the source endpoint of the connection is returned in this parameter.
toEndPoint The index for the target endpoint of the connection is returned in this parameter.
penalty The penalty associated with the connection is returned in this parameter.

Remarks

See Off‑Mesh Connections for an overview of the off-mesh connection functionality, and Working with Off‑Mesh Connections for information about other methods relating to this functionality.

C# Mapping

void getOffMeshConnectionInfo(int index, out int fromEndPoint, out int toEndPoint, out int penalty);

Java Mapping

void getOffMeshConnectionInfo(int index, int_OutArgument fromEndPoint, int_OutArgument toEndPoint, int_OutArgument penalty);

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