Firelight Technologies FMOD Studio API

Geometry::getPolygonVertex

Retrieves the position of the vertex inside a geometry object.

C++ Syntax

FMOD_RESULT Geometry::getPolygonVertex(
  int index,
  int vertexindex,
  FMOD_VECTOR *vertex
);

C Syntax

FMOD_RESULT FMOD_Geometry_GetPolygonVertex(
  FMOD_GEOMETRY *geometry,
  int index,
  int vertexindex,
  FMOD_VECTOR *vertex
);

C# Syntax

RESULT Geometry.getPolygonVertex(
  int index,
  int vertexindex,
  out VECTOR vertex
);

JavaScript Syntax

Geometry.getPolygonVertex(
  index,                           
  vertexindex,                     
  vertex                           // writes value to vertex.val
);

Parameters

index

Polygon index. This must be in the range of 0 to Geometry::getNumPolygons minus 1.

vertexindex

Vertex index inside the polygon. This must be in the range of 0 to Geometry::getPolygonNumVertices minus 1.

vertex

Address of an FMOD_VECTOR structure which will receive the new vertex location in object space.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Vertices are relative to the position of the object. See Geometry::setPosition.

See Also

• Geometry::getPolygonNumVertices
• Geometry::setPosition
• Geometry::getNumPolygons
• FMOD_VECTOR

Version 1.10.03 Built on Feb 1, 2018