🚧 Clarified refract valid range of the indices of refraction, between -1 and 1 inclusively #806

Author: elect86

glm/src/main/kotlin/glm_/func/func_geometric.kt

@@ -263,68 +263,76 @@ interface func_geometric {
 
 
     fun refract(i: Float, n: Float, eta: Float): Float {
+        assert(eta >= -1f && eta <= 1f)
         val dot = dot(n, i)
         val k = 1f - eta * eta * (1f - dot * dot)
         return (eta * i - (eta * dot + sqrt(k)) * n) * if (k >= 0f) 1f else 0f
     }
 
     fun refract(i: Double, n: Double, eta: Double): Double {
+        assert(eta >= -1.0 && eta <= 1.0)
         val dot = dot(n, i)
         val k = 1.0 - eta * eta * (1.0 - dot * dot)
         return (eta * i - (eta * dot + sqrt(k)) * n) * if (k >= 0.0) 1.0 else 0.0
     }
 
-    fun refract(i: Vec2, n: Vec2, eta: Number, res: Vec2 = Vec2()): Vec2 {
+    fun refract(i: Vec2, n: Vec2, eta: Float, res: Vec2 = Vec2()): Vec2 {
+        assert(eta >= -1f && eta <= 1f)
         val dot = dot(n, i)
-        val k = 1f - eta.f * eta.f * (1f - dot * dot)
-        res.x = eta.f * i.x - (eta.f * dot + sqrt(k)) * n.x * if (k >= 0f) 1f else 0f
-        res.y = eta.f * i.y - (eta.f * dot + sqrt(k)) * n.y * if (k >= 0f) 1f else 0f
+        val k = 1f - eta * eta * (1f - dot * dot)
+        res.x = eta * i.x - (eta * dot + sqrt(k)) * n.x * if (k >= 0f) 1f else 0f
+        res.y = eta * i.y - (eta * dot + sqrt(k)) * n.y * if (k >= 0f) 1f else 0f
         return res
     }
 
-    fun refract(i: Vec2d, n: Vec2d, eta: Number, res: Vec2d = Vec2d()): Vec2d {
+    fun refract(i: Vec2d, n: Vec2d, eta: Double, res: Vec2d = Vec2d()): Vec2d {
+        assert(eta >= -1.0 && eta <= 1.0)
         val dot = dot(n, i)
-        val k = 1.0 - eta.d * eta.d * (1.0 - dot * dot)
-        res.x = eta.d * i.x - (eta.d * dot + sqrt(k)) * n.x * if (k >= 0.0) 1.0 else 0.0
-        res.y = eta.d * i.y - (eta.d * dot + sqrt(k)) * n.y * if (k >= 0.0) 1.0 else 0.0
+        val k = 1.0 - eta * eta * (1.0 - dot * dot)
+        res.x = eta * i.x - (eta * dot + sqrt(k)) * n.x * if (k >= 0.0) 1.0 else 0.0
+        res.y = eta * i.y - (eta * dot + sqrt(k)) * n.y * if (k >= 0.0) 1.0 else 0.0
         return res
     }
 
-    fun refract(i: Vec3, n: Vec3, eta: Number, res: Vec3 = Vec3()): Vec3 {
+    fun refract(i: Vec3, n: Vec3, eta: Float, res: Vec3 = Vec3()): Vec3 {
+        assert(eta >= -1f && eta <= 1f)
         val dot = dot(n, i)
-        val k = 1f - eta.f * eta.f * (1f - dot * dot)
-        res.x = eta.f * i.x - (eta.f * dot + sqrt(k)) * n.x * if (k >= 0f) 1f else 0f
-        res.y = eta.f * i.y - (eta.f * dot + sqrt(k)) * n.y * if (k >= 0f) 1f else 0f
-        res.z = eta.f * i.z - (eta.f * dot + sqrt(k)) * n.z * if (k >= 0f) 1f else 0f
+        val k = 1f - eta * eta * (1f - dot * dot)
+        res.x = eta * i.x - (eta * dot + sqrt(k)) * n.x * if (k >= 0f) 1f else 0f
+        res.y = eta * i.y - (eta * dot + sqrt(k)) * n.y * if (k >= 0f) 1f else 0f
+        res.z = eta * i.z - (eta * dot + sqrt(k)) * n.z * if (k >= 0f) 1f else 0f
         return res
     }
 
-    fun refract(i: Vec3d, n: Vec3d, eta: Number, res: Vec3d = Vec3d()): Vec3d {
+    fun refract(i: Vec3d, n: Vec3d, eta: Double, res: Vec3d = Vec3d()): Vec3d {
+        assert(eta >= -1.0 && eta <= 1.0)
         val dot = dot(n, i)
-        val k = 1.0 - eta.d * eta.d * (1.0 - dot * dot)
-        res.x = eta.d * i.x - (eta.d * dot + sqrt(k)) * n.x * if (k >= 0.0) 1.0 else 0.0
-        res.y = eta.d * i.y - (eta.d * dot + sqrt(k)) * n.y * if (k >= 0.0) 1.0 else 0.0
-        res.z = eta.d * i.z - (eta.d * dot + sqrt(k)) * n.z * if (k >= 0.0) 1.0 else 0.0
+        val k = 1.0 - eta * eta * (1.0 - dot * dot)
+        res.x = eta * i.x - (eta * dot + sqrt(k)) * n.x * if (k >= 0.0) 1.0 else 0.0
+        res.y = eta * i.y - (eta * dot + sqrt(k)) * n.y * if (k >= 0.0) 1.0 else 0.0
+        res.z = eta * i.z - (eta * dot + sqrt(k)) * n.z * if (k >= 0.0) 1.0 else 0.0
         return res
     }
 
-    fun refract(i: Vec4, n: Vec4, eta: Number, res: Vec4 = Vec4()): Vec4 {
+    fun refract(i: Vec4, n: Vec4, eta: Float, res: Vec4 = Vec4()): Vec4 {
+        assert(eta >= -1f && eta <= 1f)
         val dot = dot(n, i)
-        val k = 1f - eta.f * eta.f * (1f - dot * dot)
-        res.x = eta.f * i.x - (eta.f * dot + sqrt(k)) * n.x * if (k >= 0f) 1f else 0f
-        res.y = eta.f * i.y - (eta.f * dot + sqrt(k)) * n.y * if (k >= 0f) 1f else 0f
-        res.z = eta.f * i.z - (eta.f * dot + sqrt(k)) * n.z * if (k >= 0f) 1f else 0f
-        res.w = eta.f * i.w - (eta.f * dot + sqrt(k)) * n.w * if (k >= 0f) 1f else 0f
+        val k = 1f - eta * eta * (1f - dot * dot)
+        res.x = eta * i.x - (eta * dot + sqrt(k)) * n.x * if (k >= 0f) 1f else 0f
+        res.y = eta * i.y - (eta * dot + sqrt(k)) * n.y * if (k >= 0f) 1f else 0f
+        res.z = eta * i.z - (eta * dot + sqrt(k)) * n.z * if (k >= 0f) 1f else 0f
+        res.w = eta * i.w - (eta * dot + sqrt(k)) * n.w * if (k >= 0f) 1f else 0f
         return res
     }
 
-    fun refract(i: Vec4d, n: Vec4d, eta: Number, res: Vec4d = Vec4d()): Vec4d {
+    fun refract(i: Vec4d, n: Vec4d, eta: Double, res: Vec4d = Vec4d()): Vec4d {
+        assert(eta >= -1.0 && eta <= 1.0)
         val dot = dot(n, i)
-        val k = 1.0 - eta.d * eta.d * (1.0 - dot * dot)
-        res.x = eta.d * i.x - (eta.d * dot + sqrt(k)) * n.x * if (k >= 0.0) 1.0 else 0.0
-        res.y = eta.d * i.y - (eta.d * dot + sqrt(k)) * n.y * if (k >= 0.0) 1.0 else 0.0
-        res.z = eta.d * i.z - (eta.d * dot + sqrt(k)) * n.z * if (k >= 0.0) 1.0 else 0.0
-        res.w = eta.d * i.w - (eta.d * dot + sqrt(k)) * n.w * if (k >= 0.0) 1.0 else 0.0
+        val k = 1.0 - eta * eta * (1.0 - dot * dot)
+        res.x = eta * i.x - (eta * dot + sqrt(k)) * n.x * if (k >= 0.0) 1.0 else 0.0
+        res.y = eta * i.y - (eta * dot + sqrt(k)) * n.y * if (k >= 0.0) 1.0 else 0.0
+        res.z = eta * i.z - (eta * dot + sqrt(k)) * n.z * if (k >= 0.0) 1.0 else 0.0
+        res.w = eta * i.w - (eta * dot + sqrt(k)) * n.w * if (k >= 0.0) 1.0 else 0.0
         return res
     }
 }