Firelight Technologies FMOD Studio API

Geometry::getRotation

Retrieves the orientation of the geometry object.

C++ Syntax

FMOD_RESULT Geometry::getRotation(
  FMOD_VECTOR *forward,
  FMOD_VECTOR *up
);

C Syntax

FMOD_RESULT FMOD_Geometry_GetRotation(
  FMOD_GEOMETRY *geometry,
  FMOD_VECTOR *forward,
  FMOD_VECTOR *up
);

C# Syntax

RESULT Geometry.getRotation(
  out VECTOR forward,
  out VECTOR up
);

JavaScript Syntax

Geometry.getRotation(
  forward,                         // writes value to forward.val
  up                               // writes value to up.val
);

Parameters

forward

Address of a variable that receives the forwards orientation of the geometry object. Specify 0 or NULL to ignore.

up

Address of a variable that receives the upwards orientation of the geometry object. Specify 0 or NULL to ignore.

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

See remarks in System::set3DListenerAttributes for more description on forward and up vectors.

See Also

• Geometry::setRotation
• System::set3DListenerAttributes
• FMOD_VECTOR

Version 1.10.03 Built on Feb 1, 2018