retrieveAnchor

previous: iMesh::resolvePositionsNear3DPoint()

Contents, API Reference, Interfaces, iMesh, retrieveAnchor

iMesh::retrieveAnchor()

Description

Retrieve named positions stored with this mesh.

Syntax

cPosition retrieveAnchor(const char* id, int32_t& orientation) const;

Parameters

	id		Content ID for the position to retrieve. This pointer is not retained after the method exits and may subsequently be safely deleted.
	orientation		If an anchor is found with the given id then the orientation is returned via this parameter. See PathEngine Angles.

Return Value

If an anchor has been stored with this mesh with the given id then that position is returned.
Otherwise an explicitly invalid position is returned. (i.e. cell is set to -1)

C# Mapping

PathEngine.Position retrieveAnchor(string id, out int orientation);

Java Mapping

Position retrieveAnchor(String id, int_OutArgument orientation);

next: iMesh::retrieveAnchorByIndex()