Initial Commit

Initial Commit [v1.32PRC8]

_module/nss/util_i_math.nss

@@ -0,0 +1,111 @@
+// -----------------------------------------------------------------------------
+//    File: util_i_math.nss
+//  System: Utilities
+//     URL: https://github.com/squattingmonk/nwn-core-framework
+// Authors: Michael A. Sinclair (Squatting Monk) <squattingmonk@gmail.com>
+// -----------------------------------------------------------------------------
+// This file contains useful math utility functions. Note than some of the float
+// functions (notably fmod) may be slightly off (+/- a millionth) due to the
+// nature of floating point arithmetic.
+// -----------------------------------------------------------------------------
+
+// -----------------------------------------------------------------------------
+//                              Function Prototypes
+// -----------------------------------------------------------------------------
+
+// ---< clamp >---
+// ---< util_i_math >---
+// If nValue is less than nMin, returns nMin. If nValue is greater than nMax,
+// returns nMax. Otherwise, returns nValue.
+int clamp(int nValue, int nMin, int nMax);
+
+// ---< fclamp >---
+// ---< util_i_math >---
+// If fValue is less than fMin, returns fMin. If fValue is greater than fMax,
+// returns fMax. Otherwise, returns fValue.
+float fclamp(float fValue, float fMin, float fMax);
+
+// ---< max >---
+// ---< util_i_math >---
+// Returns the larger of two integers.
+int max(int a, int b);
+
+// ---< min >---
+// ---< util_i_math >---
+// Returns the smaller of two integers
+int min(int a, int b);
+
+// ---< fmax >---
+// ---< util_i_math >---
+// Returns the larger of two floats.
+float fmax(float a, float b);
+
+// ---< fmin >---
+// ---< util_i_math >---
+// Returns the smaller of two floats.
+float fmin(float a, float b);
+
+// ---< floor >---
+// ---< util_i_math >---
+// Returns f rounded to the nearest whole number.
+float floor(float f);
+
+// ---< frac >---
+// ---< util_i_math >---
+// Returns the fractional part of f (i.e., the numbers to the right of the
+// decimal point).
+float frac(float f);
+
+// ---< fmod >---
+// ---< util_i_math >---
+// Returns a % b (modulo function).
+float fmod(float a, float b);
+
+// -----------------------------------------------------------------------------
+//                             Function Definitions
+// -----------------------------------------------------------------------------
+
+int clamp(int nValue, int nMin, int nMax)
+{
+    return (nValue < nMin) ? nMin : ((nValue > nMax) ? nMax : nValue);
+}
+
+float fclamp(float fValue, float fMin, float fMax)
+{
+    return (fValue < fMin) ? fMin : ((fValue > fMax) ? fMax : fValue);
+}
+
+int max(int a, int b)
+{
+    return (b > a) ? b : a;
+}
+
+int min(int a, int b)
+{
+    return (b > a) ? a : b;
+}
+
+float fmax(float a, float b)
+{
+    return (b > a) ? b : a;
+}
+
+float fmin(float a, float b)
+{
+    return (b > a) ? a : b;
+}
+
+float floor(float f)
+{
+    return IntToFloat(FloatToInt(f));
+}
+
+float frac(float f)
+{
+    return f - floor(f);
+}
+
+float fmod(float a, float b)
+{
+    return a - b * floor(a / b);
+}