Clarify doc comment

This commit is contained in:
Wojtek Figat
2024-02-21 00:07:38 +01:00
parent 149a6a29f8
commit 97cb8d1b61
2 changed files with 2 additions and 2 deletions

View File

@@ -901,7 +901,7 @@ namespace Math
return length - Abs(Repeat(t, length * 2.0f) - length);
}
// Rotates position about the given axis by the given angle, in radians, and returns the offset to position
// Rotates position about the input axis by the given angle (in radians), and returns the delta to position
Vector3 FLAXENGINE_API RotateAboutAxis(const Vector3& normalizedRotationAxis, float angle, const Vector3& positionOnAxis, const Vector3& position);
Vector3 FLAXENGINE_API ExtractLargestComponent(const Vector3& v);

View File

@@ -241,7 +241,7 @@ float4 FindQuatBetween(float3 from, float3 to)
return normalize(result);
}
// Rotates Position about the given axis by the given angle, in radians, and returns the offset to position
// Rotates position about the input axis by the given angle (in radians), and returns the delta to position
float3 RotateAboutAxis(float4 normalizedRotationAxisAndAngle, float3 positionOnAxis, float3 position)
{
float3 pointOnAxis = positionOnAxis + normalizedRotationAxisAndAngle.xyz * dot(normalizedRotationAxisAndAngle.xyz, position - positionOnAxis);