Firelight Technologies FMOD Studio API

Geometry::getScale

Retrieves the relative scale vector of the geometry object. An object can be scaled/warped in all 3 dimensions separately using the vector.

C++ Syntax

FMOD_RESULT Geometry::getScale(
  FMOD_VECTOR *scale
);

C Syntax

FMOD_RESULT FMOD_Geometry_GetScale(
  FMOD_GEOMETRY *geometry,
  FMOD_VECTOR *scale
);

C# Syntax

RESULT Geometry.getScale(
  out VECTOR scale
);

JavaScript Syntax

Geometry.getScale(
  scale                            // writes value to scale.val
);

Parameters

scale

Address of a variable to receieve the scale vector of the object. Default = 1.0, 1.0, 1.0.

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.

See Also

• Geometry::setScale
• FMOD_VECTOR

Version 1.10.03 Built on Feb 1, 2018