math2d 1.2.1 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa9e7785755d0911beda7ece84a14f4b0234d9103ae593b556237be3403973e
-  data.tar.gz: ba748b29f8499d5ef2504942b4ee7c7dc3c9bad9d6fb5393f9aa78fd6d303cab
+  metadata.gz: 7d41532de5491da28b9de631463ae49ab77b12bd17ecac7f7efacf28e508a5d9
+  data.tar.gz: 763fe0ac3840a0cb9b241514c8baac852a9388059428e89fce516116ab659b02
 SHA512:
-  metadata.gz: c494f9101b180ec9d2072630d48bbb9e0b99b404dec093ccaf35b4856cd75a8a11d4eed8478449a51f5bc3a37a239d37ab6899c35c558b24ff439490a64b88ff
-  data.tar.gz: 4f79cd577b4c2686e07fe8b36b30cf28f8b1e4aac13e48e51df3d9e0a64b80454ca10076dbe06734d36b511cacb044a0101a5e614cebb766bb5a7dce880df84d
+  metadata.gz: ea01a56166ba411a2d015d67fb45224f072dfc6a2d57e00683ebc40216aa3dfae88e9b7a4a7cc057beae2eed42dd6a97eb5fc7553ed51c4593564bdc92997d86
+  data.tar.gz: c911d1c8bdc54a010588c07294601b1e9e5549bd35c8a76bc8e461683bdb09e37a01bf5d2fc98867e89795b45c420bb42f426b18e9b4c94cf39151fd2947f824

data/lib/math2d/utils2d.rb

@@ -13,12 +13,19 @@ module Math2D
     # Twice the mathematical constant PI, also called TAU.
     TWO_PI = TAU = Math::PI * 2
 
+    # Multiplication constant to convert a value in degrees to radians
+    # @note Can be used as a substitute to +Utils2D.to_deg+.
+    DEG2RAD      = Math::PI / 180
+    # Multiplication constant to convert a value in degrees to radians
+    # @note Can be used as a substitute to +Utils2D.to_rad+.
+    RAD2DEG      = 180 / Math::PI
+
     # Returns +angle+ radians in degrees.
     #
     # @param [Numeric] angle
     # @return [Float]
     def self.to_deg(angle)
-      (180 * angle) / Math::PI
+      angle * DEG2RAD
     end
 
     # Returns +angle+ degrees in radians.
@@ -26,7 +33,7 @@ module Math2D
     # @param [Numeric] angle
     # @return [Float]
     def self.to_rad(angle)
-      (Math::PI * angle) / 180
+      angle * RAD2DEG
     end
 
     # Returns the distance between two cartesian points.
@@ -48,11 +55,23 @@ module Math2D
     #
     # @param [Numeric] a
     # @param [Numeric] b
+    # @param [Numeric] amt
     # @return [Float]
     def self.lerp(a, b, amt)
       (b - a) * (3.0 - amt * 2.0) * amt * amt + a
     end
 
+    # Being the inverse of +#lerp+, it calculates the interpolation parameter t
+    #  of the Lerp method given a range [+a+, +b+] and a interpolant value of +value+.
+    #
+    # @param [Numeric] a
+    # @param [Numeric] b
+    # @param [Numeric] value
+    # @return [Float]
+    def self.inverse_lerp(a, b, value)
+      (value - a) / (b - a).to_f
+    end
+
     # Re-maps a number from one range (+a1+..+a2+) to another (+b1+..+b2+).
     #
     # @param [Numeric] value

data/lib/math2d/vector2d.rb

@@ -127,6 +127,10 @@ module Math2D
       Vector2D.new(@x / other, @y / other)
     end
 
+    def ==(other)
+      (@x == other.x) && (@y == other.y)
+    end
+
     # Calculates the dot product between +self+ and +other+, where:
     # A.B (A dot B) = (Ax * Bx) + (Ay * By)
     #
@@ -136,10 +140,12 @@ module Math2D
       (@x * other.x) + (@y * other.y)
     end
 
-    # Calculates the cross product between +self+ and +other+, where:
-    # AxB (A cross B) = (Ax * By) - (Bx * Ay)
-    # HOWEVER, the cross product is NOT defined in a 2D space, so the operation
-    # simply returns the magnitude of the resulting cross-product 3D vector.
+    # Calculates the "cross product" (see note) between +self+ and +other+, where:
+    # A^B (A wedge B) = (Ax * By) - (Bx * Ay)
+    #
+    # @note Strictly speaking, the cross product is not defined in a 2-dimensional space,
+    # instead what is being calculated here is called a `wedge product`, which is defined
+    # in any space of dimension greater than 1.
     #
     # @param [Vector2D] other
     # @return [Numeric]
@@ -147,6 +153,8 @@ module Math2D
       (@x * other.y) - (other.x * @y)
     end
 
+    alias wedge cross
+
     # Returns the magnitude squared of +self+.
     #
     # @return [Numeric]
@@ -161,6 +169,8 @@ module Math2D
       Math.sqrt(@x**2 + @y**2)
     end
 
+    alias length magnitude
+
     # Returns the Euclidean distance between +self+ and +other+.
     #
     # @param [Vector2D] other
@@ -273,6 +283,14 @@ module Math2D
       Math.acos((@x * other.x + @y * other.y) / (magnitude * other.magnitude))
     end
 
+    # Checks if +self+ is facing the opposite direction of +other+.
+    #
+    # @param [Vector2D] other
+    # @return [Boolean]
+    def opposite?(other)
+      dot(other) < 0
+    end
+
     # Clockwise rotates +self+ +angle+ radians and returns it as a new Vector2D.
     #
     # @param [Numeric] angle
@@ -305,6 +323,15 @@ module Math2D
       self + (other - self) * amt
     end
 
+    # Calculates the parameter t of the +#lerp+ method between +self+ and +other+ given an interpolant +value+.
+    #
+    # @param [Numeric, Vector2D] other
+    # @param [Vector2D] value
+    # @return [Vector2D]
+    def inverse_lerp(other, value)
+      (value - self) / (other - self)
+    end
+
     # Reflects +self+ and returns it as a new Vector2D.
     # +other+ is the normal of the plane where +self+ is reflected.
     #
@@ -318,6 +345,24 @@ module Math2D
       Vector2D.new(x, y)
     end
 
+    # Refracts +self+ and returns it as a new Vector2D.
+    # +other+ is the normal of the plane where +self+ is refracted.
+    #
+    # @see https://www.khronos.org/registry/OpenGL/specs/gl/GLSLangSpec.1.20.pdf GLS Language Specification (page 66)
+    #
+    # @param [Vector2D] other
+    # @param [Numeric] refractive_index
+    # @return [Vector2D]
+    def refract(other, refractive_index)
+      dot_prod = other.dot(self)
+      k = 1.0 - refractive_index * refractive_index * (1.0 - dot_prod * dot_prod)
+      return Vector2D.zero if k.negative?
+
+      x = refractive_index * @x - (refractive_index * dot_prod * Math.sqrt(k)) * other.x
+      y = refractive_index * @y - (refractive_index * dot_prod * Math.sqrt(k)) * other.y
+      Vector2D.new(x, y)
+    end
+
     # Returns a new Vector2D with random components but magnitude equal to 1.
     #
     # @return [Vector2D]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: math2d
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: '1.3'
 platform: ruby
 authors:
 - Ualace Henrique
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies: []
 description: A collection of useful Mathematical and Vector tools in 2D space
 email:
@@ -38,7 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Math2D