shattered_ogrerb 0.5.0.2 → 0.5.1

data/lib/shattered_ogrerb.rb

@@ -1,9 +1,15 @@
-
+require File.dirname(__FILE__) + '/../vendor/ogrerb/platform'
 # adds dll search paths
 def add_dll_paths(*directories)
 	directories.each do |dir|
 		absolute_path = File.expand_path(File.dirname(__FILE__)+"/../vendor/#{dir}/")
-		ENV["path"] += ";#{absolute_path};"
+		#TODO: This might be a ruby version issue instead of a platform issue
+		# but in Mac PATH is capitalized
+		unless Platform.mac?
+		  ENV["path"] += ";#{absolute_path};"
+	  else
+      ENV["PATH"] += ";#{absolute_path};"
+    end
 		$:.unshift(absolute_path)
 	end
 end

data/lib/shattered_ogrerb/camera.rb

@@ -1,6 +1,14 @@
 module Ogre
-	class Camera
-		alias_method :position, :get_position
-		alias_method :position=, :set_position
-	end
+  class Camera    
+  
+  	alias_method :raw_look_at, :look_at
+  	
+  	# Look at an object
+  	# You can send it a node, mesh, or anything with a position vector
+  	# Or just a vector
+  	def look_at(v)
+  		v = v.position if v.class.respond_to? :position
+  		raw_look_at v.to_v
+  	end
+  end
 end

data/lib/shattered_ogrerb/mesh_instance.rb

@@ -11,73 +11,35 @@ module Ogre
 	# are not delegated respectfully.
 	class MeshInstance < SimpleDelegator
 		attr_reader :node, :entity
-		def initialize(parent, scene_manager, mesh_name)
+		def initialize(parent, scene_manager, mesh_name, options={})
 			@@entity_count ||= 0
 			@node = parent.create_child_scene_node
 			# formats to '#<SceneManager:???>.entity(0)'
-			@entity = scene_manager.create_entity("#{scene_manager.to_s}.entity(#{@@entity_count})", mesh_name)
+			@entity = options[:entity] || scene_manager.create_entity("#{scene_manager.to_s}.entity(#{@@entity_count})", mesh_name)
+	
 			@node.attach_object(@entity)
 			@@entity_count += 1
 			# delegate all unknown methods to the entity object
 			__setobj__(@entity)
 		end
 		
-		# Node delegates
-		{
-			:position => :get_position,
-			:position= => :set_position,
-			:direction= => :set_direction,
-			:orientation= => :set_orientation,
-			:orientation => :get_orientation,
-			:scale => :get_scale,
-			:translate! => :translate
-		}.each do |method, delegate|
-			define_method(method) do |*args|
-				node.send(delegate, *args)
+		[
+		  :position,
+			:position=,
+			:direction=,
+			:orientation=,
+			:orientation,
+			:scale,
+			:translate!,
+		  :rotate,
+		  :scale=,
+		  :scale!,
+		  :look_at
+		].each do |method|
+		  define_method(method) do |*args|
+				node.send(method, *args)
 			end
-		end
-		
-		# rotate works in degrees by default, and in the TS_lOCAL space
-		def rotate(axis, amount, *args)
-			if(args.empty?)
-				node.rotate(axis, Radian.new(Degree.new(amount)))
-			else
-				node.rotate(axis,Radian.new(Degree.new(amount)), args[0])
-			end
-		end
-		
-		# scale= works with numbers, vectors, or 3 numbers and is absolute
-		def scale=(*args)
-			v = args
-			
-			# This handles calling scale=0.5 or some other number
-			v = v(v[0], v[0], v[0]) if v[0].is_a? Numeric
-			
-			node.set_scale(*v)
-		end
-		
-		#scale! works with numbers, vectors, or 3 numbers and is relative
-		def scale!(*args)
-			v = args
-			
-			# This handles calling scale=0.5 or some other number
-			v = v(v[0], v[0], v[0]) if v[0].is_a? Numeric
-			
-			node.scale(*v)
-		end
-		
-		# Look at an object
-		# This function is different than the one in the Ogre SDK because
-		# it defaults to TS_LOCAL as the transform space
-		# You can send it a node, mesh, or anything with a position vector
-		# Or just a vector
-		def look_at(*args)
-			transform = Ogre::Node::TS_LOCAL
-			transform = args[1] if(args.length == 2)		
-			v = args[0]
-			v = args[0].position if args[0].class.respond_to? :position
-			node.look_at v, transform
-		end
+	  end
 		
 		#Entity delegates that map differently
 		def visible=(v)
@@ -98,4 +60,7 @@ module Ogre
 	  end
 		
 	end	
+	
+	class LightInstance < MeshInstance
+  end
 end

data/lib/shattered_ogrerb/rgb.rb

@@ -0,0 +1,6 @@
+class Object
+  # rgb(0,0,0) is a shorthand for creating colours in Ogre.
+  def rgb(r,g,b)
+    Ogre::ColourValue.new(r,g,b)
+  end
+end

data/lib/shattered_ogrerb/scene_node.rb

@@ -0,0 +1,73 @@
+module Ogre
+  module NodeMovements
+    def self.redefine_methods(c)
+      c.class_eval do
+        # Node delegates
+    		{
+    			:position => :get_position,
+    			:position= => :set_position,
+    			:direction= => :set_direction,
+    			:orientation= => :set_orientation,
+    			:orientation => :get_orientation,
+    			:translate! => :translate,
+    		}.each do |method, delegate|
+    			define_method(method) do |*args|
+    				send(delegate, *args)
+    			end
+    		end
+    		
+     	end
+  	end
+  end
+  
+  NodeMovements.redefine_methods(SceneNode)
+  NodeMovements.redefine_methods(Camera)
+  
+  class SceneNode
+    alias_method :raw_rotate, :rotate
+    
+    # rotate works in degrees by default, and in the TS_lOCAL space
+  	def rotate(axis, amount, *args)
+  		if(args.empty?)
+  		  raw_rotate(axis.to_v, Radian.new(Degree.new(amount)))
+  		else
+  			raw_rotate(axis.to_v, Radian.new(Degree.new(amount)), args[0])
+  		end
+  	end
+  
+  	alias_method :raw_look_at, :look_at
+  	
+  	# Look at an object
+  	# This function is different than the one in the Ogre SDK because
+  	# it defaults to TS_LOCAL as the transform space
+  	# You can send it a node, mesh, or anything with a position vector
+  	# Or just a vector
+  	def look_at(*args)
+  		transform = Ogre::Node::TS_LOCAL
+  		transform = args[1] if(args.length == 2)		
+  		v = args[0]
+  		v = args[0].position if args[0].class.respond_to? :position
+  		raw_look_at v, transform
+  	end
+  	  	    		
+		# scale= works with numbers, vectors, or 3 numbers and is absolute
+		def scale=(*args)
+			v = args
+			
+			# This handles calling scale=0.5 or some other number
+			v = v(v[0], v[0], v[0]) if v[0].is_a? Numeric
+			
+			set_scale(*v)
+		end
+		
+		#scale! works with numbers, vectors, or 3 numbers and is relative
+		def scale!(*args)
+			v = args
+			
+			# This handles calling scale=0.5 or some other number
+			v = v(v[0], v[0], v[0]) if v[0].is_a? Numeric
+			
+			scale(*v)
+		end
+  end
+end

data/lib/shattered_ogrerb/vector.rb

@@ -82,7 +82,7 @@ class Vector3
 	# Iterate through x, y and z with a block.  The passed value is the value of each component of 
 	# the vector.
 	def each(&block)
-		self.to_a.each do |component|
+		[x,y,z].each do |component|
 			yield component
 		end
 	end
@@ -92,11 +92,12 @@ class Vector3
 		self
 	end
 	
-	# Returns an array with x, y and z dumped into its elements.
+	# Returned an array with x, y and z dumped into its elements.
 	#   v(1, 2, 3).to_a #=> [1.0, 2.0, 3.0]
-	def to_a
-		[x, y, z]
-	end
+	# Deprecated because *v(0,0,0) is [0,0,0] (three arguments) and breaks DSLs
+	#def to_a
+	#	raise "Vector#to_a is deprecated.  Use vectors as vectors, not as arrays."
+	#end
 	
 	# Add 2 Vectors together.
 	#   v(1,1,1) + v(1,2,3) #=> v(2,3,4)

data/vendor/ogrerb/README

@@ -47,11 +47,17 @@ The resulting files can be found in ogrerb/lib.
 
 rake build_all
 
-The resulting frameworks will be located in ogrerb/lib.
+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 
 
 ==== Setup your environment

data/vendor/ogrerb/Rakefile

@@ -4,11 +4,18 @@ 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"
 
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
 ###########################
 # Project Managment tasks #
 ###########################
@@ -107,13 +114,6 @@ end
 #############################
 # Project compilation tasks #
 #############################
-
-desc "Rebuild the OGRE and OIS wrappers. Does not work on Windows."
-task :build_all => ["ogre:build", "ois:build"]
-
-desc "Clean everything"
-task :clean_all => ["ogre:clean", "ois:clean"]
-
 desc "Build rubyw on the mac platform, needed for ogrerb to run properly."
 task :build_mac_rubyw do
   if Platform.mac?
@@ -123,186 +123,67 @@ task :build_mac_rubyw do
   end
 end
 
-namespace :ois do
-  desc "Rebuild all of the OIS wrapper. Does not work on Windows."
-  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"
-			elsif Platform.mac?
-			  sh "make all"
-			  resulting_file = "ruby_ois.bundle"
-			  build_file = "ruby_ois.bundle"
-		  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
-  end
-end
-
-namespace :ogre do
-
-  desc "Rebuild all of ogre.rb. Does not work on Windows."
-  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"
-		build_file = resulting_file
-	  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"
-			elsif Platform.mac?
-			  sh "make clean all"
-			  resulting_file = "ogre.bundle"
-			  build_file = "ogre.bundle"			  
-		  else
-				raise "Error: Unsupported platform " + PLATFORM
-			end
-  	  cp build_file, 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