snow-math 1.2.4 → 1.3.0pre0

data/lib/snow-math/vec3.rb

@@ -7,6 +7,13 @@ require 'snow-math/bindings'
 module Snow ; end
 
 if Snow.const_defined?(:Vec3Array)
+  #
+  # A contiguous array of Vec3s. 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 for storing vertex data such as positions, normals, and so on.
+  #
   class Snow::Vec3Array
     class << self ; alias_method :[], :new ; end
 
@@ -15,6 +22,9 @@ if Snow.const_defined?(:Vec3Array)
   end
 end
 
+#
+# A 3-component vector class.
+#
 class Snow::Vec3
 
   # Shortcut through to new
@@ -22,55 +32,92 @@ class Snow::Vec3
 
   alias_method :[], :fetch
   alias_method :[]=, :store
+  alias_method :dup, :copy
+  alias_method :clone, :copy
 
+
+  # 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
 
+  # Returns the Z component of the vector.
+  #
+  # call-seq: z -> float
   def z
     self[2]
   end
 
+  # Sets the Z component of the vector.
+  #
+  # call-seq: z = value -> value
   def z=(value)
     self[2] = value
   end
 
-  def dup
-    self.class.new(self)
-  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 #cross_product(rhs, self)
+  #
+  # call-seq: cross_product!(rhs) -> self
   def cross_product!(rhs)
     cross_product rhs, self
   end
 
+  # Calls #multiply_vec3(rhs, self)
+  #
+  # call-seq: multiply_vec3!(rhs) -> self
   def multiply_vec3!(rhs)
     multiply_vec3 rhs, self
   end
 
+  # Calls #multiply_vec3 and #scale, respectively.
+  #
+  # call-seq:
+  #     multiply(vec3, output) -> output or new vec3
+  #     multiply(scalar, output) -> output or new vec3
   def multiply(rhs, output = nil)
     case rhs
     when ::Snow::Vec3 then multiply_vec3(rhs, output)
@@ -79,26 +126,42 @@ class Snow::Vec3
     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 :^, :cross_product

data/lib/snow-math/vec4.rb

@@ -7,6 +7,13 @@ require 'snow-math/bindings'
 module Snow ; end
 
 if Snow.const_defined?(:Vec4Array)
+  #
+  # A contiguous array of Vec4s. 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 color buffers, vertices, and other miscellanea.
+  #
   class Snow::Vec4Array
     class << self ; alias_method :[], :new ; end
 
@@ -15,65 +22,108 @@ if Snow.const_defined?(:Vec4Array)
   end
 end
 
+#
+# A 4-component vector class.
+#
 class Snow::Vec4
 
   class << self ; alias_method :[], :new ; end
 
   alias_method :[], :fetch
   alias_method :[]=, :store
+  alias_method :dup, :copy
+  alias_method :clone, :copy
 
+
+  # 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
 
+  # Returns the Z component of the vector.
+  #
+  # call-seq: z -> float
   def z
     self[2]
   end
 
+  # Sets the Z component of the vector.
+  #
+  # call-seq: z = value -> value
   def z=(value)
     self[2] = value
   end
 
+  # Returns the W component of the vector.
+  #
+  # call-seq: w -> float
   def w
     self[3]
   end
 
+  # Sets the W component of the vector.
+  #
+  # call-seq: w = value -> value
   def w=(value)
     self[3] = value
   end
 
-  def dup
-    self.class.new(self)
-  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_vec4(rhs, self)
+  #
+  # call-seq: multiply_vec4!(rhs) -> self
   def multiply_vec4!(rhs)
     multiply_vec4 rhs, self
   end
 
+  # Calls #multiply_vec4 and #scale, respectively.
+  #
+  # call-seq:
+  #     multiply(vec4, output = nil) -> output or new vec4
+  #     multiply(scalar, output = nil) -> output or new vec4
   def multiply(rhs, output = nil)
     case rhs
     when ::Snow::Vec4 then multiply_vec4(rhs, output)
@@ -82,26 +132,42 @@ class Snow::Vec4
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snow-math
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0pre0
 platform: ruby
 authors:
 - Noel Raymond Cower
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-07 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies: []
 description: Math types built on the SnowPalm math code
 email: ncower@gmail.com
@@ -16,11 +16,12 @@ executables: []
 extensions:
 - ext/extconf.rb
 extra_rdoc_files:
+- ext/snow-math/snow-math.c
 - README.md
 - COPYING
 files:
-- lib/snow-math/array_cache.rb
 - lib/snow-math/inspect.rb
+- lib/snow-math/marshal.rb
 - lib/snow-math/mat3.rb
 - lib/snow-math/mat4.rb
 - lib/snow-math/ptr.rb
@@ -51,6 +52,7 @@ rdoc_options:
 - snowmath -- 3D Math Types
 - --main
 - README.md
+- --markup=markdown
 - --line-numbers
 require_paths:
 - lib
@@ -61,9 +63,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3

data/lib/snow-math/array_cache.rb

@@ -1,42 +0,0 @@
-require 'snow-math/bindings'
-
-module Snow
-
-  [:Vec3Array, :Vec4Array, :QuatArray, :Mat4Array].each {
-    |klass_sym|
-    if const_defined?(klass_sym)
-      const_get(klass_sym).class_exec {
-        alias_method :__fetch__, :fetch
-        alias_method :__resize__!, :resize!
-        alias_method :__array_cache_initialize__, :initialize
-
-        def initialize(*args)
-          @__cache__ = []
-          __array_cache_initialize__(*args)
-        end
-
-        def fetch(index)
-          @__cache__[index] || (@__cache__[index] = __fetch__(index))
-        end
-
-        alias_method :[], :fetch
-
-        def resize!(new_length)
-          @__cache__ = []
-          __resize__!(new_length)
-        end
-
-        def resize(new_length)
-          arr = self.class.new(new_length)
-          self_length = self.length
-          (0 ... (self_length < new_length ? self_length : new_length)).each {
-            |index|
-            arr.store(index, self.fetch(index))
-          }
-          return arr
-        end
-      }
-    end
-  }
-
-end