perlin 0.1.0 → 0.1.1

data/Rakefile

@@ -45,11 +45,6 @@ task :browse_yard => :yard do
   Launchy.open "doc/index.html" rescue nil
 end
 
-desc "Create platform-specific compiled gem"
-task :native_gem do
-  Rake::Task["native"].invoke "gem"
-end
-
 desc "Run benchmarks"
 task :bench => :compile do
   require File.expand_path("../bench/benchmarks.rb", __FILE__)

data/lib/perlin.rb

@@ -0,0 +1,13 @@
+require 'perlin/version'
+
+begin
+  RUBY_VERSION =~ /(\d+.\d+)/
+  require "perlin/#{$1}/perlin.so"
+rescue LoadError
+  require "perlin/perlin.so"
+end
+
+require 'perlin/generator'
+
+module Perlin
+end

data/lib/perlin/generator.rb

@@ -0,0 +1,161 @@
+module Perlin
+  # Perlin noise generator.
+  #
+  # @!attribute [rw] seed
+  #   @return [Integer]
+  #
+  # @!attribute [r] persistence
+  #   @return [Float]
+  #
+  # @!attribute [r] octave
+  #   @return [Integer]
+  class Generator
+    attr_reader :seed, :octave, :persistence
+    def classic?; @classic; end
+
+    # @!method initialize(seed, persistence, octave)
+    #   Create a noise generator.
+    #
+    #   Using the same seed will always produce the same pattern. Animate a perlin 'texture' by altering the seed based on time.
+    #
+    #   @param seed [Integer] Seed value to create a different pattern.
+    #   @param persistence [Float] Used to generate different frequencies/amplitudes of output.
+    #   @param octave [Integer] Number of iterations to run (higher number of octaves takes more time)
+    #   @option options :classic [Boolean] (false) Whether to use the slower Classic algorithm, rather than default (and much faster) Simplex.
+    def initialize(seed, persistence, octave, options = {})
+      options = {
+          :classic => false,
+      }.merge! options
+
+      initialize_(seed, persistence, octave, options[:classic])
+    end
+    protected :initialize_ # Underlying C implementation.
+
+    # @overload chunk(x, y, steps_x, steps_y, interval)
+    #   Calculates a rectangular section of height (n) values and returns them as a 2D array.
+    #
+    #   This is much faster than accessing each point separately using {#[]}
+    #
+    #   @example
+    #     noise = Perlin::Generator.new 123, 1.0, 1
+    #     arr = noise.chunk 1, 1, 2, 3, 1.5
+    #
+    #     # access position 1, 2 (remember that arr is offset by the x, y value of the chunk)
+    #     puts arr[0, 1] #=> -0.2208995521068573
+    #
+    #     p arr  #= > [[0.05753844603896141, -0.2208995521068573, 0.3973901569843292], [0.1383310854434967, -0.22248442471027374, 0.15600799024105072]]
+    #
+    #   @param x [Float]
+    #   @param y [Float]
+    #   @param steps_x [Integer]
+    #   @param steps_y [Integer]
+    #   @param interval [Float]
+    #
+    #   @return [Array<Array<Float>>] height (n) values within the rectangle.
+    #
+    # @overload chunk(x, y, steps_x, steps_y, interval) {|h, x, y| }
+    #   Calculates a rectangular section of height (n) values and returns them as a 2D array.
+    #
+    #   This is much faster than accessing each point separately using {#[]}
+    #
+    #   @example
+    #     noise = Perlin::Generator.new 123, 0.5, 3
+    #     noise.chunk 1.0, 2.3, 3, 2, 1.5 do |h, x, y|
+    #       # Use the height value, which is at x, y.
+    #     end
+    #
+    #   @param x [Float]
+    #   @param y [Float]
+    #   @param steps_x [Integer]
+    #   @param steps_y [Integer]
+    #   @param interval [Float]
+    #
+    #   @yieldparam h [Float] Height at x, y
+    #   @yieldparam x [Float]
+    #   @yieldparam y [Float]
+    #
+    #   @return [nil]
+    #
+    # @overload chunk(x, y, z, size_x, size_y, size_z, interval)
+    #   Calculates a rectangular section of height (n) values and returns them as a 3D array.
+    #
+    #   This is much faster than accessing each point separately using {#[]}
+    #
+    #   @example
+    #     noise = Perlin::Generator.new 123, 0.5, 5
+    #     arr = noise.chunk 6.0, 5.0, 4.0, 3, 2, 1, 1.5
+    #
+    #     # access position 2, 1, 0 (remember that arr is offset by the x, y and z value of the chunk)
+    #     puts arr[2, 1, 0] #=>
+    #
+    #     p arr  #= >
+    #
+    #   @param x [Float]
+    #   @param y [Float]
+    #   @param z [Float]
+    #   @param steps_x [Integer]
+    #   @param steps_y [Integer]
+    #   @param steps_z [Integer]
+    #   @param interval [Float]
+    #
+    #   @return [Array<Array<Float>>] height (n) values within the rectangle.
+    #
+    # @overload chunk(x, y, z, size_x, size_y, size_z, interval) {|h, x, y| }
+    #   Calculates a rectangular section of height (n) values and returns them as a 3D array.
+    #
+    #   This is much faster than accessing each point separately using {#[]}
+    #
+    #   @example
+    #     noise = Perlin::Generator.new 123, 0.8, 3
+    #     noise.chunk 6.0, 5.0, 4.0, 3, 2, 1, 1.5 do |h, x, y, z|
+    #       # Use the height value, which is at x, y, z.
+    #     end
+    #
+    #   @param x [Float]
+    #   @param y [Float]
+    #   @param z [Float]
+    #   @param steps_x [Integer]
+    #   @param steps_y [Integer]
+    #   @param steps_z [Integer]
+    #   @param interval [Float]
+    #
+    #   @yieldparam h [Float] Height at x, y, z
+    #   @yieldparam x [Float]
+    #   @yieldparam y [Float]
+    #   @yieldparam z [Float]
+    #
+    #   @return [nil]
+
+    # Gets height (n) at a point in 2D or 3D space.
+    #
+    # This is much slower, if accessing many points, than using {#chunk}
+    #
+    # @overload [](x, y)
+    #   Gets height (n) value at a specific 2D position.
+    #
+    #   @example
+    #     noise = Perlin::Generator.new 123, 1.0, 1
+    #
+    #     # Returns a 'height' value for (x, y)
+    #     puts noise[10, 20]  #=> 0.9004574418067932
+    #
+    #   @param x [Float]
+    #   @param y [Float]
+    #   @return [Float] height (n) value at the position
+    #
+    # @overload [](x, y, z)
+    #   Gets height (n) value at a specific 3D position.
+    #
+    #   @example
+    #     noise = Perlin::Generator.new 123, 1.0, 1
+    #
+    #     # Returns a 'height' value for (x, y, z)
+    #     puts noise[10, 20, 30]  #=> 0.017745036631822586
+    #
+    #   @param x [Float]
+    #   @param y [Float]
+    #   @param z [Float]
+    #   @return [Float]  height (n) value at the position
+    alias_method :run, :[]
+  end
+end

data/lib/perlin/version.rb

@@ -0,0 +1,5 @@
+# Perlin noise generation.
+module Perlin
+  # Current version of the gem.
+  VERSION = "0.1.1"
+end

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require "rspec"
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "perlin"

data/spec/perlin/generator_spec.rb

@@ -0,0 +1,245 @@
+
+require File.expand_path("../../helper.rb", __FILE__)
+
+describe Perlin::Generator do
+  before :each do
+    @classic = Perlin::Generator.new 123, 1.5, 2, :classic => true
+    @simplex = Perlin::Generator.new 0, 1.5, 2
+    @accuracy = 0.00001
+  end
+
+  it "should have seed set correctly" do
+    @classic.seed.should eq 123
+    @classic.seed.should be_kind_of Integer
+  end
+
+  it "should have seed set uniquely on all generators" do
+    # This was a bug in the original code!
+    g = Perlin::Generator.new 99, 1, 1
+    g.seed.should eq 99
+    g.seed.should be_kind_of Integer
+
+    @classic.seed.should eq 123
+    g[0, 0].should_not eq @classic[0, 0]
+  end
+
+  it "should have persistence set correctly" do
+    @classic.persistence.should be_within(@accuracy).of 1.5
+  end
+
+  it "should have octave set correctly" do
+    @classic.octave.should eq 2
+    @classic.octave.should be_kind_of Integer
+  end
+
+  describe "SIMPLEX" do
+    it "should have classic? set correctly" do
+      @simplex.classic?.should be_false
+    end
+  end
+
+  describe "CLASSIC" do
+    it "should have classic? set correctly" do
+      @classic.classic?.should be_true
+    end
+  end
+
+  describe "seed=" do
+    it "should set seed correctly" do
+      @classic.seed = 12
+      @classic.seed.should eq 12
+      @classic.seed.should be_kind_of Integer
+    end
+  end
+
+  describe "persistence=" do
+    it "should set persistence correctly" do
+      @classic.persistence = 12
+      @classic.persistence.should eq 12
+      @classic.persistence.should be_kind_of Float
+    end
+  end
+
+  describe "octave=" do
+    it "should set octave correctly" do
+      @classic.octave = 12
+      @classic.octave.should eq 12
+      @classic.octave.should be_kind_of Integer
+    end
+  end
+
+  describe "classic=" do
+    it "should set classic? correctly" do
+      @simplex.classic = true
+      @simplex.classic?.should be_true
+    end
+  end
+
+  describe "[]" do
+    it "[x, y] should support float values" do
+      @simplex[0, 0].should_not be_within(@accuracy).of @simplex[0.2, 0.2]
+    end
+
+
+
+    it "[x, y, z] should support float values" do
+      @simplex[0, 0, 0].should_not be_within(@accuracy).of @simplex[0.2, 0.2, 0.2]
+    end
+
+    it "should fail if given too few arguments" do
+      lambda { @classic[0] }.should raise_error ArgumentError
+    end
+
+    it "should fail if given too many arguments" do
+      lambda { @classic[0, 0, 0, 0] }.should raise_error ArgumentError
+    end
+
+    describe "SIMPLEX" do
+      describe "[](x, y)" do
+        it "should return the appropriate value" do
+          @simplex[0, 1].should be_within(@accuracy).of 0.7600996515471077
+        end
+
+        it "should return different values based on seed" do
+          initial = @simplex[9, 5]
+          @simplex.seed = 95
+          initial.should_not be_within(@accuracy).of @simplex[9, 5]
+        end
+      end
+
+      describe "[](x, y, z)" do
+        it "should return the appropriate value" do
+          @simplex[0, 1, 2].should be_within(@accuracy).of -0.4994023090387083
+        end
+      end
+    end
+
+    describe "CLASSIC" do
+      describe "[](x, y)" do
+        it "should return the appropriate value" do
+          @classic[0, 0].should be_within(@accuracy).of -1.0405873507261276
+        end
+
+        it "should return different values based on seed" do
+          initial = @classic[9, 5]
+          @classic.seed = 95
+          initial.should_not be_within(@accuracy).of @classic[9, 5]
+        end
+      end
+
+      describe "[](x, y, z)" do
+        it "should return the appropriate value" do
+          @classic[0, 0, 0].should be_within(@accuracy).of -1.5681833028793335
+        end
+      end
+    end
+  end
+
+  describe "chunk" do
+    describe "chunk 2D" do
+
+      describe "SIMPLEX" do
+        it "should return the appropriate values" do
+          chunk = @simplex.chunk 1, 2, 3, 4, 1
+          chunk.should eq [[0.0, 0.19517135798668975, 0.19616149193873283, -5.932618130464163e-07], [0.10886869609093779, 0.10787834101090553, -5.932618130464163e-07, -0.19616171787047829], [-0.0431512326002121, 0.0, 0.260888409614563, 0.45605969740428703]]
+        end
+
+        it "should give the same results, regardless of x/y offset" do
+          chunk1 = @simplex.chunk 0, 0, 3, 3, 0.1
+          chunk2 = @simplex.chunk 0.1, 0.1, 3, 3, 0.1
+
+          chunk2[0][0].should eq chunk1[1][1]
+          chunk2[0][1].should eq chunk1[1][2]
+          chunk2[1][0].should eq chunk1[2][1]
+          chunk2[1][1].should eq chunk1[2][2]
+        end
+
+        it "should work with a block" do
+          arr = []
+          @simplex.chunk 1, 2, 3, 4, 1 do |h, x, y|
+            arr << [h, x, y]
+          end
+          arr.should eq [[0.0, 1.0, 2.0], [0.19517135798668975, 1.0, 3.0], [0.19616149193873283, 1.0, 4.0], [-5.932618130464163e-07, 1.0, 5.0], [0.10886869609093779, 2.0, 2.0], [0.10787834101090553, 2.0, 3.0], [-5.932618130464163e-07, 2.0, 4.0], [-0.19616171787047829, 2.0, 5.0], [-0.0431512326002121, 3.0, 2.0], [0.0, 3.0, 3.0], [0.260888409614563, 3.0, 4.0], [0.45605969740428703, 3.0, 5.0]]
+        end
+      end
+
+      describe "CLASSIC" do
+        it "should return the appropriate values" do
+          chunk = @classic.chunk 1, 2, 3, 4, 1
+          chunk.should eq [[-2.014809340238571, -0.7094215080142021, -0.5946878045797348, 0.4915006756782532], [-1.4068767204880714, -0.732808068394661, 0.07362580299377441, -0.325466126203537], [-0.857817449606955, -1.940980076789856, -0.5687579363584518, 1.4209578335285187]]
+        end
+
+        it "should give the same results, regardless of x/y offset" do
+          chunk1 = @classic.chunk 0, 0, 3, 3, 0.1
+          chunk2 = @classic.chunk 0.1, 0.1, 3, 3, 0.1
+          chunk2[0][0].should eq chunk1[1][1]
+          chunk2[0][1].should eq chunk1[1][2]
+          chunk2[1][0].should eq chunk1[2][1]
+          chunk2[1][1].should eq chunk1[2][2]
+        end
+
+        it "should work with a block" do
+          arr = []
+          @classic.chunk 1, 2, 3, 4, 1 do |h, x, y|
+            arr << [h, x, y]
+          end
+          arr.should eq [[-2.014809340238571, 1.0, 2.0], [-0.7094215080142021, 1.0, 3.0], [-0.5946878045797348, 1.0, 4.0], [0.4915006756782532, 1.0, 5.0], [-1.4068767204880714, 2.0, 2.0], [-0.732808068394661, 2.0, 3.0], [0.07362580299377441, 2.0, 4.0], [-0.325466126203537, 2.0, 5.0], [-0.857817449606955, 3.0, 2.0], [-1.940980076789856, 3.0, 3.0], [-0.5687579363584518, 3.0, 4.0], [1.4209578335285187, 3.0, 5.0]]
+        end
+      end
+
+      it "should fail if given negative size_x" do
+        lambda { @classic.chunk 0, 0, -1, 0 }.should raise_error ArgumentError
+      end
+
+      it "should fail if given negative size_y" do
+        lambda { @classic.chunk 0, 0, 0, -1 }.should raise_error ArgumentError
+      end
+
+    end
+
+    describe "chunk 3D" do
+      describe "SIMPLEX" do
+        it "should return the appropriate values" do
+          chunk = @simplex.chunk 6, 5, 4, 3, 2, 1, 1
+          chunk.should eq [[[-0.0506731136544405], [0.13219586780905937]], [[0.32796947870374366], [0.5241572306428496]], [[-0.10557871005195935], [-0.10961889028549195]]]
+        end
+
+        it "should work with a block" do
+          arr = []
+          @simplex.chunk 6, 5, 4, 3, 2, 1, 1 do |h, x, y, z|
+            arr << [h, x, y, z]
+          end
+          arr.should eq [[-0.0506731136544405, 6.0, 5.0, 4.0], [0.13219586780905937, 6.0, 6.0, 4.0], [0.32796947870374366, 7.0, 5.0, 4.0], [0.5241572306428496, 7.0, 6.0, 4.0], [-0.10557871005195935, 8.0, 5.0, 4.0], [-0.10961889028549195, 8.0, 6.0, 4.0]]
+        end
+      end
+
+      describe "CLASSIC" do
+        it "should return the appropriate values" do
+          chunk = @classic.chunk 6, 5, 4, 3, 2, 1, 1
+          chunk.should eq [[[0.7522532045841217], [0.3314518630504608]], [[0.3198353797197342], [0.967293307185173]], [[1.1024393141269684], [0.5659154206514359]]]
+        end
+
+        it "should work with a block" do
+          arr = []
+          @classic.chunk 6, 5, 4, 3, 2, 1, 1 do |h, x, y, z|
+            arr << [h, x, y, z]
+          end
+          arr.should eq [[0.7522532045841217, 6.0, 5.0, 4.0], [0.3314518630504608, 6.0, 6.0, 4.0], [0.3198353797197342, 7.0, 5.0, 4.0], [0.967293307185173, 7.0, 6.0, 4.0], [1.1024393141269684, 8.0, 5.0, 4.0], [0.5659154206514359, 8.0, 6.0, 4.0]]
+        end
+      end
+
+      it "should fail if given negative size_x" do
+        lambda { @classic.chunk 0, 0, 0, -1, 0, 0 }.should raise_error ArgumentError
+      end
+
+      it "should fail if given negative size_y" do
+        lambda { @classic.chunk 0, 0, 0, 0, -1, 0 }.should raise_error ArgumentError
+      end
+
+      it "should fail if given negative size_z" do
+        lambda { @classic.chunk 0, 0, 0, 0, 0, -1 }.should raise_error ArgumentError
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perlin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -129,6 +129,9 @@ files:
 - LICENSE
 - Rakefile
 - README.md
+- lib/perlin/generator.rb
+- lib/perlin/version.rb
+- lib/perlin.rb
 - ext/perlin/classic.c
 - ext/perlin/generator.c
 - ext/perlin/perlin.c
@@ -144,6 +147,8 @@ files:
 - examples/index_in_3d.rb
 - examples/ogl/README.md
 - examples/ogl/run.rb
+- spec/helper.rb
+- spec/perlin/generator_spec.rb
 homepage: https://github.com/boj/ruby-perlin
 licenses:
 - MIT
@@ -157,22 +162,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 176652013
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 176652013
 requirements: []
 rubyforge_project: ruby-perlin
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Perlin Noise C extension
-test_files: []
+test_files:
+- spec/helper.rb
+- spec/perlin/generator_spec.rb