collada 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDZkOGNmM2E0ZDBkMjE5MzA1MDBkNWZjZTc4YmNmZWQ2ZDVkOWMxZA==
+  data.tar.gz: !binary |-
+    M2Y0YTUwZTQ1NjU0MThmNjMwMzhkOWYyYTVmZmJiYmE5ODY0MGM4ZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTY4YzFjNDRmYjhlMDJmYmQ2YjQ1NzgxMDdmZjE4NTVmZjM1Y2FlMjM0ODRh
+    ZDRkODA3ZjUzY2ZhZWNjZTAyNjYxNjk0YWUyNjNkN2E0Y2RlN2Q5MjIzM2Ji
+    NzUyNmQ3YzBlZmRjM2QwOTFkOGI2OWJkZGU4ZTY2Zjk5ODlhOWI=
+  data.tar.gz: !binary |-
+    YTBkMTc3ZjZiZWEyN2I4ZTgzNzY0ZDUyZjhkNTY2NDFkMjUyNWU1YzZkYWEy
+    Mzc2NTE0MDNmNDY5ZmNkMzcyZTk3YmI3NGNiYTc0MjkwNjAxM2U5MDRkODE1
+    NmExOTk5YTcxYTMzZjE2ZDkxNzFkMjZlZGRmM2E0MzBlZDBiNGQ=

data/.travis.yml

@@ -1,9 +1,4 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.2"
   - "1.9.3"
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
   - rbx-19mode

data/README.md

@@ -2,6 +2,8 @@
 
 This library provides support for loading and processing data from Collada Digital Asset Exchange files. These files are typically used for sharing geometry and scenes.
 
+[![Build Status](https://secure.travis-ci.org/ioquatix/collada.png)](http://travis-ci.org/ioquatix/collada)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +20,52 @@ Or install it yourself as:
 
 ## Usage
 
-The main loader is incomplete can can only load geometry data at this point in time.
+This library is designed to be used in scripts which extract data from collada files and output in some other format. As such, you'd typically create your own conversion script which takes the collada file as an argument. Then, use this library to extract relevant geometry and write it out.
+
+To assist with some basic tasks, the `collada-convert` executable provides a number of basic conversion functions. At present, `collada-convert` is primarily designed to produce [tagged format text][1].
+
+[1]: https://github.com/ioquatix/tagged-format
+
+### Example Conversion
+
+Several example `.dae` files are included and used as part of the unit tests. The `collada-convert` executable can dump the geometries contained within easily:
+
+	$ ./bin/collada-convert tagged-format -v p3n3 ./test/sample.dae 
+	Cube-mesh: mesh triangles
+		indices: array index16
+			    0    1    2    3    4    5    6    7    8    9   10   11
+			   12   13   14   15   16   17   18   19   20   21   22   23
+		end
+		vertices: array vertex-p3n3
+			         1.0          1.0         -1.0          0.0          0.0         -1.0
+			         1.0         -1.0         -1.0          0.0          0.0         -1.0
+			        -1.0         -1.0         -1.0          0.0          0.0         -1.0
+			        -1.0          1.0         -1.0          0.0          0.0         -1.0
+			         1.0          1.0          1.0          0.0          0.0          1.0
+			        -1.0          1.0          1.0          0.0          0.0          1.0
+			        -1.0         -1.0          1.0          0.0          0.0          1.0
+			         1.0         -1.0          1.0          0.0          0.0          1.0
+			         1.0          1.0         -1.0          1.0         -0.0          0.0
+			         1.0          1.0          1.0          1.0         -0.0          0.0
+			         1.0         -1.0          1.0          1.0         -0.0          0.0
+			         1.0         -1.0         -1.0          1.0         -0.0          0.0
+			         1.0         -1.0         -1.0         -0.0         -1.0          0.0
+			         1.0         -1.0          1.0         -0.0         -1.0          0.0
+			        -1.0         -1.0          1.0         -0.0         -1.0          0.0
+			        -1.0         -1.0         -1.0         -0.0         -1.0          0.0
+			        -1.0         -1.0         -1.0         -1.0          0.0          0.0
+			        -1.0         -1.0          1.0         -1.0          0.0          0.0
+			        -1.0          1.0          1.0         -1.0          0.0          0.0
+			        -1.0          1.0         -1.0         -1.0          0.0          0.0
+			         1.0          1.0          1.0          0.0          1.0          0.0
+			         1.0          1.0         -1.0          0.0          1.0          0.0
+			        -1.0          1.0         -1.0          0.0          1.0          0.0
+			        -1.0          1.0          1.0          0.0          1.0          0.0
+		end
+	end
+	top: offset-table
+		Cube: $Cube-mesh
+	end
 
 ## Contributing
 
@@ -28,6 +75,11 @@ The main loader is incomplete can can only load geometry data at this point in t
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+### Desired Features
+
+* Converter: Support .obj files.
+* Support more of the collada standard.
+
 ## License
 
 Released under the MIT license.

data/bin/collada-convert

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'collada/parser/library'
+
+require 'collada/conversion/mesh'
+require 'collada/conversion/skeleton'
+require 'collada/conversion/tagged_format'
+
+require 'rainbow'
+require 'benchmark'
+require 'trollop'
+
+module Application
+	TaggedFormat = Collada::Conversion::TaggedFormat
+	
+	def self.tagged_format
+		options = Trollop::options do
+			opt :vertex_format, "Vertices format, one of #{TaggedFormat::VERTEX_FORMATS.keys.join(', ')}.", :default => "p3n3"
+			
+			opt :nodes, "Dump scene graph data structure", :default => false
+		end
+		
+		doc = REXML::Document.new(ARGF)
+		library = Collada::Parser::Library.parse(doc)
+		
+		TaggedFormat.new(options, library).dump
+	end
+end
+
+time = Benchmark.measure do
+	action = ARGV.shift.gsub(/-/, '_').to_sym
+	Application.send(action) if Application.methods.include?(action)
+end
+
+$stderr.puts time.format("Elapsed Time: %r").color(:magenta)

data/collada.gemspec

@@ -4,20 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'collada/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "collada"
-  gem.version       = Collada::VERSION
-  gem.authors       = ["Samuel Williams"]
-  gem.email         = ["samuel.williams@oriontransfer.co.nz"]
-  gem.description   = <<-EOF
-  This library provides support for loading and processing data from Collada 
-  Digital Asset Exchange files. These files are typically used for sharing
-  geometry and scenes.
-  EOF
-  gem.summary       = %q{A library for loading and manipulating Collada .dae files.}
-  gem.homepage      = ""
+	gem.name          = "collada"
+	gem.version       = Collada::VERSION
+	gem.authors       = ["Samuel Williams"]
+	gem.email         = ["samuel.williams@oriontransfer.co.nz"]
+	gem.description   = <<-EOF
+	This library provides support for loading and processing data from Collada 
+	Digital Asset Exchange files. These files are typically used for sharing
+	geometry and scenes.
+	EOF
+	gem.summary       = %q{A library for loading and manipulating Collada .dae files.}
+	gem.homepage      = ""
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+	gem.files         = `git ls-files`.split($/)
+	gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+	gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+	gem.require_paths = ["lib"]
+	
+	gem.add_dependency "rainbow"
+	gem.add_dependency "trollop"
+	gem.add_dependency "libxml-ruby"
 end

data/lib/collada/conversion/mesh.rb

@@ -0,0 +1,144 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'collada/parser/support'
+require 'collada/transforms'
+
+module Collada
+	module Conversion
+		class VertexFormat
+			def initialize(format)
+				@format = format
+			end
+			
+			def call(attributes)
+				attributes = Collada::Parser::Attribute.to_hash(attributes) unless Hash === attributes
+				
+				@format.collect do |name, components|
+					value = attributes[name]
+				
+					raise ArgumentError.new("Invalid vertex format, undefined property #{name} for #{attributes.inspect}!") unless value
+				
+					case components
+					when Array
+						components.collect{|key| value[key]}
+					else
+						components.call(value)
+					end
+				end.flatten
+			end
+		
+			def self.[] (format)
+				self.new(format)
+			end
+			
+			def merge(extra_format)
+				format = @format.dup
+				
+				extra_format.each do |key, value|
+					format[key] = value
+				end
+				
+				self.class.new(format)
+			end
+			
+			def with_vertex_index
+				merge(vertex: [:index])
+			end
+		end
+		
+		class WeightFormat
+			def initialize(count)
+				@count = count
+			end
+			
+			def call(vertex_weights)
+				# Ensure that we have the correct number:
+				vertex_weights = @count.times.collect do |offset|
+					vertex_weights[offset] || [0, 0.0]
+				end
+				
+				# Go from [[bone1, weight1], [bone2, weight2]] => [bone1, bone2, weight1, weight2]
+				return vertex_weights.collect{|(bone,_)| bone}, vertex_weights.collect{|(_,weight)| weight}
+			end
+			
+			def self.[] (count)
+				self.new(count)
+			end
+		end
+		
+		class Vertex
+			# The format provided here is used purely to calculate unique vertices.
+			def initialize(attributes, format)
+				@attributes = Parser::Attribute.to_hash(attributes)
+				@format = format
+			end
+			
+			attr :attributes
+			
+			def to_a(format = @format)
+				format.call(@attributes)
+			end
+			
+			def <=>(other)
+				to_a <=> other.to_a
+			end
+			
+			def index
+				@attributes[:vertex][:index]
+			end
+			
+			def hash
+				to_a.hash
+			end
+		end
+		
+		class Mesh
+			def initialize
+				@indices = []
+				
+				# vertex -> index
+				@vertices = {}
+				
+				# index -> vertex
+				@indexed = []
+			end
+			
+			attr :indices
+			attr :vertices
+			attr :indexed
+			
+			def size
+				@indexed.size
+			end
+			
+			def << vertex
+				if index = vertices[vertex]
+					@indices << index
+				else
+					@vertices[vertex] = self.size
+					@indices << self.size
+					
+					@indexed << vertex
+				end
+			end
+		end
+	end
+end

data/lib/collada/conversion/skeleton.rb

@@ -0,0 +1,84 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'collada/parser/support'
+require 'collada/transforms'
+
+module Collada
+	module Conversion
+		class Skeleton
+			def initialize(library, scene, node, controller)
+				@library = library
+				@scene = scene
+				@node = node
+				
+				@controller = controller
+				
+				extract_skeleton(node)
+			end
+			
+			attr :library
+			attr :scene
+			attr :node
+			attr :controller
+			
+			attr :top
+			attr :bones
+			attr :indexed
+			
+			def indexed_weights
+				result = []
+				
+				@controller.weights.each do |vertex|
+					output = []
+					
+					vertex.each do |weight|
+						weight = Parser::Attribute.merge(weight)
+						
+						output << [@indexed[weight[:JOINT]], weight[:WEIGHT]]
+					end
+					
+					# Sort bone weights in descending order:
+					result << output.sort{|a,b| b[1] <=> a[1]}
+				end
+				
+				return result
+			end
+			
+			private
+			
+			def extract_skeleton(top)
+				@bones = [[0, top]]
+				@indexed = {top.id => 0}
+				
+				@scene.traverse(top.children) do |node|
+					next unless node.type == :joint
+					
+					bone_index = indexed[node.parents(:joint).first.id]
+					
+					@indexed[node.id] = bones.size
+					@bones << [bone_index, node]
+				end
+				
+				return bones
+			end
+		end
+	end
+end

data/lib/collada/conversion/tagged_format.rb

@@ -0,0 +1,172 @@
+
+module Collada
+	module Conversion
+		class TaggedFormat
+			VERTEX_FORMATS = {
+				"p3n3" => VertexFormat[position: [:X, :Y, :Z], normal: [:X, :Y, :Z]],
+				"p3n3m2" => VertexFormat[position: [:X, :Y, :Z], normal: [:X, :Y, :Z], texcoord: [:S, :T]],
+				"p3n3m2b2" => VertexFormat[position: [:X, :Y, :Z], normal: [:X, :Y, :Z], texcoord: [:S, :T], bones: WeightFormat[4]],
+				"p3n3m2b4" => VertexFormat[position: [:X, :Y, :Z], normal: [:X, :Y, :Z], texcoord: [:S, :T], bones: WeightFormat[4]],
+			}
+	
+			def initialize(options, library, output = nil)
+				@options = options
+				@library = library
+		
+				@output_vertex_format = VERTEX_FORMATS[@options[:vertex_format]]
+		
+				@output = output || $stdout
+		
+				@top = {}
+				@nodes = {}
+			end
+	
+			def dump_geometry(scene, node, instance, skeleton = nil)
+				vertex_format = @output_vertex_format.with_vertex_index
+				geometry = instance.lookup(@library)
+		
+				mesh = Mesh.new
+		
+				weights = skeleton.indexed_weights if skeleton
+		
+				geometry.mesh.polygons.each do |polygon|
+					polygon.each do |vertex_attributes|
+						vertex = Collada::Conversion::Vertex.new(vertex_attributes, vertex_format)
+				
+						vertex.attributes[:bones] = weights[vertex.index] if weights
+				
+						mesh << vertex
+					end
+				end
+		
+				@output.puts "#{geometry.id}: mesh triangles"
+		
+				@output.puts "	indices: array index16"
+				mesh.indices.each_slice(12) do |indices|
+					@output.puts "		#{indices.flatten.collect{|i| i.to_s.rjust(5)}.join}"
+				end
+				@output.puts "	end"
+		
+				@output.puts "	vertices: array vertex-#{@options[:vertex_format]}"
+				mesh.vertices.size.times do |index|
+					vertex = mesh.indexed[index]
+					@output.puts "		#{vertex.to_a(@output_vertex_format).collect{|v| v.to_s.rjust(12)}.join(' ')}"
+				end
+				@output.puts "	end"
+		
+				@output.puts "end"
+		
+				@top[geometry.name || geometry.id] = geometry.id
+		
+				return geometry
+			end
+	
+			def dump_controller(scene, node, instance)
+				controller = instance.lookup(@library)
+				if controller.bind_pose_transform != Matrix.identity(4)
+					raise ArgumentError.new("Non-identity bind pose transform is not supported by this exporter!")
+				end
+		
+				top_joint = scene[instance.skeleton.id]
+				skeleton = Collada::Conversion::Skeleton.new(@library, scene, top_joint, controller)
+		
+				geometry = dump_geometry(scene, node, controller.source, skeleton)
+		
+				indexed_weights = skeleton.indexed_weights
+		
+				@output.puts "#{controller.id}: skeleton"
+		
+				indexed_bones = {}
+				@output.puts "	bones: array skeleton-bone"
+				skeleton.bones.each.with_index do |(parent, bone), index|
+					indexed_bones[bone.id] = index
+					@output.puts "		#{bone.id} #{parent.to_s.rjust(5)}\t#{bone.transform_matrix.to_a.flatten.join(' ')}"
+				end
+				@output.puts "	end"
+		
+				# Extract out the animations that transform the bones:
+				channels = {}
+				start_time = 0.0
+				end_time = 0.0
+				@library[:animations].each do |animation|
+					animation.channels.each do |channel|
+						channels[channel.target] = channel
+				
+						# Extract out the end time if possible:
+						attributes = Collada::Parser::Attribute.to_hash(channel.source[-1])
+						end_time = attributes[:input][:TIME] || 0.0
+					end
+				end
+		
+				@output.puts "	sequences: offset-table"
+				@output.puts "		default: skeleton-animation #{start_time} #{end_time}"
+				@output.puts "			key-frames: array skeleton-animation-key-frame"
+				skeleton.bones.each do |(parent, bone)|
+					channel = channels["#{bone.id}/transform"]
+			
+					next unless channel
+			
+					channel.source.count.times do |index|
+						attributes = Collada::Parser::Attribute.merge(channel.source[index])
+						@output.puts "				" + [indexed_bones[bone.id], attributes[:INTERPOLATION].downcase, attributes[:TIME], attributes[:TRANSFORM].to_a].flatten.join(' ')
+					end
+				end
+				@output.puts "			end"
+				@output.puts "		end"
+				@output.puts "	end"
+		
+				@output.puts "end"
+		
+				@top[controller.name || controller.id] = controller.id
+		
+				return geometry, skeleton
+			end
+	
+			def dump_instances(instances, indent = "")
+			end
+	
+			def dump_nodes(nodes, indent = "")
+				nodes.each do |node|
+					next unless node.type == :node
+			
+					@output.puts indent + "node #{node.id}"
+					@output.puts indent + "	#{node.local_transform_matrix.to_a.flatten.join(' ')}"
+			
+					dump_instances(node.instances, indent + "\t")
+					dump_nodes(node.children, indent + "\t")
+			
+					@output.puts indent + "end"
+				end
+			end
+	
+			def dump
+				@nodes = {}
+		
+				@library[:visual_scenes].each do |scene|
+					scene.traverse do |node|
+						$stderr.puts node.inspect.color(:blue)
+				
+						node.instances.each do |instance|
+							case instance
+							when Collada::Parser::VisualScene::GeometryInstance
+								geometry = dump_geometry(scene, node, instance)
+							when Collada::Parser::VisualScene::ControllerInstance
+								geometry, skeleton = dump_controller(scene, node, instance)
+							end
+						end
+					end
+			
+					if @options[:nodes]
+						dump_nodes(scene.nodes)
+					end
+				end
+		
+				@output.puts "top: offset-table"
+				@top.each do |name, label|
+					@output.puts "	#{name}: $#{label}"
+				end
+				@output.puts "end"
+			end
+		end
+	end
+end