shattered_ogrerb 0.5.0.1 → 0.5.0.2

data/lib/shattered_ogrerb/mesh_instance.rb

@@ -88,5 +88,14 @@ module Ogre
 			entity.is_visible
 		end
 		
+		# Set a material on a mesh.  You can set rmaterials or names of Ogre materials.
+		def material=(material)
+		  if(material.is_a? String)
+		    self.set_material_name(material)
+	    else
+	      self.set_material_name(material.get_name)
+      end
+	  end
+		
 	end	
 end

data/vendor/ogrerb/CHANGELOG

@@ -0,0 +1,7 @@
+* Cel-Shading demo ported, added support for SubEntities.
+
+* Mac compilation support!
+
+== 0.1 
+
+  * Initial release!

data/vendor/ogrerb/README

@@ -32,7 +32,7 @@ part of a sample application.
    * rake
    * Ogre 1.4.x (Eihort)
    * OIS
-   * swig 1.3.17+
+   * swig 1.3.31+ (uses -autorename)
    * pkg-config (Linux) 
 
 == Build Steps 
@@ -45,7 +45,12 @@ The resulting files can be found in ogrerb/lib.
 
 === Mac
 
-TODO
+rake build_all
+
+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.
 
 === Windows 
 

data/vendor/ogrerb/Rakefile

@@ -1,21 +1,34 @@
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/contrib/sshpublisher'
+require 'rake/gempackagetask'
 
 require 'platform'
 
 task :default => :build_all
 
+OGRE_RB_VERSION = "0.1"
+
 ###########################
 # Project Managment tasks #
 ###########################
 
+RDOC_INCLUDES = %w(
+	README
+	doc_src/**/*.rb
+	lib/application.rb
+	lib/application_frame_listener.rb
+	lib/application_loading_bar.rb
+	lib/constants.rb
+	lib/method_fixes.rb
+)
+
+RDOC_OPTIONS = ['-S', '-t Ogre.rb Documentation']
+
 Rake::RDocTask.new do |t|
   t.main = "README"
-  t.rdoc_files.include("README", "doc_src/**/*.rb")
-	# Exclude for now, not going to delete. We may come back to this.
-	t.rdoc_files.exclude("doc_src/application.rb", "doc_src/application_frame_listener.rb")
-	t.rdoc_files.include("samples/application.rb", "samples/application_frame_listener.rb")
+	t.rdoc_files.include(RDOC_INCLUDES)
+	t.options += RDOC_OPTIONS
 end
 
 RUBYFORGE_USERNAME = "jameskilton"
@@ -33,19 +46,85 @@ task :upload_web => :rdoc  do |t|
   rm_rf "publish"
 end
 
+## Gem Compilation ##
+ogre_rb_spec = Gem::Specification.new do |s|
+
+	s.platform = Gem::Platform::CURRENT
+
+	lib_files = ""
+	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
+
+  s.name = 'ogre.rb'
+  s.version = OGRE_RB_VERSION
+  s.summary = "Ruby wrapper for Ogre 3D"
+  s.description = %q{Ogre.rb is a SWIG wrapper to allow access to the Ogre 3D API from Ruby.}
+
+  s.author = "Jason Roelofs"
+  s.email = "jameskilton@gmail.com"
+  s.rubyforge_project = 'ogrerb'
+  s.homepage = 'http://ogrerb.rubyforge.org'
+
+  s.require_path = '.'
+
+	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 << "Environment variable OGRE_HOME set"
+
+  #s.has_rdoc = false
+  #s.extra_rdoc_files += RDOC_INCLUDES
+  #s.rdoc_options += RDOC_OPTIONS
+
+  files = FileList.new %w(
+		README
+		platform.rb
+		ogre.rb
+		Rakefile
+		lib/*.rb
+		samples/**/*
+		doc_src/**/*	
+  ) do |fl|
+ 		fl.exclude(/navi/)
+	end
+
+	files += lib_files
+
+	s.files = files
+end
+
+desc 'Package as gem & zip'
+Rake::GemPackageTask.new(ogre_rb_spec) do |p|
+  p.gem_spec = ogre_rb_spec
+end
 
 #############################
 # Project compilation tasks #
 #############################
 
-desc "Rebuild the OGRE and OIS wrappers"
+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?
+    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 :ois do
-  desc "Rebuild all of the OIS wrapper"
+  desc "Rebuild all of the OIS wrapper. Does not work on Windows."
   task :build => [:swig, :compile]
 
   desc "Run swig on the interface files"
@@ -75,7 +154,11 @@ namespace :ois do
 				sh "mt.exe /manifest #{resulting_file}.manifest /outputresource:#{resulting_file};#2"
 				resulting_file = "ruby_ois.dll"
 				build_file = "ruby_ois.so"
-			else
+			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)
@@ -94,7 +177,7 @@ end
 
 namespace :ogre do
 
-  desc "Rebuild all of ogre.rb"
+  desc "Rebuild all of ogre.rb. Does not work on Windows."
   task :build => [:swig, :compile]
 
   desc "Run swig on the interface files"
@@ -115,6 +198,7 @@ namespace :ogre do
   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? 
@@ -124,10 +208,14 @@ namespace :ogre do
 				# 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
+			elsif Platform.mac?
+			  sh "make clean all"
+			  resulting_file = "ogre.bundle"
+			  build_file = "ogre.bundle"			  
+		  else
 				raise "Error: Unsupported platform " + PLATFORM
 			end
-  	  cp "ogre.so", File.join("..", "..", "lib", resulting_file)
+  	  cp build_file, File.join("..", "..", "lib", resulting_file)
   	end
   end
 

data/vendor/ogrerb/build/ogre/extconf.rb

@@ -43,6 +43,12 @@ elsif Platform.windows?
 
 	append_ld_flags "-libpath:\"#{ENV["OGRE_HOME"]}/lib\""
 	append_ld_flags "OIS.lib"
+elsif Platform.mac?
+  #Ogre Includes from the framework
+  append_cpp_flags "-I\"/Library/Frameworks/Ogre.framework/Headers\""
+  
+  #Ogre Framework
+  append_ld_flags "-framework Ogre"
 end
 
 

data/vendor/ogrerb/build/ois/extconf.rb

@@ -42,7 +42,14 @@ elsif Platform.windows?
 	
 	append_ld_flags "-libpath:\"#{ENV["OGRE_HOME"]}/lib\""
 	append_ld_flags "OIS.lib"
-	
+
+elsif Platform.mac?
+  #OIS Includes from the framework
+  append_cpp_flags "-I\"/Library/Frameworks/OIS.framework/Headers\" -DOIS_DYNAMIC_LIB"
+  
+  #OIS Framework
+  append_ld_flags "-framework OIS"
+  
 end
 
 create_makefile('ruby_ois')

data/vendor/ogrerb/doc_src/ogre.rb

@@ -14,8 +14,8 @@
 # 
 #   scene_manager.set_sky_box(true, "CloudySky")
 #
-# I will try to document every method rename that differs from straight undercasing of Ogre method names,
-# though please post a patch if I missed one.
+# This documentation will try to cover every method rename that differs from straight undercasing of Ogre method names,
+# though please post a patch if some are missed.
 #
 module Ogre
 	# This class is here to define a few things that were difficult / not
@@ -24,7 +24,7 @@ module Ogre
 	#
 	# See OgreVector3.i for an example, but basically we need to define these manually
 	# because Ruby always passes references, which causes annoying problems such as:
-	# 
+	#
 	#   vec1 = Ogre::Vector3.ZERO
 	#   vec1.x = 10 
 	#   vec2 = Ogre::Vector3.ZERO
@@ -33,6 +33,8 @@ module Ogre
 	# Current classes with constants redefined as methods in lib/constants.rb: 
 	#
 	#   Vector3
+	#   Vector4
+	#   Quaternion
 	#
 	module Constants
 	end
@@ -97,6 +99,11 @@ module Ogre
 
 	class Singleton
 		# Renamed: getSingleton
+		#
+		# In following the Ruby-way, singletons are to be accessed as such:
+		#
+		#   MeshManager.instance.create_mesh
+		#
 		def self.instance
 		end
 	end
@@ -149,4 +156,91 @@ module Ogre
 			end
 		end
 	end
+
+	# Hardware buffers are an especially interesting problem when it comes to duplicating functionality in Ruby. 
+	# Buffers like Vertex and Index buffers are meant to be directly accessible and in a contiguous memory location.
+	# This allows the Ogre C++ code to populate these buffers as such
+	#
+	#   // position
+	#   *pReal++ = -vec.x;
+	#   *pReal++ = GRASS_HEIGHT;
+	#   *pReal++ = -vec.z;
+	#   // normal
+	#   *pReal++ = 0;
+	#   *pReal++ = 1;
+	#   *pReal++ = 0;
+	#   // uv
+	#   *pReal++ = 0;
+	#   *pReal++ = 0;
+  #
+	# Now we obviously can't do this in Ruby, so Vertex and Index Buffer proxy classes have been put together to 
+	# allow the above code to become this following in Ruby
+	#
+	#   x = i * 32
+	#   # Position
+	#   reals[x + 0] = -vec.x
+	#   reals[x + 1] = GRASS_HEIGHT
+	#   reals[x + 2] = -vec.z
+	#   # Normal
+	#   reals[x + 3] = 0
+	#   reals[x + 4] = 1	
+	#   reals[x + 5] = 0
+	#   # UV
+	#   reals[x + 6] = 0
+	#   reals[x + 7] = 0
+	#
+	# Compare the Ogre Grass demo with the Ogre.rb Grass demo to see the full code
+	class HardwareBuffer
+	end
+	
+	# See HardwareBuffer
+	class HardwareVertexBuffer < HardwareBuffer
+		# For now this should be the only lock method used. It returns a VertexBufferProxy which
+		# allows the array-like access
+		def lock(lock_options)
+		end
+	end
+
+	# See HardwareBuffer
+	class HardwareIndexBuffer < HardwareBuffer
+		# For now this should be the only lock method used. It returns an IndexBufferProxy which
+		# allows the array-like access
+		def lock(lock_options)
+		end
+	end
+
+
+	# The StaticGeometry class contains a lot of nested classes to deal with all of the parts that could possible
+	# be in a piece of static geometry. This of course poses a serious problem with wrapping as SWIG cannot handle
+	# nested classes. The solution here is to create proxy classes for all of the nested classes and use those instead.
+	# The normal API of using StaticGeometry has not changed, just the names of the classes that will be dealt with.
+	#
+	# This proxy code was taken from OgreDotNet and still needs some work to make it fit nicely into the Ruby way of
+	# doing things. If something isn't quite right, please look at OgreStaticGeometry.i and StaticGeometryProxies.h
+	# to see what methods are available.
+	#
+	# See the Grass demo for example usage.
+	class StaticGeometry
+		# Proxy for the StaticGeometry::GeometryBucket class
+		class SGGeometryBucket
+			# Returns the underlying GeometryBucket class as a Renderable object
+			def as_renderable
+			end
+		end
+
+		# Proxy for the StaticGeometry::MaterialBucket class
+		class SGMaterialBucket
+		end
+
+		# Proxy for the StaticGeometry::LODBucket class
+		class SGLODBucket
+		end
+
+		# Proxy for the StaticGeometry::Region class
+		class SGRegion
+			# Returns the underlying Region class as a MovableObject
+			def as_movable_object
+			end
+		end
+	end
 end

data/vendor/ogrerb/{samples → 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
 

data/vendor/ogrerb/{samples → lib}/application_loading_bar.rb

@@ -2,19 +2,19 @@ module Ogre
 
 	# From Ogre's ExampleLoadingBar:
 	#
-	# Defines an example loading progress bar which you can use during 
-	#	startup, level changes etc to display loading progress. 
+	# Defines an example loading progress bar which you can use during
+	# startup, level changes etc to display loading progress.
 	#
-	#	Basically you just need to create an instance of this class, call start()
-	#	before loading and finish() afterwards. You may also need to stop areas of
-	#	your scene rendering in between since this method will call 
-	#	RenderWindow::update() to update the display of the bar - we advise using
-	#	SceneManager's 'special case render queues' for this, see
-	#	SceneManager::addSpecialCaseRenderQueue for details.
-	#
-	#	This progress bar relies on you having the OgreCore.zip package already 
-	#	added to a resource group called 'Bootstrap' - this provides the basic 
-	#	resources required for the progress bar and will be loaded automatically.
+	# Basically you just need to create an instance of this class, call start()
+	# before loading and finish() afterwards. You may also need to stop areas of
+	# your scene rendering in between since this method will call
+	# RenderWindow::update() to update the display of the bar - we advise using
+	# SceneManager's 'special case render queues' for this, see
+	# SceneManager::addSpecialCaseRenderQueue for details.
+	#	
+	# This progress bar relies on you having the OgreCore.zip package already
+	# added to a resource group called 'Bootstrap' - this provides the basic
+	# resources required for the progress bar and will be loaded automatically.
 	class ApplicationLoadingBar < ResourceGroupListenerProxy
 
 		def start(window, num_groups_init = 1, num_groups_load = 1, initial_proportion = 0.7)

data/vendor/ogrerb/lib/constants.rb

@@ -32,4 +32,20 @@ module Ogre
 			Vector3.new(1, 1, 1)
 		end
 	end
+
+	class Vector4
+		def self.ZERO
+			Vector4.new(0,0,0,0)
+		end
+	end
+
+	class Quaternion
+		def self.ZERO
+			Quaternion.new(0.0,0.0,0.0,0.0)
+		end
+
+		def self.IDENTITY
+			Quaternion.new(1.0,0.0,0.0,0.0)
+		end
+	end
 end

data/vendor/ogrerb/lib/method_fixes.rb

@@ -0,0 +1,42 @@
+module Ogre
+
+	class SubMesh
+		alias_method :use_shared_vertices?, :useSharedVertices
+		alias_method :use_shared_vertices=, :useSharedVertices=
+
+		alias_method :vertex_data, :vertexData	
+		alias_method :vertex_data=, :vertexData=
+
+		alias_method :index_data, :indexData	
+		alias_method :index_data=, :indexData=
+
+		# SubMesh is a friend of Mesh, not a subclass...
+		#alias_method :shared_vertex_data, :sharedVertexData
+		#alias_method :shared_vertex_data=, :sharedVertexData=
+	end
+
+	class VertexData
+		alias_method :vertex_declaration, :vertexDeclaration
+		alias_method :vertex_declaration=, :vertexDeclaration=
+
+		alias_method :vertex_buffer_binding, :vertexBufferBinding
+		alias_method :vertex_buffer_binding=, :vertexBufferBinding=
+
+		alias_method :vertex_start, :vertexStart
+		alias_method :vertex_start=, :vertexStart=
+
+		alias_method :vertex_count, :vertexCount
+		alias_method :vertex_count=, :vertexCount=
+	end
+
+	class IndexData
+		alias_method :index_buffer, :indexBuffer
+		alias_method :index_buffer=, :indexBuffer=
+
+		alias_method :index_start, :indexStart
+		alias_method :index_start=, :indexStart=
+
+		alias_method :index_count, :indexCount
+		alias_method :index_count=, :indexCount=
+	end
+end

data/vendor/ogrerb/ogre/OgreAxisAlignedBox.i

@@ -2,4 +2,10 @@
   #include "OgreAxisAlignedBox.h"
 %}
 
+namespace Ogre {
+
+	// This was causing a linking error o_O
+	%ignore AxisAlignedBox::getCorner;
+}
+
 %include "OgreAxisAlignedBox.h"

data/vendor/ogrerb/ogre/OgreHardwareIndexBuffer.i

@@ -1,9 +1,23 @@
 %{
   #include "OgreHardwareIndexBuffer.h"
+	#include "IndexBufferProxy.h"
 %}
 
 namespace Ogre {
   %template(HardwareIndexBufferSharedPtrSWIG) SharedPtr<HardwareIndexBuffer>;
+
+	/**
+	 * Taken from pyogre, we need a special proxy object for dealing with locked
+	 * memory buffers. The normal C++ code has pointer access, and can just increment (++)
+	 * through memory. As we can't do that in Ruby, we'll proxy off the calls back
+	 * into C++
+	 */
+	%extend HardwareIndexBuffer {
+		IndexBufferProxy lock(HardwareBuffer::LockOptions options) {
+			return IndexBufferProxy(self, self->lock(options), self->getNumIndexes());
+		}
+	}
 }
 
 %include "OgreHardwareIndexBuffer.h"
+%include "IndexBufferProxy.h"

data/vendor/ogrerb/ogre/OgreHardwareVertexBuffer.i

@@ -1,10 +1,42 @@
 %{
   #include "OgreHardwareVertexBuffer.h"
+	#include "VertexBufferProxy.h"
 %}
 
 namespace Ogre {
   %template(HardwareVertexBufferSharedPtrSWIG) SharedPtr<HardwareVertexBuffer>;
+
+	/** 
+	 * Turn lists into normal Ruby arrays
+	 */
+	%typemap(out) const VertexDeclaration::VertexElementList& {
+		VALUE arr = rb_ary_new2($1->size());
+		VALUE res = Qnil;
+
+		int size = $1->size();
+		std::list<VertexElement>::iterator i = $1->begin();
+		for(; i != $1->end(); i++) {
+			res = SWIG_NewPointerObj( &(*i), SWIGTYPE_p_Ogre__VertexElement, 0);
+			rb_ary_push(arr, res);
+		}
+
+		$result = arr;
+	}
+
+	%ignore HardwareVertexBuffer::lock(LockOptions options);
+
+	/**
+	 * Taken from pyogre, we need a special proxy object for dealing with locked
+	 * memory buffers. The normal C++ code has pointer access, and can just increment (++)
+	 * through memory. As we can't do that in Ruby, we'll proxy off the calls back
+	 * into C++
+	 */
+	%extend HardwareVertexBuffer {
+		VertexBufferProxy lock(HardwareBuffer::LockOptions options) {
+			return VertexBufferProxy(self, self->lock(options));
+		}
+	}
 }
 
 %include "OgreHardwareVertexBuffer.h"
-
+%include "VertexBufferProxy.h"

data/vendor/ogrerb/ogre/OgreMaterialManager.i

@@ -17,6 +17,6 @@ namespace Ogre {
 		strcpy(buf, data.c_str());
 		MemoryDataStream *ds = new MemoryDataStream(buf, strlen(buf));
 		DataStreamPtr dsp(ds);
-		$self->parseScript(dsp, groupName);
+		self->parseScript(dsp, groupName);
 	}
 }

data/vendor/ogrerb/ogre/OgreMesh.i

@@ -6,6 +6,38 @@ namespace Ogre {
   %template(MeshSharedPtr) SharedPtr<Mesh>;
 
   %ignore Mesh::getPoseIterator;
+
+	%rename("shared_vertex_data=") Mesh::set_shared_vertex_data;
+
+	// These typemaps are supposed to work! but as they don't we'll just wrap
+	// the method manually :(
+	//
+	// Set appropriate OUTPUT parameters
+	//%apply unsigned short& OUTPUT { unsigned short &outSourceCoordSet };
+	//%apply unsigned short& OUTPUT { unsigned short &outIndex };
+	//bool MeshPtr::suggestTangentVectorBuildParams(VertexElementSemantic, unsigned short& OUTPUT, unsigned short &OUTPUT);	
+
+	%extend Mesh {
+		VertexData* shared_vertex_data() {
+			return self->sharedVertexData;
+		}
+
+		void set_shared_vertex_data(VertexData* vd) {
+			self->sharedVertexData = vd;
+		}
+
+		VALUE suggestTangentVectorBuildParams(VertexElementSemantic semantic) {
+			VALUE res = rb_ary_new2(3);
+			unsigned short sourceCoordSet, outIndex;
+			bool result = self-> suggestTangentVectorBuildParams(semantic, sourceCoordSet, outIndex);
+			rb_ary_push(res, result ? Qtrue : Qfalse);
+			rb_ary_push(res, INT2NUM(sourceCoordSet));
+			rb_ary_push(res, INT2NUM(outIndex));
+			return res;
+		}
+	}
 }
 
+%ignore Ogre::Mesh::suggestTangentVectorBuildParams(VertexElementSemantic, unsigned short&, unsigned short&);
+
 %include "OgreMesh.h"

data/vendor/ogrerb/ogre/OgreQuaternion.i

@@ -2,4 +2,9 @@
   #include "OgreQuaternion.h"
 %}
 
+namespace Ogre {
+	%ignore Quaternion::ZERO;
+	%ignore Quaternion::IDENTITY;
+}
+
 %include "OgreQuaternion.h"

data/vendor/ogrerb/ogre/OgreRenderSystemCapabilities.i

@@ -4,4 +4,8 @@
 
 %ignore __RenderSystemCapabilities__;
 
+namespace Ogre {
+	%rename("has_capability?") RenderSystemCapabilities::hasCapability;
+}
+
 %include "OgreRenderSystemCapabilities.h"