perlin 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1,4 +1,13 @@
-0.1.0
+0.2.0
+-----
+
+* Optimised C code to avoid use of slow Ruby ivars (up to 50% time reduction!).
+* Added Perlin::Generator#simplex?
+* Added checks for valid values given for Perlin::Generator#octave= and Perlin::Generator#seed= (both must >= 1).
+* Added visualization example/tool using Gosu (which is usable in Ruby 1.8 and 1.9, unlike the old FXRuby/OpenGL example).
+* FIXED: artifacts introduced into Simplex noise as seed value increases.
+
+0.1.1
 -----
 
 * Converted to gem (previously was just a .c file).

data/examples/gosu.rb

@@ -0,0 +1,101 @@
+require 'rubygems'
+require 'texplay'
+require 'fidgit'
+require 'perlin'
+
+include Gosu
+
+class Visualizer < Chingu::Window
+  def initialize
+    super 800, 600, false, 0.1
+    self.caption = "Perlin Visualizer"
+    enable_undocumented_retrofication
+    push_game_state Visualize
+  end
+end
+
+class Visualize < Fidgit::GuiState
+  SLIDER_WIDTH = 180
+  IMAGE_WIDTH = 74
+  IMAGE_SCALE = 8
+
+  def initialize
+    super
+
+    @image = TexPlay.create_image $window, IMAGE_WIDTH, IMAGE_WIDTH, :color => :red
+    @noise = Perlin::Generator.new 1, 0, 1
+
+    horizontal do
+      image_frame @image, :factor => IMAGE_SCALE
+
+      vertical do
+        vertical do
+          @seed_label = label ""
+          @seed_slider = slider :range => 1..10000, :width => SLIDER_WIDTH, :tip => "Perlin::Generator#seed" do |_, value|
+            @seed_label.text = "Seed = #{value}"
+            @noise.seed = value
+            update_image
+          end
+        end
+
+        vertical do
+          @persistence_label = label ""
+          @persistence_slider = slider :range => 0.0..1.0, :width => SLIDER_WIDTH, :tip => "Perlin::Generator#persistence" do |_, value|
+            @persistence_label.text = "Persist = #{"%.2f" % value}"
+            @noise.persistence = value
+            update_image
+          end
+        end
+
+        vertical do
+          @octave_label = label ""
+          @octave_slider = slider :range => 1..10, :width => SLIDER_WIDTH, :tip => "Perlin::Generator#octave" do |_, value|
+            @octave_label.text = "Octave = #{value}"
+            @noise.octave = value
+            update_image
+          end
+        end
+
+        vertical :padding_top => 32 do
+          @classic_button = toggle_button "Classic noise?" do |_, value|
+            @noise.classic = value
+            update_image
+          end
+        end
+
+        vertical :padding_top => 64 do
+          @step_label = label ""
+          @step_slider = slider :range => 0.01..1.0, :width => SLIDER_WIDTH, value: 0.1, :tip => "Step between points (pixels) in chunk" do |_, value|
+            @step_label.text = "Step = #{"%.2f" % value}"
+            @width_label.text = "Width = #{"%.2f" % (value * IMAGE_WIDTH)}"
+            update_image
+          end
+
+          @width_label = label "", :tip => "Width of visualized area in window"
+        end
+
+        # Initial values, so we get the correct details.
+        @seed_slider.value = 0
+        @persistence_slider.value = 0
+        @octave_slider.value = 0
+        @step_slider.value = 0.1
+      end
+    end
+
+    update_image
+  end
+
+  def update_image
+    step = @step_slider.value
+    width = @image.width
+
+    @noise.chunk 0, 0, width, width, step do |n, x, y|
+      intensity = (n + 1) * 0.5
+      @image.set_pixel x.fdiv(step).round, y.fdiv(step).round, :color => [intensity, intensity, intensity], :sync_mode => :no_sync
+    end
+
+    @image.force_sync [0, 0, width, width]
+  end
+end
+
+Visualizer.new.show

data/examples/ogl/run.rb

@@ -1,6 +1,17 @@
-require 'perlin'
+# WARNING:
+#   This code WILL NOT work with Ruby 1.9, since FXRuby/OpenGL are not compatible with the newer Ruby version.
+#   Since gem/bundler can't be persuaded to only require gems based on Ruby version, you'll have to manage the gems
+#   yourself.
+#
+#   Requiring 'fox16' actually uses the 'fxruby' gem, which is no longer supported.
+#
+#   Requiring 'opengl' actually uses the 'ruby-opengl' gem, not the 'opengl' gem (they are only compatible with Ruby 1.8
+#   and Ruby 1.9, respectively).
+
 require 'rubygems'
+require 'perlin'
 require 'fox16'
+require 'opengl'
 
 # Base framework borrowed from: http://www.fxruby.org/examples/gltest.rb
 

data/ext/perlin/classic.c

@@ -2,24 +2,7 @@
 
 long seed = 0; // Speeds up lookup of this value when it is accessed a LOT. PROBABLY NOT THREAD SAFE!
 
-static inline float perlin_interpolate(const float a, const float b, const float x)
-{
-    const float ft = x * M_PI;
-    const float f = (1 - cos(ft)) * 0.5;
-    return    a * (1 - f) + b * f;
-}
-
-
-// 2D ------------------------------------------------------------------
-
-static inline float perlin_noise_2d(const int x, const int y)
-{
-    long n = x + y * 57;
-    n = (n << 13) ^ n;
-    return (1.0 - ((n * (n * n * 15731*seed + 789221*seed) + 1376312589*seed) & 0x7fffffff) / 1073741824.0);
-}
-
-static float perlin_smooth_noise_2d(const int x, const int y)
+float perlin_smooth_noise_2d(const int x, const int y)
 {
     const float corners = (
         perlin_noise_2d(x - 1, y - 1) +
@@ -74,14 +57,7 @@ float perlin_octaves_2d(const float x, const float y, const float p, const float
 
 // 3D ------------------------------------------------------------------
 
-static inline float perlin_noise_3d(const int x, const int y, const int z)
-{
-    long n = x + y + z * 57;
-    n = (n << 13) ^ n;
-    return (1.0 - ((n * (n * n * 15731*seed + 789221*seed) + 1376312589*seed) & 0x7fffffff) / 1073741824.0);
-}
-
-static float perlin_smooth_noise_3d(const int x, const int y, const int z)
+float perlin_smooth_noise_3d(const int x, const int y, const int z)
 {
     const float corners = (
         perlin_noise_3d(x - 1, y - 1, z + 1) +

data/ext/perlin/classic.h

@@ -9,15 +9,32 @@
 
 extern long seed;
 
-static inline float perlin_interpolate(const float a, const float b, const float x);
+inline float perlin_interpolate(const float a, const float b, const float x)
+{
+    const float ft = x * M_PI;
+    const float f = (1 - cos(ft)) * 0.5;
+    return    a * (1 - f) + b * f;
+}
 
-static inline float perlin_noise_2d(const int x, const int y);
-static float perlin_smooth_noise_2d(const int x, const int y);
+inline float perlin_noise_2d(const int x, const int y)
+{
+    long n = x + y * 57;
+    n = (n << 13) ^ n;
+    return (1.0 - ((n * (n * n * 15731*seed + 789221*seed) + 1376312589*seed) & 0x7fffffff) / 1073741824.0);
+}
+
+inline float perlin_noise_3d(const int x, const int y, const int z)
+{
+    long n = x + y + z * 57;
+    n = (n << 13) ^ n;
+    return (1.0 - ((n * (n * n * 15731*seed + 789221*seed) + 1376312589*seed) & 0x7fffffff) / 1073741824.0);
+}
+
+float perlin_smooth_noise_2d(const int x, const int y);
 float perlin_interpolated_noise_2d(const float x, const float y);
 float perlin_octaves_2d(const float x, const float y, const float p, const float n);
 
-static inline float perlin_noise_3d(const int x, const int y, const int z);
-static float perlin_smooth_noise_3d(const int x, const int y, const int z);
+float perlin_smooth_noise_3d(const int x, const int y, const int z);
 float perlin_interpolated_noise_3d(const float x, const float y, const float z);
 float perlin_octaves_3d(const float x, const float y, const float z, const float p, const float n);
 

data/ext/perlin/generator.c

@@ -1,23 +1,106 @@
 #include "generator.h"
 
+void Init_Perlin_Generator(VALUE module)
+{
+    VALUE rb_cPerlinGenerator = rb_define_class_under(module, "Generator", rb_cObject);
+    rb_define_alloc_func(rb_cPerlinGenerator, Perlin_Generator_allocate);
+
+    rb_define_method(rb_cPerlinGenerator, "initialize", Perlin_Generator_init, -1);
+
+    rb_define_method(rb_cPerlinGenerator, "seed", Perlin_Generator_get_seed, 0);
+    rb_define_method(rb_cPerlinGenerator, "persistence", Perlin_Generator_get_persistence, 0);
+    rb_define_method(rb_cPerlinGenerator, "octave", Perlin_Generator_get_octave, 0);
+    rb_define_method(rb_cPerlinGenerator, "classic?", Perlin_Generator_get_classic, 0);
+
+    rb_define_method(rb_cPerlinGenerator, "seed=", Perlin_Generator_set_seed, 1);
+    rb_define_method(rb_cPerlinGenerator, "persistence=", Perlin_Generator_set_persistence, 1);
+    rb_define_method(rb_cPerlinGenerator, "octave=", Perlin_Generator_set_octave, 1);
+    rb_define_method(rb_cPerlinGenerator, "classic=", Perlin_Generator_set_classic, 1);
+
+    rb_define_method(rb_cPerlinGenerator, "[]", Perlin_Generator_run, -1);
+    rb_define_method(rb_cPerlinGenerator, "run2d", Perlin_Generator_run2d, 2);
+    rb_define_method(rb_cPerlinGenerator, "run3d", Perlin_Generator_run3d, 3);
+
+    rb_define_method(rb_cPerlinGenerator, "chunk", Perlin_Generator_chunk, -1);
+    rb_define_method(rb_cPerlinGenerator, "chunk2d", Perlin_Generator_chunk2d, 5);
+    rb_define_method(rb_cPerlinGenerator, "chunk3d", Perlin_Generator_chunk3d, 7);
+}
+
+// Memory management.
+
+VALUE Perlin_Generator_allocate(VALUE klass)
+{
+    PerlinGenerator* generator = ALLOC(PerlinGenerator);
+    memset(generator, 0, sizeof(PerlinGenerator));
+
+    return Data_Wrap_Struct(klass, 0, Perlin_Generator_free, generator);
+}
+
+void Perlin_Generator_free(PerlinGenerator* generator)
+{
+    xfree(generator);
+}
+
+// Getters and setters.
+
 VALUE Perlin_Generator_set_seed(const VALUE self, const VALUE seed)
 {
-    rb_iv_set(self, "@seed", rb_funcall(seed, rb_intern("to_i"), 0));
+    GENERATOR();
+
+    long _seed = NUM2LONG(seed);
+    if(_seed < 1) rb_raise(rb_eArgError, "seed must be >= 1");
+    generator->seed = _seed;
+
+    return seed;
+}
+
+VALUE Perlin_Generator_get_seed(const VALUE self)
+{
+    GENERATOR();
+    return LONG2NUM(generator->seed);
 }
 
 VALUE Perlin_Generator_set_persistence(const VALUE self, const VALUE persistence)
 {
-   rb_iv_set(self, "@persistence", rb_funcall(persistence, rb_intern("to_f"), 0));
+    GENERATOR();
+    generator->persistence = NUM2DBL(persistence);
+    return persistence;
+}
+
+VALUE Perlin_Generator_get_persistence(const VALUE self)
+{
+    GENERATOR();
+    return rb_float_new(generator->persistence);
 }
 
 VALUE Perlin_Generator_set_octave(const VALUE self, const VALUE octave)
 {
-    rb_iv_set(self, "@octave", rb_funcall(octave, rb_intern("to_i"), 0));
+    GENERATOR();
+
+    long _octave = NUM2LONG(octave);
+    if(_octave < 1) rb_raise(rb_eArgError, "octave must be >= 1");
+    generator->octave = _octave;
+
+    return octave;
+}
+
+VALUE Perlin_Generator_get_octave(const VALUE self)
+{
+    GENERATOR();
+    return LONG2NUM(generator->octave);
 }
 
 VALUE Perlin_Generator_set_classic(const VALUE self, const VALUE classic)
 {
-    rb_iv_set(self, "@classic", classic);
+    GENERATOR();
+    generator->is_classic = RTEST(classic);
+    return classic;
+}
+
+VALUE Perlin_Generator_get_classic(const VALUE self)
+{
+    GENERATOR();
+    return (generator->is_classic ? Qtrue : Qfalse);
 }
 
 // x, y
@@ -30,16 +113,9 @@ VALUE Perlin_Generator_run(const int argc, const VALUE *argv, const VALUE self)
 
     switch(argc)
     {
-        case 2:
-            Perlin_Generator_run2d(self, x, y);
-            break;
-
-        case 3:
-            Perlin_Generator_run3d(self, x, y, z);
-            break;
-
-        default:
-            rb_raise(rb_eArgError, "%d parameters not supported (2D and 3D are)", argc);
+        case 2:  return Perlin_Generator_run2d(self, x, y);
+        case 3:  return Perlin_Generator_run3d(self, x, y, z);
+        default: rb_raise(rb_eArgError, "%d parameters not supported (2D and 3D are)", argc);
     }
 }
 
@@ -48,19 +124,17 @@ Takes points (x, y) and returns a height (n)
 */
 VALUE Perlin_Generator_run2d(const VALUE self, const VALUE x, const VALUE y)
 {
-    const float p = RFLOAT_VALUE(rb_iv_get(self, "@persistence"));
-    const int n = NUM2INT(rb_iv_get(self, "@octave"));
-    const VALUE classic = rb_iv_get(self, "@classic");
+    GENERATOR();
 
-    seed = NUM2LONG(rb_iv_get(self, "@seed")); // Store in global, for speed.
-
-    if(RTEST(classic))
+    if(generator->is_classic)
     {
-        return rb_float_new(perlin_octaves_2d(NUM2DBL(x), NUM2DBL(y), p, n));
+        seed = generator->seed; // Store in global, for speed.
+        return rb_float_new(perlin_octaves_2d(NUM2DBL(x), NUM2DBL(y), generator->persistence, generator->octave));
     }
     else
     {
-        return rb_float_new(octave_noise_3d(n, p, 1.0, NUM2DBL(x), NUM2DBL(y), seed * SEED_OFFSET));
+        return rb_float_new(octave_noise_3d(generator->octave, generator->persistence, 1.0, NUM2DBL(x), NUM2DBL(y),
+                            generator->seed));
     }
 }
 
@@ -69,19 +143,17 @@ Takes points (x, y, z) and returns a height (n)
 */
 VALUE Perlin_Generator_run3d(const VALUE self, const VALUE x, const VALUE y, const VALUE z)
 {
-    const float p = RFLOAT_VALUE(rb_iv_get(self, "@persistence"));
-    const int n = NUM2INT(rb_iv_get(self, "@octave"));
-    const VALUE classic = rb_iv_get(self, "@classic");
-
-    seed = NUM2LONG(rb_iv_get(self, "@seed")); // Store in global, for speed.
+    GENERATOR();
 
-    if(RTEST(classic))
+    if(generator->is_classic)
     {
-        return rb_float_new(perlin_octaves_3d(NUM2DBL(x), NUM2DBL(y), NUM2DBL(z), p, n));
+        seed = generator->seed; // Store in global, for speed.
+        return rb_float_new(perlin_octaves_3d(NUM2DBL(x), NUM2DBL(y), NUM2DBL(z), generator->persistence, generator->octave));
     }
     else
     {
-        return rb_float_new(octave_noise_4d(n, p, 1.0, NUM2DBL(x), NUM2DBL(y), NUM2DBL(z), seed * SEED_OFFSET));
+        return rb_float_new(octave_noise_4d(generator->octave, generator->persistence, 1.0, NUM2DBL(x), NUM2DBL(y), NUM2DBL(z),
+                            generator->seed));
     }
 
 }
@@ -96,16 +168,9 @@ VALUE Perlin_Generator_chunk(const int argc, const VALUE *argv, const VALUE self
 
     switch(argc)
     {
-        case 5:
-            Perlin_Generator_chunk2d(self, a, b, c, d, e);
-            break;
-
-        case 7:
-            Perlin_Generator_chunk3d(self, a, b, c, d, e, f, g);
-            break;
-
-        default:
-            rb_raise(rb_eArgError, "%d parameters not supported (5 for 2D and 7 for 3D are)", argc);
+        case 5:  return Perlin_Generator_chunk2d(self, a, b, c, d, e);
+        case 7:  return Perlin_Generator_chunk3d(self, a, b, c, d, e, f, g);
+        default: rb_raise(rb_eArgError, "%d parameters not supported (5 for 2D and 7 for 3D are)", argc);
     }
 }
 
@@ -114,9 +179,7 @@ Returns a chunk of coordinates starting from x, y and of size steps_x, steps_y w
 */
 VALUE Perlin_Generator_chunk2d(const VALUE self, const VALUE x, const VALUE y, const VALUE steps_x, const VALUE steps_y, const VALUE interval)
 {
-    const float p = RFLOAT_VALUE(rb_iv_get(self, "@persistence"));
-    const int n = NUM2INT(rb_iv_get(self, "@octave"));
-    const int is_classic = RTEST(rb_iv_get(self, "@classic"));
+    GENERATOR();
 
     VALUE arr, row;
     int i, j;
@@ -131,7 +194,7 @@ VALUE Perlin_Generator_chunk2d(const VALUE self, const VALUE x, const VALUE y, c
         rb_raise(rb_eArgError, "steps must be >= 1");
     }
 
-    seed = NUM2LONG(rb_iv_get(self, "@seed")); // Store in global, for speed.
+    if(generator->is_classic) seed = generator->seed; // Store in global, for speed.
 
     if(rb_block_given_p())
     {
@@ -142,14 +205,14 @@ VALUE Perlin_Generator_chunk2d(const VALUE self, const VALUE x, const VALUE y, c
            _y = y_min;
            for (j = 0; j < _steps_y; j++)
            {
-                if(is_classic)
+                if(generator->is_classic)
                 {
-                    rb_yield_values(3, rb_float_new(perlin_octaves_2d(_x, _y, p, n)),
+                    rb_yield_values(3, rb_float_new(perlin_octaves_2d(_x, _y, generator->persistence, generator->octave)),
                                     rb_float_new(_x), rb_float_new(_y));
                 }
                 else
                 {
-                    rb_yield_values(3, rb_float_new(octave_noise_3d(n, p, 1.0, _x, _y, seed * SEED_OFFSET)),
+                    rb_yield_values(3, rb_float_new(octave_noise_3d(generator->octave, generator->persistence, 1.0, _x, _y, generator->seed)),
                                     rb_float_new(_x), rb_float_new(_y));
                 }
 
@@ -171,13 +234,13 @@ VALUE Perlin_Generator_chunk2d(const VALUE self, const VALUE x, const VALUE y, c
             _y = y_min;
             for (j = 0; j < _steps_y; j++)
             {
-                if(is_classic)
+                if(generator->is_classic)
                 {
-                    rb_ary_push(row, rb_float_new(perlin_octaves_2d(_x, _y, p, n)));
+                    rb_ary_push(row, rb_float_new(perlin_octaves_2d(_x, _y, generator->persistence, generator->octave)));
                 }
                 else
                 {
-                    rb_ary_push(row, rb_float_new(octave_noise_3d(n, p, 1.0, _x, _y, seed * SEED_OFFSET)));
+                    rb_ary_push(row, rb_float_new(octave_noise_3d(generator->octave, generator->persistence, 1.0, _x, _y, generator->seed)));
                 }
 
                 _y += _interval;
@@ -194,9 +257,7 @@ Returns a chunk of coordinates starting from x, y, z and of size steps_x, steps_
 */
 VALUE Perlin_Generator_chunk3d(const VALUE self, const VALUE x, const VALUE y, const VALUE z, const VALUE steps_x, const VALUE steps_y, const VALUE steps_z, const VALUE interval)
 {
-    const float p = RFLOAT_VALUE(rb_iv_get(self, "@persistence"));
-    const int n = NUM2INT(rb_iv_get(self, "@octave"));
-    const int is_classic = RTEST(rb_iv_get(self, "@classic"));
+    GENERATOR();
 
     VALUE arr, row, column;
     int i, j, k;
@@ -211,7 +272,7 @@ VALUE Perlin_Generator_chunk3d(const VALUE self, const VALUE x, const VALUE y, c
         rb_raise(rb_eArgError, "steps must be >= 1");
     }
 
-    seed = NUM2LONG(rb_iv_get(self, "@seed")); // Store in global, for speed.
+    if(generator->is_classic) seed = generator->seed; // Store in global, for speed.
 
     if(rb_block_given_p())
     {
@@ -224,14 +285,15 @@ VALUE Perlin_Generator_chunk3d(const VALUE self, const VALUE x, const VALUE y, c
                 _z = z_min;
                 for (k = 0; k < _steps_z; k++)
                 {
-                    if(is_classic)
+                    if(generator->is_classic)
                     {
-                        rb_yield_values(4, rb_float_new(perlin_octaves_3d(_x, _y, _z, p, n)),
+                        rb_yield_values(4, rb_float_new(perlin_octaves_3d(_x, _y, _z, generator->persistence, generator->octave)),
                                         rb_float_new(_x), rb_float_new(_y), rb_float_new(_z));
                     }
                     else
                     {
-                        rb_yield_values(4, rb_float_new(octave_noise_4d(n, p, 1.0, _x, _y, _z, seed * SEED_OFFSET)),
+                        rb_yield_values(4,
+                                        rb_float_new(octave_noise_4d(generator->octave, generator->persistence, 1.0, _x, _y, _z, generator->seed)),
                                         rb_float_new(_x), rb_float_new(_y), rb_float_new(_z));
                     }
 
@@ -257,13 +319,14 @@ VALUE Perlin_Generator_chunk3d(const VALUE self, const VALUE x, const VALUE y, c
                 _z = z_min;
                 for (k = 0; k < _steps_z; k++)
                 {
-                    if(is_classic)
+                    if(generator->is_classic)
                     {
-                        rb_ary_push(column, rb_float_new(perlin_octaves_3d(_x, _y, _z, p, n)));
+                        rb_ary_push(column, rb_float_new(perlin_octaves_3d(_x, _y, _z, generator->persistence, generator->octave)));
                     }
                     else
                     {
-                        rb_ary_push(column, rb_float_new(octave_noise_4d(n, p, 1.0, _x, _y, _z, seed * SEED_OFFSET)));
+                        rb_ary_push(column, rb_float_new(octave_noise_4d(generator->octave, generator->persistence, 1.0,
+                            _x, _y, _z, generator->seed)));
                     }
 
                     _z += _interval;
@@ -281,12 +344,24 @@ VALUE Perlin_Generator_chunk3d(const VALUE self, const VALUE x, const VALUE y, c
 /*
 The main initialize function which receives the inputs persistence and octave.
 */
-VALUE Perlin_Generator_init(VALUE self, VALUE seed, VALUE persistence, VALUE octave, VALUE classic)
+VALUE Perlin_Generator_init(const int argc, const VALUE *argv, const VALUE self)
 {
+    VALUE seed, persistence, octave, options;
+
+    rb_scan_args(argc, argv, "31", &seed, &persistence, &octave, &options);
+    if(NIL_P(options))
+    {
+       options = rb_hash_new();
+    }
+    else
+    {
+       Check_Type(options, T_HASH);
+    }
+
     Perlin_Generator_set_seed(self, seed);
     Perlin_Generator_set_persistence(self, persistence);
     Perlin_Generator_set_octave(self, octave);
-    Perlin_Generator_set_classic(self, classic);
+    Perlin_Generator_set_classic(self, rb_hash_aref(options, ID2SYM(rb_intern("classic"))));
 
     return self;
 }

data/ext/perlin/generator.h

@@ -7,21 +7,28 @@
 
 #include <ruby.h>
 
+#include <stdbool.h>
+
 #include "classic.h"
 #include "simplex.h"
 
 extern long seed;
 
-// Arbitrary number used to add an extra "seed" dimension for Simplex noise.
-// Seed 2D noise by offsetting the 3rd dimension.
-// Seed 3D noise by seeding with the 4th dimension.
-#define SEED_OFFSET -12354.1123f
+void Init_Perlin_Generator();
+
+// Getters.
+VALUE Perlin_Generator_get_seed(const VALUE self);
+VALUE Perlin_Generator_get_persistence(const VALUE self);
+VALUE Perlin_Generator_get_octave(const VALUE self);
+VALUE Perlin_Generator_get_classic(const VALUE self);
 
+// Setters.
 VALUE Perlin_Generator_set_seed(const VALUE self, const VALUE seed);
 VALUE Perlin_Generator_set_persistence(const VALUE self, const VALUE persistence);
 VALUE Perlin_Generator_set_octave(const VALUE self, const VALUE octave);
 VALUE Perlin_Generator_set_classic(const VALUE self, const VALUE classic);
 
+// Actually getting noise.
 VALUE Perlin_Generator_run(const int argc, const VALUE *argv, const VALUE self);
 VALUE Perlin_Generator_run2d(const VALUE self, const VALUE x, const VALUE y);
 VALUE Perlin_Generator_run3d(const VALUE self, const VALUE x, const VALUE y, const VALUE z);
@@ -30,6 +37,23 @@ VALUE Perlin_Generator_chunk(const int argc, const VALUE *argv, const VALUE self
 VALUE Perlin_Generator_chunk2d(const VALUE self, const VALUE x, const VALUE y, const VALUE steps_x, const VALUE steps_y, VALUE interval);
 VALUE Perlin_Generator_chunk3d(const VALUE self, const VALUE x, const VALUE y, const VALUE z, const VALUE steps_x, const VALUE steps_y, const VALUE steps_z, const VALUE interval);
 
-VALUE Perlin_Generator_init(const VALUE self, const VALUE seed, const VALUE persistence, const VALUE octave, const VALUE classic);
+VALUE Perlin_Generator_init(const int argc, const VALUE *argv, const VALUE self);
+
+// Data management stuff.
+
+typedef struct _PerlinGenerator
+{
+    bool is_classic; // True if Classic, false if Simplex.
+    long seed; // >= 1
+    long octave; // >= 1
+    double persistence;
+} PerlinGenerator;
+
+#define GENERATOR() \
+    PerlinGenerator* generator; \
+    Data_Get_Struct(self, PerlinGenerator, generator);
+
+VALUE Perlin_Generator_allocate(VALUE klass);
+void Perlin_Generator_free(PerlinGenerator* generator);
 
 #endif // GENERATOR_H

data/ext/perlin/perlin.c

@@ -7,21 +7,6 @@ located at http://freespace.virgin.net/hugo.elias/models/m_perlin.htm
 
 void Init_perlin() {
     VALUE jm_Module = rb_define_module("Perlin");
-    VALUE rb_cPerlin = rb_define_class_under(jm_Module, "Generator", rb_cObject);
-
-    rb_define_method(rb_cPerlin, "initialize_", Perlin_Generator_init, 4);
-
-    rb_define_method(rb_cPerlin, "seed=", Perlin_Generator_set_seed, 1);
-    rb_define_method(rb_cPerlin, "persistence=", Perlin_Generator_set_persistence, 1);
-    rb_define_method(rb_cPerlin, "octave=", Perlin_Generator_set_octave, 1);
-    rb_define_method(rb_cPerlin, "classic=", Perlin_Generator_set_classic, 1);
-
-    rb_define_method(rb_cPerlin, "[]", Perlin_Generator_run, -1);
-    rb_define_method(rb_cPerlin, "run2d", Perlin_Generator_run2d, 2);
-    rb_define_method(rb_cPerlin, "run3d", Perlin_Generator_run3d, 3);
-
-    rb_define_method(rb_cPerlin, "chunk", Perlin_Generator_chunk, -1);
-    rb_define_method(rb_cPerlin, "chunk2d", Perlin_Generator_chunk2d, 5);
-    rb_define_method(rb_cPerlin, "chunk3d", Perlin_Generator_chunk3d, 7);
+    Init_Perlin_Generator(jm_Module);
 }
 

data/lib/perlin/generator.rb

@@ -2,34 +2,37 @@ module Perlin
   # Perlin noise generator.
   #
   # @!attribute [rw] seed
+  #   Seed value for the noise pattern (>= 0)
   #   @return [Integer]
   #
-  # @!attribute [r] persistence
+  # @!attribute [rw] persistence
+  #   Amount of persistence of noise through each octave
   #   @return [Float]
   #
-  # @!attribute [r] octave
+  # @!attribute [rw] octave
+  #   Number of octaves (or iterations) of noise to generate (>= 1)
   #   @return [Integer]
   class Generator
-    attr_reader :seed, :octave, :persistence
-    def classic?; @classic; end
+    # @!method classic?
+    #   @return [Boolean] True for Classic noise, false for Simplex noise.
 
-    # @!method initialize(seed, persistence, octave)
+    # @!method classic=(value)
+    #   @param value [Boolean] True for Classic noise, false for Simplex noise.
+    #   @return [Boolean]
+
+    # @return [Boolean] True for Simplex noise, false for Classic noise.
+    def simplex?; !classic? end
+
+    # @!method initialize(seed, persistence, octave, options={})
     #   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)
+    #   @param seed [Integer] Seed value to create a different pattern (must be >= 0).
+    #   @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) (must be >= 1)
     #   @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.

data/lib/perlin/version.rb

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

data/spec/perlin/generator_spec.rb

@@ -4,7 +4,7 @@ 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
+    @simplex = Perlin::Generator.new 1, 1.5, 2
     @accuracy = 0.00001
   end
 
@@ -50,12 +50,16 @@ describe Perlin::Generator do
       @classic.seed.should eq 12
       @classic.seed.should be_kind_of Integer
     end
+
+    it "should fail unless >= 1" do
+      lambda { @classic.seed = 0 }.should raise_error ArgumentError, "seed must be >= 1"
+    end
   end
 
   describe "persistence=" do
     it "should set persistence correctly" do
-      @classic.persistence = 12
-      @classic.persistence.should eq 12
+      @classic.persistence = 12.1513
+      @classic.persistence.should eq 12.1513
       @classic.persistence.should be_kind_of Float
     end
   end
@@ -66,6 +70,10 @@ describe Perlin::Generator do
       @classic.octave.should eq 12
       @classic.octave.should be_kind_of Integer
     end
+
+    it "should fail unless >= 1" do
+      lambda { @classic.octave = 0 }.should raise_error ArgumentError, "octave must be >= 1"
+    end
   end
 
   describe "classic=" do
@@ -97,7 +105,7 @@ describe Perlin::Generator do
     describe "SIMPLEX" do
       describe "[](x, y)" do
         it "should return the appropriate value" do
-          @simplex[0, 1].should be_within(@accuracy).of 0.7600996515471077
+          @simplex[0, 1].should be_within(@accuracy).of -0.7169484162988542
         end
 
         it "should return different values based on seed" do
@@ -109,7 +117,7 @@ describe Perlin::Generator do
 
       describe "[](x, y, z)" do
         it "should return the appropriate value" do
-          @simplex[0, 1, 2].should be_within(@accuracy).of -0.4994023090387083
+          @simplex[0, 1, 2].should be_within(@accuracy).of 0.3528568374548613
         end
       end
     end
@@ -141,7 +149,7 @@ describe Perlin::Generator 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]]
+          chunk.should eq [[0.3256153247344187, -0.044141564834959, -1.9775393411691766e-07, -0.30403976440429686], [0.0, 1.9775393411691766e-07, 0.0, -0.21674697868461495], [1.9775393411691766e-07, -0.23931307266021215, -0.7600996287015893, -5.93261818394248e-07]]
         end
 
         it "should give the same results, regardless of x/y offset" do
@@ -159,7 +167,7 @@ describe Perlin::Generator do
           @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]]
+          arr.should eq [[0.3256153247344187, 1.0, 2.0], [-0.044141564834959, 1.0, 3.0], [-1.9775393411691766e-07, 1.0, 4.0], [-0.30403976440429686, 1.0, 5.0], [0.0, 2.0, 2.0], [1.9775393411691766e-07, 2.0, 3.0], [0.0, 2.0, 4.0], [-0.21674697868461495, 2.0, 5.0], [1.9775393411691766e-07, 3.0, 2.0], [-0.23931307266021215, 3.0, 3.0], [-0.7600996287015893, 3.0, 4.0], [-5.93261818394248e-07, 3.0, 5.0]]
         end
       end
 
@@ -201,7 +209,7 @@ describe Perlin::Generator 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]]]
+          chunk.should eq [[[-0.13219586780905937], [-0.10557871005195935]], [[0.057937057229464836], [0.14160177316516637]], [[0.4784122159704566], [0.23034484239760417]]]
         end
 
         it "should work with a block" do
@@ -209,7 +217,7 @@ describe Perlin::Generator do
           @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]]
+          arr.should eq [[-0.13219586780905937, 6.0, 5.0, 4.0], [-0.10557871005195935, 6.0, 6.0, 4.0], [0.057937057229464836, 7.0, 5.0, 4.0], [0.14160177316516637, 7.0, 6.0, 4.0], [0.4784122159704566, 8.0, 5.0, 4.0], [0.23034484239760417, 8.0, 6.0, 4.0]]
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perlin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: RedCloth
@@ -109,6 +109,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: texplay
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+- !ruby/object:Gem::Dependency
+  name: gosu
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.45
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.45
+- !ruby/object:Gem::Dependency
+  name: fidgit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 description: ! 'Perlin Noise C extension
 
 
@@ -119,6 +167,7 @@ description: ! 'Perlin Noise C extension
 
 '
 email:
+- bil.bagpuss@gmail.com
 - mojobojo@gmail.com
 executables: []
 extensions:
@@ -143,13 +192,14 @@ files:
 - ext/perlin/extconf.rb
 - examples/chunk_in_2d.rb
 - examples/chunk_in_3d.rb
+- examples/gosu.rb
 - examples/index_in_2d.rb
 - 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
+homepage: https://github.com/spooner/ruby-perlin
 licenses:
 - MIT
 post_install_message: