Geometry::setRotation

FMOD Studio API

Firelight Technologies FMOD Studio API

Geometry::setRotation

Sets the orientation of the geometry object.

C++ Syntax

FMOD_RESULT Geometry::setRotation(
  const FMOD_VECTOR *forward,
  const FMOD_VECTOR *up
);

C Syntax

FMOD_RESULT FMOD_Geometry_SetRotation(
  FMOD_GEOMETRY *geometry,
  const FMOD_VECTOR *forward,
  const FMOD_VECTOR *up
);

C# Syntax

RESULT Geometry.setRotation(
  ref VECTOR forward,
  ref VECTOR up
);

JavaScript Syntax

Geometry.setRotation(
  forward,                         
  up                               
);

Parameters

forward
The forwards orientation of the geometry object. This vector must be of unit length and perpendicular to the up vector. You can specify 0 or NULL to not update the forwards orientation of the geometry object.
up
The upwards orientation of the geometry object. This vector must be of unit length and perpendicular to the forwards vector. You can specify 0 or NULL to not update the upwards orientation of the geometry object.

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




Version 1.10.03 Built on Feb 1, 2018