perlin 0.1.0pre1

data/CHANGELOG

@@ -0,0 +1,13 @@
+0.1.0
+-----
+
+* Converted to gem (previously was just a .c file).
+* Added 3D chunks.
+* Optimised chunk operations.
+* Added Generator#[x, y]
+* Added Generator#[x, y, z]
+* Added Generator#chunk x, y, size_x, size_y
+* Added Generator#chunk x, y, z, size_x, size_y, size_z
+* Added Generator#persistence, #seed and #octave accessors.
+* Added Perlin's Simplex generation (much faster).
+* A number of general fixes (added rspec tests).

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Brian Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+Perlin
+======
+
+A Perlin noise implementation based off
+<http://freespace.virgin.net/hugo.elias/models/m_perlin.htm>. Implemented as a Ruby C extension, it is considerably faster than the pure Ruby equivalent, [perlin_noise](https://github.com/junegunn/perlin_noise).
+
+- Written by Brian 'bojo' Jones <mojobojo@gmail.com>
+- Optimizations thanks to Camille Goudeseune, Univ of Illinois, <cog@illinois.edu>
+- Made into gem and extended by Bil Bas (bil.bagpuss@gmail.com)
+
+- [Simplex noise functions copyright (c) 2007-2012 Eliot Eshelman](http://www.6by9.net/b/2012/02/03/simplex-noise-for-c-and-python)
+
+INSTALL
+-------
+
+    $ gem install perlin
+
+USAGE
+-----
+
+    require 'perlin'
+
+    # Takes values seed, persistence, and octaves
+    noise = Perlin::Generator.new 123, 1.0, 1
+
+    # Returns a 'height' value for (x, y)
+    puts noise[10, 20]  #=> 0.9004574418067932
+
+    # Returns a 2D array of 'heights' for a range (x, y, size_x, size_y, interval)
+    arr = noise.chunk 1, 1, 2, 3, 1
+
+    p arr  #= > [[0.05753844603896141, -0.2208995521068573, 0.3973901569843292],
+           #    [0.1383310854434967, -0.22248442471027374, 0.15600799024105072]]

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'rake/extensiontask'
+require 'yard'
+require 'redcloth'
+require 'launchy'
+
+
+begin
+  require 'devkit' # only used on windows
+rescue LoadError
+end
+
+require File.expand_path('../lib/perlin/version', __FILE__)
+
+CLOBBER << "coverage"
+
+# somewhere in your Rakefile, define your gem spec
+spec = Gem::Specification.new do |s|
+  s.name = 'perlin'
+  s.version = Perlin::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.authors = ["Brian 'bojo' Jones", 'Camille Goudeseune', 'Bil Bas']
+
+  s.summary = 'Perlin Noise C extension'
+  s.description = <<-END
+#{s.summary}
+
+A Perlin/Simplex noise implementation based of
+<http://freespace.virgin.net/hugo.elias/models/m_perlin.htm>. Implemented as a Ruby C extension.
+  END
+
+  s.email = %w<mojobojo@gmail.com>
+  s.files = Dir.glob %w<CHANGELOG LICENSE Rakefile README.md lib/**/*.* lib ext/**/*.* examples/**/*.*>
+  s.homepage = 'https://github.com/boj/ruby-perlin'
+  s.licenses = %w<MIT>
+  s.extensions << 'ext/perlin/extconf.rb'
+  s.rubyforge_project = 'ruby-perlin'
+  s.test_files = []
+  s.has_rdoc = 'yard'
+
+  s.add_development_dependency 'rake-compile', '~> 0.8.1'
+  s.add_development_dependency 'simplecov', '~> 0.6.4'
+  s.add_development_dependency 'launchy', '~> 2.1.0'
+end
+
+Gem::PackageTask.new spec do
+end
+
+Rake::ExtensionTask.new 'perlin', spec do |ext|
+  RUBY_VERSION =~ /(\d+.\d+)/
+  ext.lib_dir = "lib/perlin/#{$1}"
+end
+
+YARD::Rake::YardocTask.new
+
+task :default => :spec
+task :spec => :compile
+
+RSpec::Core::RakeTask.new do |t|
+end
+
+desc "Generate SimpleCov test coverage and open in your browser"
+task :coverage do
+  rm_r "coverage" rescue nil
+
+  sh %q<ruby -rsimplecov -e "SimpleCov.command_name 'spec'; SimpleCov.start">
+
+  Launchy.open "coverage/index.html" rescue nil
+end
+
+desc "Open yard docs in browser"
+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__)
+end

data/examples/chunk_in_2d.rb

@@ -0,0 +1,22 @@
+require 'perlin'
+
+def print_data(seed, persistence, octave, size_x, size_y, interval)
+  noise = Perlin::Generator.new seed, persistence, octave
+
+  puts
+
+  data = noise.chunk 0, 0, size_x, size_y, interval
+  size_y.times do |y|
+    str = ''
+
+    size_x.times do |x|
+      str << "%7.2f" % data[x][y]
+    end
+
+    puts str
+  end
+end
+
+print_data 5, 1.0, 1, 10, 500, 1
+
+puts "\nDone!"

data/examples/chunk_in_3d.rb

@@ -0,0 +1,24 @@
+require 'perlin'
+
+def print_data(seed, persistence, octave, size_x, size_y, size_z, interval)
+  noise = Perlin::Generator.new seed, persistence, octave
+
+  puts
+
+  data = noise.chunk 0, 0, 0, size_x, size_y, size_z, interval
+  size_z.times do |z|
+    size_y.times do |y|
+      str = ''
+
+      size_x.times do |x|
+        str << "%7.2f" % data[x][y]
+      end
+
+      puts str
+    end
+  end
+end
+
+print_data 5, 1.0, 1, 10, 500, 99, 1.9
+
+puts "\nDone!"

data/examples/index_in_2d.rb

@@ -0,0 +1,23 @@
+require 'perlin'
+
+def print_data(seed, persistence, octave, size_x, size_y)
+  noise = Perlin::Generator.new seed, persistence, octave
+
+  puts
+
+  # Note that it would be significantly faster to use #chunk in this example.
+  size_y.times do |y|
+    str = ''
+
+    size_x.times do |x|
+      n = noise.run2d x, y
+      str << "%7.2f" % n
+    end
+
+    puts str
+  end
+end
+
+print_data 5, 1.0, 1, 10, 500
+
+puts "\nDone!"

data/examples/index_in_3d.rb

@@ -0,0 +1,25 @@
+require 'perlin'
+
+def print_data(seed, persistence, octave, size_x, size_y, size_z)
+  noise = Perlin::Generator.new seed, persistence, octave
+
+  puts
+
+  # Note that it would be significantly faster to use #chunk in this example.
+  size_z.times do |z|
+    size_y.times do |y|
+      str = ''
+
+      size_x.times do |x|
+        n = noise.run3d x, y, z
+        str << "%7.2f" % n
+      end
+
+      puts str
+    end
+  end
+end
+
+print_data 5, 1.0, 1, 10, 200, 99
+
+puts "\nDone!"

data/examples/ogl/README.md

@@ -0,0 +1,3 @@
+# Install
+
+    gem install ruby-opengl fxruby

data/examples/ogl/run.rb

@@ -0,0 +1,200 @@
+require 'perlin'
+require 'rubygems'
+require 'fox16'
+
+# Base framework borrowed from: http://www.fxruby.org/examples/gltest.rb
+
+include Fox
+
+class GLTestWindow < FXMainWindow
+
+  # How often our timer will fire (in milliseconds)
+  TIMER_INTERVAL = 100
+  
+  def drawTerrain(width, length)
+    p = Perlin.new(@p_seed.to_s.to_i, @p_freq.to_s.to_f, @p_octave.to_s.to_i)
+    
+    GL.Begin(GL::QUADS)
+    for x in 0..width
+      for y in 0..length
+        material = [rand, rand, rand]
+        GL.Material(GL::FRONT, GL::AMBIENT, material)
+        GL.Material(GL::FRONT, GL::DIFFUSE, material)
+        GL.Vertex(x, y, p.run(x, y))
+        GL.Vertex(x + 1, y, p.run(x + 1, y))
+        GL.Vertex(x + 1, y + 1, p.run(x + 1, y + 1))
+        GL.Vertex(x, y + 1, p.run(x, y + 1))
+      end
+    end
+    GL.End()
+  end
+
+  # Draw the GL scene
+  def drawScene
+    lightPosition = [5.0, 5.0, 5.0, 1.0]
+    lightAmbient  = [ 0.5,  0.5, 0.5, 1.0]
+    lightDiffuse  = [ 0.9,  0.9, 0.9, 1.0]
+  
+    width = @glcanvas.width.to_f
+    height = @glcanvas.height.to_f
+    aspect = width / height
+  
+    # Make context current
+    @glcanvas.makeCurrent()
+    
+    GL.Viewport(0, 0, @glcanvas.width, @glcanvas.height)
+  
+    GL.ClearColor(0.0, 0.0, 0.0, 0.0)
+    GL.Clear(GL::COLOR_BUFFER_BIT|GL::DEPTH_BUFFER_BIT)
+    GL.Enable(GL::DEPTH_TEST)
+    
+    GL.Disable(GL::DITHER)
+  
+    GL.MatrixMode(GL::PROJECTION)
+    GL.LoadIdentity()
+    GLU.Perspective(90.0, aspect, 1.0, 100.0)
+  
+    GL.MatrixMode(GL::MODELVIEW)
+    GL.LoadIdentity()
+    x = (@p_width.to_s.to_i / 2.0)
+    y = (@p_length.to_s.to_i / 2.0)
+    GLU.LookAt(5.0, 15.0, 5.0, x, y, 0.0, 0.0, -1.0, 0.0)
+  
+    GL.ShadeModel(GL::SMOOTH)
+    GL.Light(GL::LIGHT0, GL::POSITION, lightPosition)
+    GL.Light(GL::LIGHT0, GL::AMBIENT, lightAmbient)
+    GL.Light(GL::LIGHT0, GL::DIFFUSE, lightDiffuse)
+    GL.Enable(GL::LIGHT0)
+    GL.Enable(GL::LIGHTING)
+  
+    GL.PushMatrix()
+    drawTerrain(@p_width.to_s.to_i, @p_length.to_s.to_i)
+    GL.PopMatrix()
+  
+    # Swap if it is double-buffered
+    if @glvisual.isDoubleBuffer
+      @glcanvas.swapBuffers
+    end
+    
+    # Make context non-current
+    @glcanvas.makeNonCurrent
+  end
+
+  def initialize(app)
+    @p_seed   = FXDataTarget.new(rand(100))
+    @p_freq   = FXDataTarget.new(1.0)
+    @p_octave = FXDataTarget.new(1)
+    @p_width  = FXDataTarget.new(10)
+    @p_length = FXDataTarget.new(10)
+    
+    # Invoke the base class initializer
+    super(app, "Perlin Visualizer", :opts => DECOR_ALL, :width => 800, :height => 600)
+
+    # Construct the main window elements
+    frame = FXHorizontalFrame.new(self, LAYOUT_SIDE_TOP | LAYOUT_FILL_X | LAYOUT_FILL_Y)
+    frame.padLeft, frame.padRight = 0, 0
+    frame.padTop, frame.padBottom = 0, 0
+
+    # Left pane to contain the glcanvas
+    glcanvasFrame = FXVerticalFrame.new(frame, LAYOUT_FILL_X | LAYOUT_FILL_Y | LAYOUT_TOP | LAYOUT_LEFT)
+  
+    # Drawing glcanvas
+    glpanel = FXVerticalFrame.new(
+      glcanvasFrame, (FRAME_SUNKEN | FRAME_THICK | LAYOUT_FILL_X | LAYOUT_FILL_Y | LAYOUT_TOP | LAYOUT_LEFT)
+    )
+    glpanel.padLeft, glpanel.padRight = 0, 0
+    glpanel.padTop, glpanel.padBottom = 0, 0
+      
+    # A visual to draw OpenGL
+    @glvisual = FXGLVisual.new(getApp(), VISUAL_DOUBLEBUFFER)
+  
+    # Drawing glcanvas
+    @glcanvas = FXGLCanvas.new(glpanel, @glvisual, :opts => LAYOUT_FILL_X | LAYOUT_FILL_Y | LAYOUT_TOP | LAYOUT_LEFT)
+    @glcanvas.connect(SEL_PAINT) { drawScene }
+    @glcanvas.connect(SEL_CONFIGURE) do
+      if @glcanvas.makeCurrent
+        GL.Viewport(0, 0, @glcanvas.width, @glcanvas.height)
+        @glcanvas.makeNonCurrent
+      end
+    end
+    
+    # Right pane for the buttons
+    buttonFrame = FXVerticalFrame.new(frame, LAYOUT_FILL_Y | LAYOUT_TOP | LAYOUT_LEFT)
+    buttonFrame.padLeft, buttonFrame.padRight = 10, 10
+    buttonFrame.padTop, buttonFrame.padBottom = 10, 10
+    
+    # Redraw button
+    redrawBtn = FXButton.new(
+      buttonFrame,
+      "&Redraw\tRedraw the screen",
+      :opts => FRAME_THICK | FRAME_RAISED | LAYOUT_FILL_X | LAYOUT_TOP | LAYOUT_LEFT
+    )
+    redrawBtn.connect(SEL_COMMAND) do
+      x = (@p_width.to_s.to_i / 2.0)
+      y = (@p_length.to_s.to_i / 2.0)
+      GLU.LookAt(0.0, 0.0, 10.0, x, y, 0.0, 0.0, 1.0, 0.0)
+      drawScene
+    end
+    redrawBtn.padLeft, redrawBtn.padRight = 10, 10
+    redrawBtn.padTop, redrawBtn.padBottom = 5, 5
+    
+    # Redraw button
+    redrawRndBtn = FXButton.new(
+      buttonFrame,
+      "&Redraw Random\tRedraw the screen after changing the seed",
+      :opts => FRAME_THICK | FRAME_RAISED | LAYOUT_FILL_X | LAYOUT_TOP | LAYOUT_LEFT
+    )
+    redrawRndBtn.connect(SEL_COMMAND) do
+      @p_seed   = FXDataTarget.new(rand(100))
+      drawScene
+    end
+    redrawRndBtn.padLeft, redrawRndBtn.padRight = 10, 10
+    redrawRndBtn.padTop, redrawRndBtn.padBottom = 5, 5
+    
+    FXLabel.new(buttonFrame, "Seed", nil, LAYOUT_CENTER_Y | LAYOUT_CENTER_X | JUSTIFY_RIGHT | LAYOUT_FILL_ROW)
+    FXTextField.new(buttonFrame, 10, @p_seed, FXDataTarget::ID_VALUE, TEXTFIELD_INTEGER | LAYOUT_FILL_ROW)
+    
+    FXLabel.new(buttonFrame, "Frequency", nil, LAYOUT_CENTER_Y | LAYOUT_CENTER_X | JUSTIFY_RIGHT | LAYOUT_FILL_ROW)
+    FXTextField.new(buttonFrame, 10, @p_freq, FXDataTarget::ID_VALUE, TEXTFIELD_REAL | LAYOUT_FILL_ROW)
+    
+    FXLabel.new(buttonFrame, "Octave", nil, LAYOUT_CENTER_Y | LAYOUT_CENTER_X | JUSTIFY_RIGHT | LAYOUT_FILL_ROW)
+    FXTextField.new(buttonFrame, 10, @p_octave, FXDataTarget::ID_VALUE, TEXTFIELD_INTEGER | LAYOUT_FILL_ROW)
+    
+    FXLabel.new(buttonFrame, "Width", nil, LAYOUT_CENTER_Y | LAYOUT_CENTER_X | JUSTIFY_RIGHT | LAYOUT_FILL_ROW)
+    FXTextField.new(buttonFrame, 10, @p_width, FXDataTarget::ID_VALUE, TEXTFIELD_INTEGER | LAYOUT_FILL_ROW)
+    
+    FXLabel.new(buttonFrame, "Length", nil, LAYOUT_CENTER_Y | LAYOUT_CENTER_X | JUSTIFY_RIGHT | LAYOUT_FILL_ROW)
+    FXTextField.new(buttonFrame, 10, @p_length, FXDataTarget::ID_VALUE, TEXTFIELD_INTEGER | LAYOUT_FILL_ROW)
+    
+    # Exit button
+    exitBtn = FXButton.new(
+      buttonFrame,
+      "&Exit\tExit the application", nil,
+      getApp(),
+      FXApp::ID_QUIT, 
+      FRAME_THICK | FRAME_RAISED | LAYOUT_FILL_X | LAYOUT_TOP | LAYOUT_LEFT
+    )
+    exitBtn.padLeft, exitBtn.padRight = 10, 10
+    exitBtn.padTop, exitBtn.padBottom = 5, 5
+  end
+
+  # Create and initialize
+  def create
+    super
+    show(PLACEMENT_SCREEN)
+  end
+end
+
+if __FILE__ == $0
+  application = FXApp.new("Perlin Data Viewer", "Perlin Data View")
+  application.disableThreads
+
+  # Construct the main window
+  GLTestWindow.new(application)
+
+  # Create the app's windows
+  application.create
+
+  # Run the application
+  application.run
+end