snow-math 1.3.1 → 1.4.2

data/ext/snow-math/vec2.c

@@ -0,0 +1,134 @@
+/*
+  2D vector maths
+  Written by Noel Cower
+
+  See COPYING for license information
+*/
+
+#define __SNOW__VEC2_C__
+
+#include "maths_local.h"
+
+#if defined(__cplusplus)
+extern "C"
+{
+#endif /* __cplusplus */
+
+const vec2_t g_vec2_zero = {s_float_lit(0.0), s_float_lit(0.0)};
+const vec2_t g_vec2_one = {s_float_lit(1.0), s_float_lit(1.0)};
+
+void vec2_copy(const vec2_t in, vec2_t out)
+{
+  out[1] = in[1];
+  out[0] = in[0];
+}
+
+void vec2_set(s_float_t x, s_float_t y, vec2_t v)
+{
+  v[0] = x;
+  v[1] = y;
+}
+
+/*!
+ * Gets the squared length of a vector.  Useful for approximations and when
+ * you don't need the actual magnitude.
+ */
+s_float_t vec2_length_squared(const vec2_t v)
+{
+  return (v[0] * v[0]) + (v[1] * v[1]);
+}
+
+/*!
+ * Gets the length/magnitude of a vector.
+ */
+s_float_t vec2_length(const vec2_t v)
+{
+  return s_sqrt((v[0] * v[0]) + (v[1] * v[1]));
+}
+
+void vec2_normalize(const vec2_t in, vec2_t out)
+{
+  s_float_t mag = vec2_length(in);
+  if (mag) mag = s_float_lit(1.0) / mag;
+  out[1] = in[1] * mag;
+  out[0] = in[0] * mag;
+}
+
+void vec2_subtract(const vec2_t left, const vec2_t right, vec2_t out)
+{
+  out[1] = left[1] - right[1];
+  out[0] = left[0] - right[0];
+}
+
+void vec2_add(const vec2_t left, const vec2_t right, vec2_t out)
+{
+  out[1] = left[1] + right[1];
+  out[0] = left[0] + right[0];
+}
+
+void vec2_multiply(const vec2_t left, const vec2_t right, vec2_t out)
+{
+  out[1] = left[1] * right[1];
+  out[0] = left[0] * right[0];
+}
+
+void vec2_negate(const vec2_t v, vec2_t out)
+{
+  out[1] = -v[1];
+  out[0] = -v[0];
+}
+
+void vec2_inverse(const vec2_t v, vec2_t out)
+{
+  out[1] = (!float_is_zero(v[1])) ? (s_float_lit(1.0) / v[1]) : v[1];
+  out[0] = (!float_is_zero(v[0])) ? (s_float_lit(1.0) / v[0]) : v[0];
+}
+
+void vec2_project(const vec2_t in, const vec2_t normal, vec2_t out)
+{
+  vec2_scale(normal, vec2_dot_product(in, normal), out);
+}
+
+void vec2_reflect(const vec2_t in, const vec2_t normal, vec2_t out)
+{
+  vec2_t temp;
+  vec2_scale(normal, s_float_lit(2.0) * vec2_dot_product(in, normal), temp);
+  vec2_subtract(in, temp, out);
+}
+
+s_float_t vec2_dot_product(const vec2_t left, const vec2_t right)
+{
+  return ((left[0] * right[0]) + (left[1] * right[1]));
+}
+
+void vec2_scale(const vec2_t v, s_float_t scalar, vec2_t out)
+{
+   out[1] = v[1] * scalar;
+   out[0] = v[0] * scalar;
+}
+
+/*!
+ * Divides the given vector by the divisor.
+ * \returns Zero if successful, otherwise nonzero if the result is undefined.
+ */
+int vec2_divide(const vec2_t v, s_float_t divisor, vec2_t out)
+{
+  if (divisor) {
+    divisor = s_float_lit(1.0) / divisor;
+    out[1] = v[1] * divisor;
+    out[0] = v[0] * divisor;
+    return 1;
+  }
+  return 0;
+}
+
+int vec2_equals(const vec2_t left, const vec2_t right)
+{
+  return float_equals(left[0], right[0]) &&
+         float_equals(left[1], right[1]);
+}
+
+#if defined(__cplusplus)
+}
+#endif /* __cplusplus */
+

data/lib/snow-math.rb

@@ -3,6 +3,7 @@
 # See COPYING for license details.
 
 require 'snow-math/bindings'
+require 'snow-math/vec2'
 require 'snow-math/vec3'
 require 'snow-math/vec4'
 require 'snow-math/mat3'
@@ -21,6 +22,6 @@ module Snow
   #
   # snow-math bindings version string.
   #
-  SNOW_MATH_VERSION = '1.3.0'
+  SNOW_MATH_VERSION = '1.4.2'
 
 end

data/lib/snow-math/inspect.rb

@@ -2,7 +2,8 @@
 # Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
 # See COPYING for license details.
 
-require 'snow-math'
+require 'snow-math/bindings'
+require 'snow-math/to_a'
 
 module Snow
 
@@ -34,12 +35,17 @@ module Snow
 
   end
 
+  class Vec2 ; include ::Snow::InspectSupport ; end
   class Vec3 ; include ::Snow::InspectSupport ; end
   class Vec4 ; include ::Snow::InspectSupport ; end
   class Quat ; include ::Snow::InspectSupport ; end
   class Mat3 ; include ::Snow::InspectSupport ; end
   class Mat4 ; include ::Snow::InspectSupport ; end
 
+  if const_defined?(:Vec2Array)
+    class Vec2Array ; include ::Snow::InspectSupport ; end
+  end
+
   if const_defined?(:Vec3Array)
     class Vec3Array ; include ::Snow::InspectSupport ; end
   end

data/lib/snow-math/marshal.rb

@@ -1,4 +1,5 @@
 require 'snow-math/bindings'
+require 'snow-math/to_a'
 
 module Snow ; end
 
@@ -46,12 +47,17 @@ module Snow::ArrayMarshalSupport # :nodoc: all
 end
 
 module Snow
+  class Vec2 ; include ::Snow::BaseMarshalSupport ; end
   class Vec3 ; include ::Snow::BaseMarshalSupport ; end
   class Vec4 ; include ::Snow::BaseMarshalSupport ; end
   class Quat ; include ::Snow::BaseMarshalSupport ; end
   class Mat3 ; include ::Snow::BaseMarshalSupport ; end
   class Mat4 ; include ::Snow::BaseMarshalSupport ; end
 
+  if const_defined?(:Vec2Array)
+    class Vec2Array ; include ::Snow::ArrayMarshalSupport ; end
+  end
+
   if const_defined?(:Vec3Array)
     class Vec3Array ; include ::Snow::ArrayMarshalSupport ; end
   end

data/lib/snow-math/mat3.rb

@@ -36,6 +36,10 @@ class Snow::Mat3
   alias_method :clone, :copy
 
 
+  def to_quat
+    Quat.new(self)
+  end
+
   #
   # Calls #transpose(self)
   #

data/lib/snow-math/mat4.rb

@@ -37,6 +37,10 @@ class Snow::Mat4
   alias_method :clone, :copy
 
 
+  def to_quat
+    Quat.new(self)
+  end
+
   # Calls #transpose(self)
   #
   # call-seq: transpose! -> self
@@ -136,7 +140,7 @@ class Snow::Mat4
   # call-seq: translate!(vec3) -> self
   # call-seq: translate!(x, y, z) -> self
   def translate!(*args)
-    translate *args, self
+    translate(*args, self)
   end
 
   # Calls #inverse_affine(self)

data/lib/snow-math/ptr.rb

@@ -2,7 +2,7 @@
 # Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
 # See COPYING for license details.
 
-require 'snow-math'
+require 'snow-math/bindings'
 require 'fiddle'
 
 module Snow
@@ -27,6 +27,10 @@ module Snow
     end
   end
 
+  class Vec2
+    include ::Snow::FiddlePointerSupport
+  end
+
   class Vec3
     include ::Snow::FiddlePointerSupport
   end
@@ -47,6 +51,12 @@ module Snow
     include ::Snow::FiddlePointerSupport
   end
 
+  if const_defined?(:Vec2Array)
+    class Vec2Array
+      include ::Snow::FiddlePointerSupport
+    end
+  end
+
   if const_defined?(:Vec3Array)
     class Vec3Array
       include ::Snow::FiddlePointerSupport

data/lib/snow-math/quat.rb

@@ -33,6 +33,30 @@ class Snow::Quat
   alias_method :clone, :copy
 
 
+  def to_vec2
+    Vec2.new(self)
+  end
+
+  def to_vec3
+    Vec3.new(self)
+  end
+
+  def to_vec4
+    Vec4.new(self)
+  end
+
+  def to_quat
+    Quat.new(self)
+  end
+
+  def to_mat3
+    Mat3.new(self)
+  end
+
+  def to_mat4
+    Mat4.new(self)
+  end
+
   # Returns the X component of the quaternion.
   #
   # call-seq: x -> float

data/lib/snow-math/swizzle.rb

@@ -2,7 +2,8 @@
 # Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
 # See COPYING for license details.
 
-require 'snow-math'
+require 'snow-math/bindings'
+require 'snow-math/to_a'
 
 module Snow ; end
 
@@ -80,20 +81,26 @@ module Snow
 
 end
 
+class Snow::Vec2
+  @@SWIZZLE_CHARS = /^[xy]{2,4}$/
+  @@SWIZZLE_MAPPING = { 2 => self, 3 => ::Snow::Vec3, 4 => ::Snow::Vec4, 'x' => 0, 'y' => 1 }
+  include ::Snow::SwizzleSupport
+end
+
 class Snow::Vec3
-  @@SWIZZLE_CHARS = /^[xyz]{3,4}$/
-  @@SWIZZLE_MAPPING = { 3 => self, 4 => ::Snow::Vec4, 'x' => 0, 'y' => 1, 'z' => 2 }
+  @@SWIZZLE_CHARS = /^[xyz]{2,4}$/
+  @@SWIZZLE_MAPPING = { 2 => ::Snow::Vec2, 3 => self, 4 => ::Snow::Vec4, 'x' => 0, 'y' => 1, 'z' => 2 }
   include ::Snow::SwizzleSupport
 end
 
 class Snow::Vec4
-  @@SWIZZLE_CHARS = /^[xyzw]{3,4}$/
-  @@SWIZZLE_MAPPING = { 3 => ::Snow::Vec3, 4 => self, 'x' => 0, 'y' => 1, 'z' => 2, 'w' => 3 }
+  @@SWIZZLE_CHARS = /^[xyzw]{2,4}$/
+  @@SWIZZLE_MAPPING = { 2 => ::Snow::Vec2, 3 => ::Snow::Vec3, 4 => self, 'x' => 0, 'y' => 1, 'z' => 2, 'w' => 3 }
   include ::Snow::SwizzleSupport
 end
 
 class Snow::Quat
-  @@SWIZZLE_CHARS = /^[xyzw]{3,4}$/
-  @@SWIZZLE_MAPPING = { 3 => ::Snow::Vec3, 4 => self, 'x' => 0, 'y' => 1, 'z' => 2, 'w' => 3 }
+  @@SWIZZLE_CHARS = /^[xyzw]{2,4}$/
+  @@SWIZZLE_MAPPING = { 2 => ::Snow::Vec2, 3 => ::Snow::Vec3, 4 => self, 'x' => 0, 'y' => 1, 'z' => 2, 'w' => 3 }
   include ::Snow::SwizzleSupport
 end

data/lib/snow-math/to_a.rb

@@ -2,7 +2,7 @@
 # Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
 # See COPYING for license details.
 
-require 'snow-math'
+require 'snow-math/bindings'
 
 module Snow
 
@@ -107,12 +107,30 @@ module Snow
 
   end
 
+  class Vec2 ; include ::Snow::ArraySupport ; end
   class Vec3 ; include ::Snow::ArraySupport ; end
   class Vec4 ; include ::Snow::ArraySupport ; end
   class Quat ; include ::Snow::ArraySupport ; end
   class Mat3 ; include ::Snow::ArraySupport ; end
   class Mat4 ; include ::Snow::ArraySupport ; end
 
+  if const_defined?(:Vec2Array)
+    class Vec2Array
+      include ::Snow::ArraySupport
+
+      #
+      # Duplicates the Vec2Array and returns it.
+      #
+      # call-seq: dup -> new vec3_array
+      #
+      def dup
+        self.class.new(self)
+      end
+
+      alias_method :clone, :dup
+    end
+  end
+
   if const_defined?(:Vec3Array)
     class Vec3Array
       include ::Snow::ArraySupport
@@ -125,6 +143,8 @@ module Snow
       def dup
         self.class.new(self)
       end
+
+      alias_method :clone, :dup
     end
   end
 
@@ -140,6 +160,8 @@ module Snow
       def dup
         self.class.new(self)
       end
+
+      alias_method :clone, :dup
     end
   end
 
@@ -155,6 +177,8 @@ module Snow
       def dup
         self.class.new(self)
       end
+
+      alias_method :clone, :dup
     end
   end
 
@@ -170,6 +194,8 @@ module Snow
       def dup
         self.class.new(self)
       end
+
+      alias_method :clone, :dup
     end
   end
 
@@ -185,6 +211,8 @@ module Snow
       def dup
         self.class.new(self)
       end
+
+      alias_method :clone, :dup
     end
   end
 

data/lib/snow-math/vec2.rb

@@ -0,0 +1,168 @@
+# This file is part of ruby-snowmath.
+# Copyright (c) 2013 Noel Raymond Cower. All rights reserved.
+# See COPYING for license details.
+
+require 'snow-math/bindings'
+
+module Snow ; end
+
+if Snow.const_defined?(:Vec2Array)
+  #
+  # A contiguous array of Vec2s. Allocated as a single block of memory so that
+  # it can easily be passed back to C libraries (like OpenGL) and to aid with
+  # cache locality.
+  #
+  # Useful also to represent texture coordinates and 2D positions and
+  # displacements.
+  #
+  class Snow::Vec2Array
+    class << self ; alias_method :[], :new ; end
+
+    alias_method :[], :fetch
+    alias_method :[]=, :store
+  end
+end
+
+#
+# A 2-component vector class.
+#
+class Snow::Vec2
+
+  class << self ; alias_method :[], :new ; end
+
+  alias_method :[], :fetch
+  alias_method :[]=, :store
+  alias_method :dup, :copy
+  alias_method :clone, :copy
+
+
+  def to_vec2
+    Vec2.new(self)
+  end
+
+  def to_vec3
+    Vec3.new(self)
+  end
+
+  def to_vec4
+    Vec4.new(self)
+  end
+
+  def to_quat
+    Quat.new(self)
+  end
+
+  # Returns the X component of the vector.
+  #
+  # call-seq: x -> float
+  def x
+    self[0]
+  end
+
+  # Sets the X component of the vector.
+  #
+  # call-seq: x = value -> value
+  def x=(value)
+    self[0] = value
+  end
+
+  # Returns the Y component of the vector.
+  #
+  # call-seq: y -> float
+  def y
+    self[1]
+  end
+
+  # Sets the Y component of the vector.
+  #
+  # call-seq: y = value -> value
+  def y=(value)
+    self[1] = value
+  end
+
+  # Calls #normalize(self)
+  #
+  # call-seq: normalize! -> self
+  def normalize!
+    normalize self
+  end
+
+  # Calls #inverse(self)
+  #
+  # call-seq: inverse! -> self
+  def inverse!
+    inverse self
+  end
+
+  # Calls #negate(self)
+  #
+  # call-seq: negate! -> self
+  def negate!
+    negate self
+  end
+
+  # Calls #multiply_vec2(rhs, self)
+  #
+  # call-seq: multiply_vec2!(rhs) -> self
+  def multiply_vec2!(rhs)
+    multiply_vec2 rhs, self
+  end
+
+  # Calls #multiply_vec2 and #scale, respectively.
+  #
+  # call-seq:
+  #     multiply(vec2, output = nil) -> output or new vec2
+  #     multiply(scalar, output = nil) -> output or new vec2
+  def multiply(rhs, output = nil)
+    case rhs
+    when ::Snow::Vec2, ::Snow::Vec3, ::Snow::Vec4, ::Snow::Quat then multiply_vec2(rhs, output)
+    when Numeric then scale(rhs, output)
+    else raise TypeError, "Invalid type for RHS"
+    end
+  end
+
+  # Calls #multiply(rhs, self)
+  #
+  # call-seq: multiply!(rhs) -> self
+  def multiply!(rhs)
+    multiply rhs, self
+  end
+
+  # Calls #add(rhs, self)
+  #
+  # call-seq: add!(rhs) -> self
+  def add!(rhs)
+    add rhs, self
+  end
+
+  # Calls #subtract(rhs, self)
+  #
+  # call-seq: subtract!(rhs) -> self
+  def subtract!(rhs)
+    subtract rhs, self
+  end
+
+  # Calls #scale(rhs, self)
+  #
+  # call-seq: scale!(rhs) -> self
+  def scale!(rhs)
+    scale rhs, self
+  end
+
+  # Calls #divide(rhs, self)
+  #
+  # call-seq: divide!(rhs) -> self
+  def divide!(rhs)
+    divide rhs, self
+  end
+
+
+  alias_method :-, :subtract
+  alias_method :+, :add
+  alias_method :*, :multiply
+  alias_method :/, :divide
+  alias_method :**, :dot_product
+  alias_method :-@, :negate
+  alias_method :~, :inverse
+
+end