Firelight Technologies FMOD Studio API

Geometry::setPolygonVertex

Alters the position of a polygon's vertex inside a geometry object.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT Geometry.setPolygonVertex(
  int index,
  int vertexindex,
  ref VECTOR vertex
);

JavaScript Syntax

Geometry.setPolygonVertex(
  index,                           
  vertexindex,                     
  vertex                           
);

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 which holds the new vertex location.

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

Note! There may be some significant overhead with this function as it may cause some reconfiguration of internal data structures used to speed up sound-ray testing.

You may get better results if you want to modify your object by using Geometry::setPosition, Geometry::setScale and Geometry::setRotation.

See Also

• Geometry::getPolygonNumVertices
• Geometry::getPolygonNumVertices
• Geometry::setPosition
• Geometry::setScale
• Geometry::setRotation
• Geometry::getNumPolygons
• FMOD_VECTOR

Version 1.10.03 Built on Feb 1, 2018