ogre.rb 0.1-i686-linux → 0.2-i686-linux

data/README

@@ -4,7 +4,7 @@ Welcome to Ogre.rb, the Ruby wrapper around the Ogre rendering engine. This curr
 known to build and run correctly on Linux, though I expect this will work just fine on Mac as well. 
 Windows support will come later.
 
-Ogre.rb is currently built for Ruby 1.8.5+ and Ogre 1.4.x (Eihort)
+Ogre.rb is currently built for Ruby 1.8.5+ and Ogre 1.4.4 (Eihort)
 
 == Usage
 
@@ -24,13 +24,12 @@ The samples/ directory is a direct port of the Ogre sample programs.
 == Contributing 
 
 Please post patches, feature requests, bug fixes to the rubyforge website at http://rubyforge.org/projects/ogrerb.
-As I'm not sure exactly how to unit test such a wrapper, it will be greatly appreciated if changes are proven as
-part of a sample application.
+All patches will be considered but those with tests, if possible, are recommended. 
 
 == Build Requirements 
 
    * rake
-   * Ogre 1.4.x (Eihort)
+   * Ogre 1.4.4 (Eihort)
    * OIS
    * swig 1.3.31+ (uses -autorename)
    * pkg-config (Linux) 
@@ -45,7 +44,18 @@ The resulting files can be found in ogrerb/lib.
 
 === Mac
 
-TODO
+rake build_all
+
+If you get an error about OIS framework not being installed, you can download a build of the OIS framework here:  http://www.shatteredruby.com/support/OIS.1.0.framework.zip.*  Place it into your /Library/Frameworks directory.
+
+After building, the resulting frameworks will be located in ogrerb/lib.
+
+You will need to run the build_mac_rubyw Rake task, which creates a rubyw executable that's fit for opening
+up windows in the foreground. See http://rubyforge.org/forum/forum.php?thread_id=15371&forum_id=14174 for details.
+
+Remember once you do this to start ogrerb programs with 'rubyw' instead of 'ruby', otherwise keyboard input will be disabled.
+
+*The OIS framework is made by wreckedgames.com, and the sourceforge project page is here: http://sourceforge.net/projects/wgois.  The build in this document is for convenience only and is not an official release.
 
 === Windows 
 
@@ -77,3 +87,31 @@ The resulting files can be found in ogrerb/lib.
 == Running Ogre.rb programs
 
 You'll either have to copy the OgreMain dll to the ogrerb/lib folder, or you'll need to set the PATH (on Windows) or LD_LIBRARY_PATH (on Linux) environment variable to point to where this file is ([OgreSDK]/bin/release for prebuilt). Then, it's simply <code>require 'ogre'</code> and off you go.
+
+== Testing Ogre.rb programs
+
+test/test_helper.rb contains the minimum needed setup for Ogre to properly allow testing of it's components. 
+
+== Notes
+
+These are the classes currently not wrapped for various reasons:
+
+* OgreConfigDialog
+* OgreConfig
+* OgreConfigOptionMap
+* OgreErrorDialog
+* OgreException
+* OgreProfiler
+* OgreStringConverter
+* OgreZip
+* OgreAlignedAllocator
+* OgreBitwise
+* OgreMemoryManager
+* OgreFileSystem
+* OgreUnifiedHighLevelGpuProgram
+* OgreSearchOps
+* OgreStableHeaders
+* OgreUTFString
+* OgreILCodecs
+* OgreILImageCodec
+* OgreILUtil

data/Rakefile

@@ -4,10 +4,17 @@ require 'rake/contrib/sshpublisher'
 require 'rake/gempackagetask'
 
 require 'platform'
+require 'lib/rake/project_builder'
 
-task :default => :build_all
+task :default => :test
 
-OGRE_RB_VERSION = "0.1"
+OGRE_RB_VERSION = "0.2"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
 
 ###########################
 # Project Managment tasks #
@@ -55,6 +62,7 @@ ogre_rb_spec = Gem::Specification.new do |s|
 	if Platform.windows?
 		lib_files = %w(lib/ogre.dll lib/ruby_ois.dll)	
 	elsif Platform.mac?
+	  lib_files = %w(lib/ogre.bundle lib/ruby_ois.bundle)
 	else # Posix environment
 		lib_files = %w(lib/ogre.so lib/ruby_ois.so)
 	end
@@ -74,14 +82,14 @@ ogre_rb_spec = Gem::Specification.new do |s|
 	s.required_ruby_version = '>= 1.8.4'
 
 	# Inform of the need to have Ogre installed and OGRE_HOME set
-	s.requirements << "Ogre Einhort (1.4)"
+	s.requirements << "Ogre Einhort (1.4.4)"
 	s.requirements << "Environment variable OGRE_HOME set"
 
   #s.has_rdoc = false
   #s.extra_rdoc_files += RDOC_INCLUDES
   #s.rdoc_options += RDOC_OPTIONS
 
-  files = FileList.new %W[
+  files = FileList.new %w(
 		README
 		platform.rb
 		ogre.rb
@@ -89,7 +97,11 @@ ogre_rb_spec = Gem::Specification.new do |s|
 		lib/*.rb
 		samples/**/*
 		doc_src/**/*	
-  ]
+		test/**/*
+  ) do |fl|
+ 		fl.exclude(/navi/)
+	end
+
 	files += lib_files
 
 	s.files = files
@@ -98,191 +110,81 @@ end
 desc 'Package as gem & zip'
 Rake::GemPackageTask.new(ogre_rb_spec) do |p|
   p.gem_spec = ogre_rb_spec
-  #p.need_tar = true
-  #p.need_zip = true
 end
 
 #############################
 # Project compilation tasks #
 #############################
-
-desc "Rebuild the OGRE and OIS wrappers"
-task :build_all => ["ogre:build", "ois:build"]
-
-desc "Clean everything"
-task :clean_all => ["ogre:clean", "ois:clean"]
-
-namespace :ois do
-  desc "Rebuild all of the OIS wrapper"
-  task :build => [:swig, :compile]
-
-  desc "Run swig on the interface files"
-  task :swig do
-    includes = %w(-I./src_headers/OIS -I./src_headers/wrappers)
-    sh "swig -ruby -minherit -c++ -autorename #{includes.join(' ')} -o build/ois/ois_wrap.cpp ois/ois.i" 
-    if Platform.windows?
-    	insert_headers("build/ois/ois_wrap.cpp") do
-    		<<-EOF
-    			#include "OIS.h"
-    		EOF
-    	end
-  	end
-  end
-
-  desc "Compile the extension and move the resulting library into lib/"
-  task :compile do
-		resulting_file = "ruby_ois.so"
-		build_file = resulting_file
-	  cd "build/ois" do
-	    ruby "extconf.rb"
-	  	if Platform.linux? 
-		    sh "make all"
-		  elsif Platform.windows?
-				sh "nmake"
-				# Create our manifest (see http://www.codeproject.com/cpp/vcredists_x86.asp)
-				sh "mt.exe /manifest #{resulting_file}.manifest /outputresource:#{resulting_file};#2"
-				resulting_file = "ruby_ois.dll"
-				build_file = "ruby_ois.so"
-			else
-				raise "Error: Unsupported platform " + PLATFORM
-			end
-  	  cp build_file, File.join("..", "..", "lib", resulting_file)
-  	end
-  end
-
-  desc "Clean up the build environment"
-  task :clean do
-    cd "build/ois" do
-      ruby "extconf.rb"
-      sh "make clean"
-      rm "mkmf.log" rescue nil
-    end
+desc "Build rubyw on the mac platform, needed for ogrerb to run properly."
+task :build_mac_rubyw do
+  if Platform.mac?
+    sh "ruby=`which ruby`; rubyw=${ruby}w; sudo cp $ruby $rubyw; sudo /Developer/Tools/Rez -t APPL Carbon.r -o $rubyw"
+	else
+		puts "This is only to be run on Mac OS X"
   end
 end
 
-namespace :ogre do
-
-  desc "Rebuild all of ogre.rb"
-  task :build => [:swig, :compile]
-
-  desc "Run swig on the interface files"
-  task :swig do
-    includes = %w(-I./src_headers/OGRE -I./src_headers/ExampleApplication -I./src_headers/wrappers -I./src_headers/OIS)
-    sh "swig -ruby -minherit -c++ -autorename #{includes.join(' ')} -o build/ogre/ogre_rb_wrap.cpp ogre/ogre_rb.i" 
+#############################################
+# Project registration helpers documentation:
+#
+# project.swig_file => 				 
+# 	The name of the main swig interface file (sans .i) (default: project name)
+#
+# project.swig_includes => 		 
+# 	The include declarations needed for this project to swigify
+#
+# project.swig =>							 
+# 	Create a block that gets called after swig is done running, for post processing
+#
+# project.resulting_library => 
+# 	The final name of the built library (default: project name)
+#
+#
+# TODO Looks like I can pull the swig block into the template, as all projects seem
+# to need this STL fix
+#############################################
+
+register_project :ogre do |project|
+	project.swig_file = "ogre_rb"
+	project.swig_includes = %w(-I./src_headers/OGRE -I./src_headers/wrappers -I./src_headers/OIS)
+	project.swig do
     if Platform.windows?
     	# compensate for windows stl.  Uses wrong version when ruby is first.
     	insert_headers("build/ogre/ogre_rb_wrap.cpp") do
     		<<-EOF
 					#include "Ogre.h"
-					#{Platform.windows? ? "#include <winsock.h>" : ""}
+					#include <winsock.h>
 				EOF
   		end
     end
-  end
+	end
+end
 
-  desc "Compile the extension and move the resulting library into lib/"
-  task :compile do
-		resulting_file = "ogre.so"
-	  cd "build/ogre" do
-	    ruby "extconf.rb"
-	  	if Platform.linux? 
-		    sh "make clean all"
-		  elsif Platform.windows?
-				sh "nmake"
-				# Create our manifest (see http://www.codeproject.com/cpp/vcredists_x86.asp)
-				sh "mt.exe /manifest ogre.so.manifest /outputresource:ogre.so;#2"
-				resulting_file = "ogre.dll"
-			else
-				raise "Error: Unsupported platform " + PLATFORM
-			end
-  	  cp "ogre.so", File.join("..", "..", "lib", resulting_file)
+register_project :ois do |project|
+	project.resulting_library = "ruby_ois"
+	project.swig_includes = %w(-I./src_headers/OIS -I./src_headers/wrappers)
+	project.swig do 
+    if Platform.windows?
+    	insert_headers("build/ois/ois_wrap.cpp") do
+    		<<-EOF
+    			#include "OIS.h"
+    		EOF
+    	end
   	end
-  end
-
-  desc "Clean up the build environment"
-  task :clean do
-    cd "build/ogre" do
-      ruby "extconf.rb"
-      sh "make clean"
-      rm "mkmf.log" rescue nil
-    end
-  end
-
-  desc "Copy over the ogre header files from an ogre installation. Expects OGRE_HOME to be set."
-  task :update_headers do
-    raise "Unable to find Ogre headers, please set OGRE_HOME to the distribution path" if ENV['OGRE_HOME'].nil? 
-
-    File.cp_r "#{ENV['OGRE_HOME']}/include/OGRE/", "#{File.dirname(__FILE__)}/src_headers"
-  end
-
-  desc "Create default interface files for each of the ogre headers" 
-  task :create_interfaces do
-    headers_match = File.join("src_headers", "OGRE", "Ogre*.h")
-    ogre_headers = Dir[headers_match]
-
-    ogre_headers.each do |header|
-      filename = File.basename(header, ".h")
-      interface_file_name = File.join("ogre", File.basename(header, ".h") + ".i")
-      raise "Interface file for #{filename} already exists" if File.exists?(interface_file_name)
-
-      File.open(interface_file_name, "w+") do |file|
-        file.write <<END
-%{
-  #include "#{filename}.h"
-%}
-
-%include "#{filename}.h"
-END
-      end
-    end
-  end
+	end
 end
 
-
-namespace :navi do
-
-  desc "Rebuild all of navi.rb"
-  task :build => [:swig, :compile]
-
-  desc "Run swig on the interface files"
-  task :swig do
-    includes = %w(-I./src_headers/navi -I./src_headers/wrappers)
-    sh "swig -autorename -ruby -minherit -c++ #{includes.join(' ')} -o build/navi/navi_rb_wrap.cpp navi/navi_rb.i" 
+register_project :navi do |project|
+	project.swig_file = "navi_rb"
+	project.swig_includes = %w(-I./src_headers/navi -I./src_headers/wrappers)
+	project.swig do
     if Platform.windows?
-    	# compensate for windows stl.  Uses wrong version when ruby is first.
-    	
     	insert_headers("build/navi/navi_rb_wrap.cpp") do
     		<<-EOF
 					#include "Ogre.h"
-					#{Platform.windows? ? "#include <winsock.h>" : ""}
+					#include <winsock.h>
 				EOF
   		end
     end
-  end
-
-  desc "Compile the extension and move the resulting library into lib/"
-  task :compile do
-		resulting_file = "navi.dll"
-	  cd "build/navi" do
-	    ruby "extconf.rb"
-	  	if Platform.windows?
-				sh "nmake"
-				# Create our manifest (see http://www.codeproject.com/cpp/vcredists_x86.asp)
-				sh "mt.exe /manifest navi.so.manifest /outputresource:navi.so;#2"
-			else
-				raise "Error: Unsupported platform " + PLATFORM
-			end
-  	  cp "navi.so", File.join("..", "..", "lib", resulting_file)
-  	end
-  end
-
-  desc "Clean up the build environment"
-  task :clean do
-    cd "build" do
-      ruby "extconf.rb"
-      sh "make clean"
-      rm "mkmf.log" rescue nil
-    end
-  end
-
+	end
 end

data/lib/application.rb

@@ -53,7 +53,8 @@ module Ogre
 
 			destroy_scene
 
-			@frame_listener.shutdown
+		ensure
+			@frame_listener.shutdown if @frame_listener
 		end
 
 		protected

data/lib/application_frame_listener.rb

@@ -111,7 +111,7 @@ module Ogre
 			# Most likely won't have a joystick here, so just throw away any exceptions
 			@joy_stick = nil
 			begin
-				@joy_stick = @input_manager.create_input_object( OIS::OISJoyStick, buffered_joy)
+				@joy_stick = @input_manager.create_input_object( OIS::OISJoyStick, buffered_joy) unless Platform.mac?
 			rescue
 			end
 
@@ -177,12 +177,12 @@ module Ogre
 
 			# Turn Right
 			if @keyboard.key_down?(OIS::KC_RIGHT)
-				@camera.yaw(-@rot_scale)
+				@camera.yaw( Degree.new(-@rot_scale) )
 			end
 
 			# Turn Left
 			if @keyboard.key_down?(OIS::KC_LEFT)
-				@camera.yaw(@rot_scale)
+				@camera.yaw( Degree.new(@rot_scale) )
 			end
 
 			# Quit
@@ -279,24 +279,24 @@ module Ogre
 		protected
 
 		def update_stats
-			gui_avg = OverlayManager.instance.get_overlay_element("Core/AverageFps")
-			gui_curr = OverlayManager.instance.get_overlay_element("Core/CurrFps")
-			gui_best = OverlayManager.instance.get_overlay_element("Core/BestFps")
-			gui_worst = OverlayManager.instance.get_overlay_element("Core/WorstFps")
-			gui_tris = OverlayManager.instance.get_overlay_element("Core/NumTris")
-			gui_batches = OverlayManager.instance.get_overlay_element("Core/NumBatches")
-			gui_debug = OverlayManager.instance.get_overlay_element("Core/DebugText")
+			@gui_avg ||= OverlayManager.instance.get_overlay_element("Core/AverageFps")
+			@gui_curr ||= OverlayManager.instance.get_overlay_element("Core/CurrFps")
+			@gui_best ||= OverlayManager.instance.get_overlay_element("Core/BestFps")
+			@gui_worst ||= OverlayManager.instance.get_overlay_element("Core/WorstFps")
+			@gui_tris ||= OverlayManager.instance.get_overlay_element("Core/NumTris")
+			@gui_batches ||= OverlayManager.instance.get_overlay_element("Core/NumBatches")
+			@gui_debug ||= OverlayManager.instance.get_overlay_element("Core/DebugText")
 
 			stats = @window.get_statistics
 
-			gui_curr.set_caption("Current FPS: #{"%.3f" % stats.last_fps}")
-			gui_avg.set_caption("Average FPS: #{"%.3f" % stats.avg_fps}")
-			gui_best.set_caption("Best FPS: #{"%.3f" % stats.best_fps}")
-			gui_worst.set_caption("Worst FPS: #{"%.3f" % stats.worst_fps}")
-			gui_tris.set_caption("Triangle Count: #{stats.triangle_count}")
-			gui_batches.set_caption("Batch Count: #{stats.batch_count}")
+			@gui_curr.set_caption("Current FPS: #{"%.3f" % stats.last_fps}")
+			@gui_avg.set_caption("Average FPS: #{"%.3f" % stats.avg_fps}")
+			@gui_best.set_caption("Best FPS: #{"%.3f" % stats.best_fps}")
+			@gui_worst.set_caption("Worst FPS: #{"%.3f" % stats.worst_fps}")
+			@gui_tris.set_caption("Triangle Count: #{stats.triangle_count}")
+			@gui_batches.set_caption("Batch Count: #{stats.batch_count}")
 
-			gui_debug.set_caption("#{@debug_text}")
+			@gui_debug.set_caption(@debug_text)
 		end
 	end
 end

data/ogre.rb

@@ -6,6 +6,9 @@ $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + "/lib")
 # Ruby always looks for .so first, instead of .dll if on windows.
 # So, force .dll on windows environments
 if Platform.windows?
+  require 'env'
+  
+  ENV["path"]+=";"+File.dirname(__FILE__)+"/../Ogre"
 	require 'lib/ogre.dll'
 	require 'lib/ruby_ois.dll'
 #	require 'lib/navi.dll'