perlin_noise 0.1.0 → 0.1.2

data/README.markdown

@@ -1,4 +1,4 @@
-# perlin
+# perlin_noise
 Ruby-implementation of N-dimension Perlin noise.
 
 ## Installation
@@ -37,7 +37,7 @@ n5d[rand, rand, rand, rand, rand]
 ```
 
 ## Options
-### :interval
+### `:interval`
 A gradient noise repeats itself at certain interval. (Default interval is 256)
 You can change the interval of the noise generator but keep in mind that
 longer interval requires more pseudo-random gradient vectors to be maintained in memory.
@@ -48,6 +48,15 @@ n3d[0.1, 0.2, 0.3]
 n3d[0.1, 0.2, 100.3]
 ```
 
+### `:seed`
+
+You can optionally specify a seed value for the random number generator.
+(Caveat: seed value is set globally in Ruby 1.8)
+
+```ruby
+noises = Perlin::Noise.new 1, :seed => 12345
+```
+
 ## Range of noise function
 While the original algorithm outputs a number between -1.0 and 1.0, 
 Perlin::Noise#[] manipulates this output and returns a number between 0.0 and 1.0 for ease of use.
@@ -58,7 +67,8 @@ Even though the range of the noise function is from 0 to 1,
 you'll rarely see a noise value close to either end, 
 as most of the values are distributed around the center.
 You might want to apply S-shaped curve functions defined in Perlin::Curve module 
-one or more times to push away those numbers to either end.
+one or more times to push away those "grey" values to either end, 
+achiving more contrasted output.
 
 ```ruby
 noise = Perlin::Noise.new 1
@@ -70,7 +80,8 @@ n = noise[0.1]
 end
 ```
 
-There's a shortcut for this process.
+There's a shortcut for this specific process.
+
 ```ruby
 contrast = Perlin::Curve.contrast(Perlin::Curve::CUBIC, 3)
 n = contrast.call n
@@ -83,9 +94,7 @@ n = contrast.call n
 ```ruby
 noise = Perlin::Noise.new 1, :interval => 200
 0.step(300, 0.1).each do |x|
-  n = noise[x]
-  len = (n * 60).to_i
-  puts '#' * len
+  puts '#' * (noise[x] * 60).floor
 end
 ```
 
@@ -237,7 +246,7 @@ bar = lambda { |n|
   bars[ (bars.length * n).floor ]
 }
 
-0.upto(100) do |i|
+100.times do |i|
   70.times do |y|
     n = noises[i * 0.1, y * 0.1]
     n = contrast.call n
@@ -359,7 +368,7 @@ Noise looks much more interesting when combined.
 noises = Perlin::Noise.new(2)
 contrast = Perlin::Curve.contrast(Perlin::Curve::QUINTIC, 3)
 
-(0..100).each do |x|
+100.times do |x|
   n = 0
   [[0.02, 10], [0.04, 10], [0.1, 20], [0.2, 15]].each_with_index do |step_scale, idx|
     step, scale = step_scale
@@ -474,6 +483,10 @@ end
 ```
 
 
+## Contributors
+
+- [Matthew Johnston](https://github.com/warmwaffles)
+
 ## References
 - Texturing & modeling: a procedural approach by David S. Ebert et al.
 - Improving Noise by Ken Perlin (http://mrl.nyu.edu/~perlin/paper445.pdf)

data/lib/perlin/gradient_table.rb

@@ -1,12 +1,28 @@
 module Perlin
+  if RUBY_VERSION =~ /^1\.8\./
+    class Random
+      def initialize *seed
+        # FIXME: Sets the global seed value; this is misleading
+        srand *seed
+      end
+
+      def rand *interval
+        Kernel.rand *interval
+      end
+    end
+  else
+    Random = ::Random
+  end
+
   class GradientTable
     # Bit-wise AND operation is not any faster than MOD in Ruby
     # MOD operation returns positive number for negative input
-    def initialize dim, interval = 256
+    def initialize dim, interval = 256, seed = nil
       @dim = dim
       @interval = interval
+      @random = Random.new(*[seed].compact)
 
-      @table   = Array.new(interval) { rand @interval }
+      @table   = Array.new(interval) { @random.rand @interval }
       @vectors = Array.new(interval) { random_unit_vector }
     end
 
@@ -30,7 +46,7 @@ module Perlin
 
     def random_unit_vector
       while true
-        v = Vector[*Array.new(@dim) { rand * 2 - 1 }]
+        v = Vector[*Array.new(@dim) { @random.rand * 2 - 1 }]
         # Discards vectors whose length greater than 1 to avoid bias in distribution
         break if v.r > 0 && v.r <= 1
       end

data/lib/perlin/noise.rb

@@ -3,7 +3,7 @@ module Perlin
     DEFAULT_OPTIONS = {
       :interval => 256,
       :curve => Perlin::Curve::QUINTIC,
-      :contrast => proc { }
+      :seed => nil
     }
 
     def initialize dim, options = {}
@@ -12,13 +12,15 @@ module Perlin
       @dim = dim
       @interval = options.fetch(:interval)
       @curve = options.fetch(:curve)
+      @seed = options.fetch(:seed)
 
       raise ArgumentError.new("Invalid dimension: must be a positive integer")  unless @dim.is_a?(Fixnum) && @dim > 0
       raise ArgumentError.new("Invalid interval: must be a positive integer")   unless @interval.is_a?(Fixnum) && @interval > 0
       raise ArgumentError.new("Invalid curve specified: must be a Proc object") unless @curve.is_a?(Proc)
+      raise ArgumentError.new("Invalid seed: must be a number")                 unless @seed.nil? || @seed.is_a?(Numeric)
 
       # Generate pseudo-random gradient vector for each grid point
-      @gradient_table = Perlin::GradientTable.new @dim, @interval
+      @gradient_table = Perlin::GradientTable.new @dim, @interval, @seed
     end
 
     # @param [*coords] Coordinates
@@ -30,7 +32,7 @@ module Perlin
       cell = Vector[*coords.map(&:to_i)]
       diff = coords - cell
 
-  		# Calculate noise factor at each surrouning vertex
+      # Calculate noise factor at each surrouning vertex
       nf = {}
       iterate @dim, 2 do |idx|
         idx = Vector[*idx]
@@ -39,7 +41,7 @@ module Perlin
         # product (dot product) between the gradient vectors of each grid point
         # and the vectors from the grid points."
         gv = @gradient_table[ * (cell + idx).to_a ]
-			  nf[idx.to_a] = gv.inner_product(diff - idx) 
+        nf[idx.to_a] = gv.inner_product(diff - idx)
       end
 
       dim = @dim

data/lib/perlin/version.rb

@@ -1,3 +1,3 @@
 module Perlin
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/test/test_perlin.rb

@@ -79,6 +79,12 @@ class PerlinTest < Test::Unit::TestCase
     assert_raise(ArgumentError) { Perlin::Noise.new 1, :interval => 0.5 }
     assert_raise(ArgumentError) { Perlin::Noise.new 1, :interval => -1 }
 
+    # Seed
+    Perlin::Noise.new 1, :seed => 1
+    Perlin::Noise.new 1, :seed => 0.1
+    Perlin::Noise.new 1, :seed => -0.1
+    assert_raise(ArgumentError) { Perlin::Noise.new 1, :seed => "seed" }
+
     # Curve
     Perlin::Noise.new 2, :curve => Perlin::Curve::CUBIC
     assert_raise(ArgumentError) { Perlin::Noise.new 2, :curve => nil }
@@ -128,7 +134,7 @@ class PerlinTest < Test::Unit::TestCase
       bars[ (bars.length * n).floor ]
     }
 
-    0.upto(100) do |i|
+    100.times do |i|
       70.times do |y|
         n = noises[i * 0.1, y * 0.1]
         n = contrast.call n
@@ -139,11 +145,22 @@ class PerlinTest < Test::Unit::TestCase
     end
   end
 
+  def test_seed
+    noise1 = Perlin::Noise.new(1, :seed => 12345)
+    noise2 = Perlin::Noise.new(1, :seed => 12345)
+    assert_equal 0.step(1, 0.01).map { |v| noise1[v] },
+        0.step(1, 0.01).map { |v| noise2[v] }
+
+    noise3 = Perlin::Noise.new(1, :seed => 54321)
+    assert_not_equal 0.step(1, 0.01).map { |v| noise1[v] },
+        0.step(1, 0.01).map { |v| noise3[v] }
+  end
+
   def test_synthesis
-    noises = Perlin::Noise.new(2)
+    noises = Perlin::Noise.new(2, :seed => 0.12345)
     contrast = Perlin::Curve.contrast(Perlin::Curve::QUINTIC, 3)
 
-    (0..100).each do |x|
+    100.times do |x|
       n = 0
       [[0.02, 10], [0.04, 10], [0.1, 30], [0.2, 15]].each_with_index do |step_scale, idx|
         step, scale = step_scale

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perlin_noise
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000 Z
+date: 2012-07-22 00:00:00.000000000 Z
 dependencies: []
 description: Perlin noise implemented in Ruby
 email:
@@ -49,10 +49,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: perlin
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Perlin noise generator
 test_files:
 - test/test_perlin.rb
-has_rdoc: