GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify doc comment

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

2
Source/Engine/Core/Math/Math.h
View File

@@ -901,7 +901,7 @@ namespace Math
return length - Abs(Repeat(t, length * 2.0f) - length); 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 RotateAboutAxis(const Vector3& normalizedRotationAxis, float angle, const Vector3& positionOnAxis, const Vector3& position);
Vector3 FLAXENGINE_API ExtractLargestComponent(const Vector3& v); Vector3 FLAXENGINE_API ExtractLargestComponent(const Vector3& v);

2
Source/Shaders/Math.hlsl
View File

@@ -241,7 +241,7 @@ float4 FindQuatBetween(float3 from, float3 to)
return normalize(result); 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 RotateAboutAxis(float4 normalizedRotationAxisAndAngle, float3 positionOnAxis, float3 position)
{ {
float3 pointOnAxis = positionOnAxis + normalizedRotationAxisAndAngle.xyz * dot(normalizedRotationAxisAndAngle.xyz, position - positionOnAxis); float3 pointOnAxis = positionOnAxis + normalizedRotationAxisAndAngle.xyz * dot(normalizedRotationAxisAndAngle.xyz, position - positionOnAxis);