ruby-opengl 0.33.0 → 0.40.0

data/Rakefile

@@ -31,30 +31,46 @@ end
 require 'rake'
 require 'rake/clean'
 require 'rake/gempackagetask'
+require 'rake/testtask'
+
 require 'mkrf/rakehelper'
 
 WEBSITE_MKDN = FileList['./doc/*.txt'] << 'README.txt'
 NICE_HTML_DOCS = WEBSITE_MKDN.ext('html')
 
 CLEAN.include("ext/gl*/Rakefile", "ext/*/mkrf.log", "ext/*/*.so", 
-              "lib/*.so", "ext/*/*.o", "pkg")
+              "ext/**/*.bundle", "lib/*.so", "lib/*.bundle", "ext/*/*.o{,bj}", 
+              "ext/*/*.lib", "ext/*/*.exp", "ext/*/*.pdb",
+              "pkg")
 CLOBBER.include("*.plain", "doc/*.plain", "doc/*.snip", "*.html",
-                "doc/*.html", "website/*.html")
+                "doc/*.html", "website/*.html", "website/images/*")
+# Make sure these files aren't deleted in a clobber op
+CLOBBER.exclude("website/images/tab_bottom.gif")
 
 setup_extension('gl', 'gl')
 setup_extension('glu', 'glu')
 setup_extension('glut', 'glut')
 
-desc 'Does a full compile'
-task :default => [:build_rbogl, :gl, :glu, :glut]
+case RUBY_PLATFORM
+when /(:?mswin|mingw)/
+	desc 'Does a full win32 compile'
+	task :default do
+		exts = ["gl","glu","glut"]
+		exts.each do |ext|
+			Dir.chdir("ext\\#{ext}") do
+				sh "ruby mkrf_conf.rb"
+				sh "call rake --nosearch"
+				sh "copy #{ext}.so ..\\..\\lib"
+			end
+		end
+	end
+else
+	desc 'Does a full compile'
+	task :default => [:gl, :glu, :glut]
+end
 
-task :extension => :default
 
-desc 'Builds common OpenGL object file.  Necessary for building GL bindings'
-task :build_rbogl do
-    puts "Building common rbogl object file"
-    sh "cd ext/common && rake"
-end
+task :extension => :default
 
 desc 'Show contents of some variables related to website doc generation.'
 task :explain_website do
@@ -93,6 +109,7 @@ end
 desc 'Upload the newly-built site to RubyForge.'
 task :upload_website => [:gen_website] do
     sh "scp website/*.html hoanga@rubyforge.org:/var/www/gforge-projects/ruby-opengl"
+    sh "scp website/images/* hoanga@rubyforge.org:/var/www/gforge-projects/ruby-opengl/images/"
 end
 
 desc 'Upload entire site, including stylesheet and the images directory.'
@@ -102,28 +119,38 @@ task :upload_entire_website => [:gen_website] do
     sh "scp -r website/images hoanga@rubyforge.org:/var/www/gforge-projects/ruby-opengl"
 end
 
+desc 'Runs unit tests.'
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/tc_*.rb']
+    t.verbose = true
+end
+
+desc 'Runs unit tests.'
+task :test_all => [:test]
+
 # Define the files that will go into the gem
 gem_files = FileList["{lib,ext,doc,examples,test}/**/*"]
-gem_files = gem_files.exclude("**/*.so", "**/*.o", "ext/**/*.log", "ext/gl*/Rakefile")
+gem_files = gem_files.exclude("**/*.so", "**/*.o{,bj}", "ext/**/*.log", "ext/gl*/Rakefile")
 
 spec = Gem::Specification.new do |s|
     s.name              = "ruby-opengl"
-    s.version           = "0.33.0"
-    s.authors           = [ "John Gabriele", "Minh Thu Vo" ]
+    s.version           = "0.40.0"
+    s.authors           = [ "Alain Hoang", "Jan Dvorak", "Minh Thu Vo" ]
     s.homepage          = "http://opengl-ruby.rubyforge.org"
     s.platform          = Gem::Platform::RUBY
     s.summary           = "OpenGL Interface for Ruby"
     s.files             = gem_files
     s.extensions        << 'Rakefile'
-#    s.extensions        << 'ext/common/Rakefile', 'ext/gl/mkrf_conf.rb', 
-#                           'ext/glu/mkrf_conf.rb', 'ext/glut/mkrf_conf.rb']
     s.require_path      = "lib"
     s.autorequire       = "gl"
     s.has_rdoc          = false
     s.add_dependency("mkrf", ">=0.2.0")
+    s.add_dependency("rake")
 end
 
 # Create a task for creating a ruby gem
 Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.gem_spec = spec
     pkg.need_tar = true
 end

data/doc/build_install.txt

@@ -5,49 +5,94 @@ Building ruby-opengl
 Pre-requisites
 --------------
 
-On Ubuntu, aside from Ruby and the Rake gem, you'll need the following
-packages:
+Linux
+--------------
+On Ubuntu or Debian systems, aside from Ruby you'll need ruby and
+some extra ruby related packages:
+
+* `ruby rdoc ri ruby1.8-dev`
 
-* `libgl1-mesa libgl1-mesa-dri libglu1-mesa freeglut3`
+For OpenGL related headers you'll need the following packages:
+
+* `libgl1-mesa-dri libglu1-mesa freeglut3`
 * `libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev`
 
+You MUST have rubygems 0.9.1 or higher installed.  
 
-Build instructions
-------------------
+On Gentoo, Debian and ubuntu, rubygems 0.9.0 will be installed by default
+in the packages.  This version of rubygems is INCOMPATIBLE with ruby-opengl.
+You'll need to install rubygems from source.
 
-The current build setup is still under construction. When last looked at
-(late November 2006), we were waiting for
-the next mkrf release (we've patched what they have in svn, so it works,
-but their maintainer seems to have moved on and not made a release
-containing our fix). Building our ruby-opengl works, but you'll need
-the version of mkrf still in svn.
+On some distributions you may need 'xorg-dev' developer package.
 
-Once you have a mkrf in place, on unixy platforms, just run
+Mac OS X
+--------------
+On OS X, you will need to install your own version of Ruby as the
+version that ships with OS X has known problems with properly building
+ruby-opengl bindings.  You'll also need XCode for gcc and tools.  Macports
+or fink should handle this cleanly.
 
-    ./build.sh
+Windows
+--------------
+On Windows you need to have platform SDK and compiler that *must* match the one which
+was used for compiling ruby binary (for One-click ruby installer it is MSVC 6.0).
+You may also need 'glut.h' in SDK include directory, as the One-click ruby
+installer is missing it. You can copy the file from glut package at
+http://www.xmission.com/~nate/glut.html .
+
+Manual Build instructions for all platforms
+(see above for platform-specific notes)
+------------------
+1. Make sure you have working ruby with rubygems installed
+	 and (if needed) appropriate developer packages (ruby-dev,ruby1.8-dev,...).
+2. Make sure you have working C compiler
+3. Install rake either from package or by running 'gem install rake'
+4. Install mkrf (0.2.0+) either from package or by running 'gem install mkrf'
+5. Make sure you have working OpenGL installation, this includes libGL,libGLU,
+   glut and (if needed) appropriate -dev or -devel packages.
+6. Run 'rake' at the top level of the project
+7. (OPTIONAL) Run 'rake test' to run unit tests to verify it works properly
 
-to build.
+Installing
+------------------
+1. Run 'rake clean' to clean out the project
+2. Run 'rake gem' to build source gem
+3. Run 'gem install pkg/ruby-opengl-<version>.gem' to compile and install the gem
 
-After building, the extension modules are automatically copied to the
-project's `./lib` directory.
+Building binary gem
+------------------
+1. Run 'gem install gembuilder' to install the gembuilder package
+2. Run 'rake clean' to clean out the project
+3. Run 'rake gem' to build source gem
+4. Run 'gembuilder pkg/ruby-opengl-<version>.gem' to compile the binary gem
 
+Installing from rubygems
+-------------------
 
-Installing
-----------
+ruby-opengl should also support being installed via gems now.  Just
+try 'gem install -y ruby-opengl' and it should pull down the gem
+and try to build the bindings for you automatically.
 
-For now, if you want to install ruby-opengl on your system, you can
-do so manually (there is no gem, nor even a release, for it yet).
-Just copy the contents of `./lib` into your
-`.../lib/ruby/site_ruby/1.8` directory (or anywhere else `ruby`
-searches for modules).
+You MUST have rubygems 0.9.1 or higher installed for ruby-opengl
+to work properly.  0.8.x and 0.9.0 will not build ruby-opengl
+properly.
 
 
 Testing / Running
 -----------------
 
-To run a sample file:
+To run unit tests:
+
+   $ rake test
+
+Note that the tests have the adverse effect of testing the underlying OpenGL
+implementation, so depending on your GL provider,drivers or OS, the tests may
+fail, crash, or not run at all, without affecting your ability to use the
+bindings.
+
+To run a sample file, make sure the ruby-opengl gem is installed then:
 
     $ cd examples
-    $ ruby plane.rb
+    $ ruby -rubygems plane.rb
 
 Hit ESC to exit.

data/doc/history.txt

@@ -46,3 +46,7 @@ In September 2006, we stopped using SWIG. Thu and Peter began fine tuning
 Thu's original `utils/mkwrap.rb` script.
 
 Development stalled in October 2006.
+
+Development picked up again towards the end of 2006. After a long hiatus 
+and getting a new release of mkrf out the door.  ruby-opengl is proud
+to put out version 0.33.0 as a gem for everyone to try out.

data/doc/requirements_and_design.txt

@@ -124,8 +124,7 @@ to use standard OpenGL-style constant and function names.
 
 ### Build environment ###
 
-The build environment will:
+The build environment will use:
 
-* use rake and mkrf. (note -- development of mkrf seems to have
-  stalled)
+* use rake and mkrf. 
 * minimize the number of additional tools required

data/doc/roadmap.txt

@@ -1,10 +1,23 @@
 Roadmap
 =======
 
-* Get BaseGL updated.
-* Get BaseGLU updated.
+* Ensure support for 2.0 and 2.1 is solid 
+* Make sure OpenGL 1.0 and 1.1 are solidly supported
+* Continue testing 1.2+ support
+* Create a set of test images for functional test comparison
 * Get BaseGLUT updated.
+* Add RDoc documentation comments to C API
+* Make sure this can build cleanly under Windows under the current
+  build system.
 * Add the ESC keyboard handler to smooth.rb
+* Add all of Yoshi's examples into examples
+* Create more example code
+* Write a getting started tutorial
+
+
+Possible Features
+========
+* Possibly port GLU to use Ruby/DL
 
 <br/>
 <br/>

data/doc/screenshots.txt

@@ -0,0 +1,23 @@
+ruby-opengl screenshots
+=======================
+
+Currently the screenshots are a little barren but here are some
+renders from the interactive test suite in ruby-opengl
+
+interactive test screenshots
+============================
+
+<img src="images/GLtest_1_vertex_color.png" />
+<br />
+<img src="images/GLtest_2_rasterpos_bitmap.png" />
+<br />
+<img src="images/GLtest_3_displaylists_matrixops.png" />
+<br />
+<img src="images/GLtest_4_textureops.png" />
+<br />
+<img src="images/GLtest_5_polygonops.png" />
+<br />
+<img src="images/GLtest_6_textureops_2.png" />
+<br />
+<img src="images/GLtest_7_light_material.png" />
+<br />

data/doc/supplies/page_template.html

@@ -17,6 +17,7 @@
 	<ul id="tabnav">
 		<li><a href="./index.html">Home</a></li>
 		<li><a href="./tutorial.html">Tutorial</a></li>
+		<li><a href="./screenshots.html">Screenshots</a></li>
 		<li><a href="./requirements_and_design.html">Req's doc</a></li>
 		<li><a href="./build_install.html">Build/Install</a></li>
 		<li><a href="./history.html">History</a></li>
@@ -53,7 +54,7 @@
 	</div>
 	<div id="footer">
 	<p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0</a> |
-    Copyright &copy; <a href="#">John M. Gabriele</a> |
+    Copyright &copy; <a href="#">Alain Hoang</a> |
     Design by <a href="http://www.jdavidmacor.com">super j man</a></p>
 	</div>
 	

data/doc/thanks.txt

@@ -8,6 +8,9 @@ by first name) also goes to:
 * Ilmari Heikkinen -- provided code for changing how users can call method and constant names.
 * James Adam -- Mac OS X fixes
 * Tony Hursh -- Mac OS X glut build tweak
+* Sean Long -- More Mac OS X fixes
+* John Gabriele -- Numerous fixes, documentation, and project support
+* Jan Dvorak -- Patches to start OpenGL 2.1 support 
 * **Yoshi** -- providing ruby-opengl-0.32g from which to work off of.
 
 

data/doc/tutorial.txt

@@ -24,6 +24,10 @@ You don't have to `include` Gl, Glu, and Glut, but if you don't, then
 you'll have to prefix each of those method and constant names like so:
 
     {{ruby}}
+    require 'gl'
+    require 'glu'
+    require 'glut'
+
     Gl.glFooBar( Gl::GL_FOO_BAR )
     Glu.gluFooBar( Glu::GLU_FOO_BAR )
     Glut.glutFooBar( Glut::GLUT_FOO_BAR )
@@ -32,9 +36,7 @@ The other way you might use ruby-opengl is to employ the notation that
 users of previous versions of ruby-opengl have used:
 
     {{ruby}}
-    require 'gl_prev'
-    require 'glu_prev'
-    require 'glut_prev'
+    require 'opengl'
     
     GL.FooBar( GL::FOO_BAR )
     GLU.FooBar( GLU::FOO_BAR )

data/examples/README

@@ -22,15 +22,65 @@ at the top of your files instead of
     require 'opengl'
     require 'glut'
 
-(Of course, if you haven't yet installed ruby-opengl on your system, you'll
-need to include paths in those require statments above: as in,
-`require "../lib/gl_prev"`.)
+For examples of using the legacy code look at the directory legacy/ for
+lots of example code that was borrowed from Yoshi's examples
 
 
 Status of examples
 ------------------
 
-* plane.rb -- works
-* smooth.rb, smooth_prev.rb -- works
-* aaindex.rb  -- does not seem to work
-* test.rb  -- does not seem to work
+* plane.rb -- works (Should show a picture of a planar surface)
+* smooth.rb -- works
+* test.rb -- works
+
+Status of legacy examples
+-------------------------
+
+* aaindex.rb -- does not seem to work
+* aapoly.rb -- works
+* aargb.rb -- works
+* accanti.rb -- does not seem to work
+* accpersp.rb -- does not seem to work
+* alpha3D.rb -- works
+* alpha.rb -- works
+* bezcurve.rb -- works
+* bezmesh.rb -- works
+* checker.rb -- works
+* clip.rb -- works
+* colormat.rb -- works
+* cube.rb -- works
+* depthcue.rb -- works
+* smooth.rb -- works
+* dof.rb -- works
+* double.rb -- works
+* drawf.rb -- works
+* feedback.rb -- seems to work
+* fog.rb -- works
+* font-glut.rb -- works
+* font.rb -- works
+* hello.rb -- works
+* image.rb -- works
+* lines.rb -- works
+* list.rb -- works
+* material.rb -- works
+* mipmap.rb -- works
+* model.rb -- works
+* movelight.rb -- works
+* pickdepth.rb -- works
+* planet.rb -- works
+* quadric.rb -- works
+* readpixel.rb -- does not seem to work
+* robot.rb -- seems to work
+* select.rb -- works
+* smooth.rb -- works
+* stencil.rb -- works
+* stroke.rb -- works
+* surface.rb -- works
+* teaambient.rb -- works
+* teapots.rb -- works
+* tess.rb -- does not seem to work
+* texbind.rb -- works
+* texgen.rb -- works
+* texturesurf.rb -- works
+* varray.rb -- works
+* wrap.rb -- works

data/examples/legacy/COPYRIGHT

@@ -0,0 +1,8 @@
+Copyright (c) 2004 yoshi@giganet.net
+
+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/examples/{aaindex.rb → legacy/aaindex.rb}

@@ -1,9 +1,10 @@
-require "../ext/gl/GL"
-require "../ext/glut/GLUT"
+#!/usr/bin/env ruby -rubygems
+#require "gl"
+#require "glut"
 require "rational"
 
-require "../lib/gl_prev"
-require "../lib/glut_prev"
+require "gl_prev"
+require "glut_prev"
 
 RAMPSIZE=16
 RAMP1START=32
@@ -42,7 +43,7 @@ display = Proc.new {
    GL.End
    GL.PopMatrix();
 
-   GL.Indexi(RAMP2START);
+  # GL.Indexi(RAMP2START);
    GL.PushMatrix();
    GL.Rotate($rotAngle, 0.0, 0.0, 0.1);
    GL.Begin(GL::LINES);