chingu 0.8.0.5 → 0.8.1

data/benchmarks/array_vs_hash.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'benchmark'
+
+  
+@array = []
+@hash = {}
+Benchmark.bm(22) do |x|
+  x.report('add/remove from array') { 100000.times { |nr| @array.push(nr); @array.delete(nr-1) if nr > 100 } }
+  x.report('add/remove from hash') { 100000.times { |nr| @hash[nr] = true; @hash.delete(nr-1) if nr > 100 } }
+  
+  @array.clear
+  @hash.clear
+  x.report('add to array') { 100000.times { |nr| @array.push(nr) } }
+  x.report('add to hash')  { 100000.times { |nr| @hash[nr] = true } }
+  
+  x.report('array.each') { 100.times { |nr| @array.each { |x| x } } }
+  x.report('hash.each') { 100.times { |nr| @hash.each { |k,v| k } } }
+  x.report('hash.each_key') { 100.times { |nr| @hash.each_key { |x| x } } }
+end

data/benchmarks/game_object_list_benchmark.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'benchmark'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+#gem 'chingu', '0.6'
+#require 'chingu'
+include Gosu
+include Chingu
+
+class MyGameObject < GameObject
+end
+
+class MyBasicGameObject < GameObject
+end
+
+class ObjectWithTraits < GameObject
+  traits :velocity, :timer
+end
+
+
+class Game < Chingu::Window
+	def initialize
+		super(600,200)
+		self.input = { :esc => :exit }    
+  
+    Benchmark.bm(22) do |x|
+      x.report('create 50000 game objects') { 50000.times { MyGameObject.create } }  
+      x.report('force_update') { 60.times { $window.game_objects.force_update } }
+      x.report('force_draw') { 60.times { $window.game_objects.force_draw } }      
+      x.report('update') { 60.times { $window.game_objects.update } }
+      x.report('draw') { 60.times { $window.game_objects.draw } }      
+      x.report('update + create') { 60.times { $window.game_objects.update; MyGameObject.create; } }
+      x.report('draw + create') { 60.times { $window.game_objects.draw; MyGameObject.create; } }      
+      x.report('update + create + destroy') { 60.times { $window.game_objects.update; MyGameObject.create; MyGameObject.all.first.destroy } }
+      x.report('draw + create + destroy') { 60.times { $window.game_objects.draw; MyGameObject.create; MyGameObject.all.first.destroy } }
+    end
+	end
+end
+
+Game.new.show
+
+#
+# BEFORE GameObjectList visible_game_object/unpaused_game_object - refactor
+#
+#create 50000 game objects  1.919000   0.000000   1.919000 (  1.906109)
+#force_update            0.702000   0.000000   0.702000 (  0.716041)
+#force_draw              0.920000   0.000000   0.920000 (  0.924053)
+#update                  1.420000   0.000000   1.420000 (  1.421081)
+#draw                    1.497000   0.000000   1.497000 (  1.520087)
+#update + create         1.420000   0.000000   1.420000 (  1.420081)
+#draw + create           1.497000   0.000000   1.497000 (  1.528088)
+#update + create + destroy  2.106000   0.000000   2.106000 (  2.099120)
+#draw + create + destroy  2.262000   0.000000   2.262000 (  2.265129)
+
+#
+# AFTER 
+#
+#create 50000 game objects  1.934000   0.000000   1.934000 (  1.927111)
+#force_update            0.718000   0.000000   0.718000 (  0.712040)
+#force_draw              0.920000   0.000000   0.920000 (  0.929053)
+#update                  0.702000   0.000000   0.702000 (  0.708041)
+#draw                    0.904000   0.000000   0.904000 (  0.932053)
+#update + create         0.671000   0.000000   0.671000 (  0.688040)
+#draw + create           0.921000   0.000000   0.921000 (  0.915052)
+#update + create + destroy  1.950000   0.000000   1.950000 (  1.957112)
+#draw + create + destroy  2.184000   0.000000   2.184000 (  2.230128)
+
+#
+# WITH HASH instead of ARRAY
+#
+#create 50000 game objects  0.733000   0.016000   0.749000 (  0.737042)
+#force_update            1.045000   0.000000   1.045000 (  1.048060)
+#force_draw              1.154000   0.000000   1.154000 (  1.150065)
+#update                  1.014000   0.000000   1.014000 (  1.028058)
+#draw                    1.139000   0.000000   1.139000 (  1.152066)
+#update + create         1.045000   0.000000   1.045000 (  1.041060)
+#draw + create           1.155000   0.000000   1.155000 (  1.155066)
+#update + create + destroy  1.529000   0.000000   1.529000 (  1.525087)
+#draw + create + destroy  1.653000   0.000000   1.653000 (  1.661095)
+
+
+#
+# CONCLUSION
+#
+# Even when we're adding or destroying objects each game tick
+# we benefit greatly from keeping separate draw and update lists
+# instead of checking visible/paused flags in the draw/update loop itself
+#
+# Hash would be better then Array if we create/destroy tons of object.
+# Arrays are faster to iterate through, which we do alot of gametick.
+#
+#

data/benchmarks/game_objects_benchmark.rb

@@ -10,13 +10,28 @@ include Chingu
 class ObjectX < GameObject; end;
 class ObjectY < GameObject; end;
 class ObjectZ < GameObject; end;
+class ObjectWithTraits < GameObject
+  traits :velocity, :timer
+end
+
+class Test
+  @instances = [] 
+  class << self; attr_accessor :instances end
+  
+  def initialize
+    self.class.instances << self
+  end
+end
 
 class Game < Chingu::Window
 	def initialize
 		super(600,200)
-		self.input = { :esc => :exit }
-    
+		self.input = { :esc => :exit }    
+  end
+  
+  def update
     Benchmark.bm(22) do |x|
+      game_object = Test.new
       game_object = GameObject.new
       x.report('respond_to?') { 100000.times { game_object.respond_to?(:update_trait) } }
       x.report('call empty method') { 100000.times { game_object.update_trait } }
@@ -25,20 +40,41 @@ class Game < Chingu::Window
       game_objects.clear
       x.report('basic_game_objects') { 10000.times { BasicGameObject.create } }
       game_objects.clear
-      x.report('ObjectX') { 10000.times { ObjectX.create } }
-      x.report('ObjectY') { 10000.times { ObjectY.create } }
-      x.report('ObjectZ') { 10000.times { ObjectZ.create } }
-      
-      x.report('ObjectX.each') { ObjectX.all.each { |x| } }
-      x.report('ObjectY.each') { ObjectY.all.each { |y| } }
-      x.report('ObjectZ.each') { ObjectZ.all.each { |z| } }
-      
+      x.report('ObjectX') { 100000.times { ObjectX.create } }
+      x.report('ObjectY') { 100000.times { ObjectY.create } }
+      x.report('ObjectZ') { 100000.times { ObjectZ.create } }
+      x.report('ObjectWithTraits') { 100000.times { ObjectWithTraits.create } }
+
+      x.report('ObjectX full update') { ObjectX.each { |x| x.update_trait; x.update; } }
+      x.report('ObjectWithTraits full update') { ObjectWithTraits.each { |x| x.update_trait; x.update; } }
+
+      x.report('ObjectX.each') { ObjectX.all.each { |x| x } }
+      x.report('ObjectY.each') { ObjectY.all.each { |y| y } }
+      x.report('ObjectZ.each') { ObjectZ.all.each { |z| z } }
+
+
       p game_objects.size
-      x.report('ObjectX destroy') { ObjectX.each_with_index { |x, i| x.destroy if i%2==0 }; game_objects.sync; }
+      #x.report('ObjectX destroy') { ObjectX.each_with_index { |x, i| x.destroy if i%2==0 }; game_objects.sync; }
       p game_objects.size
+      exit
     end
-    
 	end
 end
 
 Game.new.show
+
+
+#                            user     system      total        real
+#respond_to?             0.015000   0.000000   0.015000 (  0.016001)
+#call empty method       0.016000   0.000000   0.016000 (  0.013001)
+#game_objects            0.327000   0.000000   0.327000 (  0.329019)
+#basic_game_objects      0.047000   0.000000   0.047000 (  0.038002)
+#ObjectX                 0.312000   0.000000   0.312000 (  0.314018)
+#ObjectY                 0.375000   0.000000   0.375000 (  0.372021)
+#ObjectZ                 0.327000   0.000000   0.327000 (  0.335020)
+#ObjectWithTraits        0.484000   0.000000   0.484000 (  0.484027)
+#ObjectX full update     0.015000   0.000000   0.015000 (  0.012001)
+#ObjectWithTraits full update  0.032000   0.000000   0.032000 (  0.034002)
+#ObjectX.each            0.015000   0.000000   0.015000 (  0.009000)
+#ObjectY.each            0.000000   0.000000   0.000000 (  0.010001)
+#ObjectZ.each            0.016000   0.000000   0.016000 (  0.009001)

data/benchmarks/lookup_benchmark.rb

@@ -0,0 +1,9 @@
+require 'benchmark'
+
+Benchmark.bm(22) do |x|
+  @map = Array.new
+  @map[0] = Array.new
+  @map[0][0] = "item"
+  x.report('lookup fail exception') { 1000000.times { @map[0][10]  rescue nil } }
+  x.report('lookup fail') { 1000000.times { @map[0] && @map[0][10]  } }
+end

data/benchmarks/trait_benchmark.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'benchmark'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+include Gosu
+include Chingu
+
+# This includes trait :sprite
+class SimpleGameObject < BasicGameObject
+  trait :simple_sprite
+end
+
+class ObjectX < GameObject
+  traits :velocity, :timer
+end
+
+class Test
+  @instances = [] 
+  class << self; attr_accessor :instances end
+  
+  def initialize
+    self.class.instances << self
+  end
+end
+
+class Game < Chingu::Window
+	def initialize
+		super(600,200)
+		self.input = { :esc => :exit }    
+    
+    Benchmark.bm(22) do |x|
+      #x.report('GameObject.destroy_all') { GameObject.destroy_all }     # SLOW!
+      x.report('SimpleameObject.create') { 50000.times { SimpleGameObject.create } }      
+      x.report('ClassicGameObject.create') { 50000.times { ClassicGameObject.create } }
+      x.report('GameObject.create') { 50000.times { GameObject.create } }
+      x.report('GameObject.create') { 50000.times { GameObject.create } }
+      x.report('GameObject.create') { 50000.times { GameObject.create } }
+    end
+    
+  end
+  
+end
+
+Game.new.show
+
+
+# 50000 x GameObject
+
+#
+# With set_options()
+#                            user     system      total        real
+#GameObject.create       1.825000   0.000000   1.825000 (  1.824104)
+#GameObject.create       2.044000   0.016000   2.060000 (  2.083119)
+#GameObject.create       1.934000   0.000000   1.934000 (  1.996114)
+
+#
+# With oldschool option-parsing
+#
+#                            user     system      total        real
+#GameObject.create       0.577000   0.000000   0.577000 (  0.574033)
+#GameObject.create       0.577000   0.015000   0.592000 (  0.599034)
+#GameObject.create       0.624000   0.000000   0.624000 (  0.623036)

data/benchmarks/window_benchmark.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'benchmark'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+#gem 'chingu', '0.6'
+#require 'chingu'
+include Gosu
+include Chingu
+
+class MyGameObject < GameObject
+end
+
+class Player < GameObject
+end
+
+
+
+class Game < Chingu::Window
+	def initialize
+		super(600,200)
+		
+    player = Player.create
+    
+  
+    Benchmark.bm(22) do |x|
+      x.report('create 10000 game objects') { 10000.times { MyGameObject.create } }  
+      x.report('update') { 60.times { $window.update } }
+
+      self.input = { :esc => :exit, :d => :exit, :a =>  :exit }
+      player.input = { :holding_up => :exit, :holding_down => :exit, :holding_left => :exit, :holding_right => :exit, :space => :exit, :left_ctrl => :exit }
+      
+      x.report('update window/player input') { 60.times { $window.update } }
+    end
+	end
+end
+
+Game.new.show

data/chingu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.8.0.5"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2011-01-03}
+  s.date = %q{2011-01-08}
   s.description = %q{OpenGL accelerated 2D game framework for Ruby. Builds on Gosu (Ruby/C++) which provides all the core functionality. Chingu adds simple yet powerful game states, prettier input handling, deployment safe asset-handling, a basic re-usable game object and stackable game logic.}
   s.email = %q{ippa@rubylicio.us}
   s.extra_rdoc_files = [
@@ -23,15 +23,20 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "benchmarks/README.txt",
+    "benchmarks/array_vs_hash.rb",
     "benchmarks/arrays_bench.rb",
     "benchmarks/benchmark.rb",
     "benchmarks/benchmark3.rb",
     "benchmarks/benchmark4.rb",
     "benchmarks/benchmark5.rb",
     "benchmarks/benchmark6.rb",
+    "benchmarks/game_object_list_benchmark.rb",
     "benchmarks/game_objects_benchmark.rb",
+    "benchmarks/lookup_benchmark.rb",
     "benchmarks/meta_benchmark.rb",
     "benchmarks/meta_benchmark2.rb",
+    "benchmarks/trait_benchmark.rb",
+    "benchmarks/window_benchmark.rb",
     "chingu.gemspec",
     "examples/example10_traits_retrofy.rb",
     "examples/example11_animation.rb",
@@ -155,6 +160,7 @@ Gem::Specification.new do |s|
     "lib/chingu/traits/collision_detection.rb",
     "lib/chingu/traits/effect.rb",
     "lib/chingu/traits/retrofy.rb",
+    "lib/chingu/traits/simple_sprite.rb",
     "lib/chingu/traits/sprite.rb",
     "lib/chingu/traits/timer.rb",
     "lib/chingu/traits/velocity.rb",
@@ -167,6 +173,7 @@ Gem::Specification.new do |s|
     "spec/chingu/console_spec.rb",
     "spec/chingu/fpscounter_spec.rb",
     "spec/chingu/game_object_list_spec.rb",
+    "spec/chingu/game_object_map_spec.rb",
     "spec/chingu/game_object_spec.rb",
     "spec/chingu/game_state_manager_spec.rb",
     "spec/chingu/helpers/input_client_spec.rb",
@@ -224,6 +231,7 @@ Gem::Specification.new do |s|
     "spec/chingu/console_spec.rb",
     "spec/chingu/fpscounter_spec.rb",
     "spec/chingu/game_object_list_spec.rb",
+    "spec/chingu/game_object_map_spec.rb",
     "spec/chingu/game_object_spec.rb",
     "spec/chingu/game_state_manager_spec.rb",
     "spec/chingu/helpers/input_client_spec.rb",

data/examples/example17_gosu_tutorial.rb

@@ -78,9 +78,10 @@ class Star < GameObject
   trait :collision_detection
   
   def initialize(options={})
-    super(:zorder=>1)
-    @animation = Chingu::Animation.new(:file => media_path("Star.png"), :size => 25)
+    super
+    @animation = Chingu::Animation.new(:file => "Star.png", :size => 25)
     @image = @animation.next
+    self.zorder = 1
     self.color = Gosu::Color.new(0xff000000)
     self.color.red = rand(255 - 40) + 40
     self.color.green = rand(255 - 40) + 40

data/examples/example21_sidescroller_with_edit.rb

@@ -10,8 +10,8 @@ include Chingu
 # 
 class Game < Chingu::Window
   def initialize
-    #super(1000,700)
-    super(1024,768, true)
+    super(1000,700)
+    #super(1024,768, true)
   end
   
   def setup
@@ -89,7 +89,7 @@ class Droid < Chingu::GameObject
   trait :bounding_box, :scale => 0.80
   traits :timer, :collision_detection , :timer, :velocity
   
-  attr_reader :jumpign
+  attr_reader :jumping
   
   def setup
     self.input = {  [:holding_left, :holding_a] => :holding_left, 
@@ -110,8 +110,9 @@ class Droid < Chingu::GameObject
     self.acceleration_y = 0.5
     self.max_velocity = 10
     self.rotation_center = :bottom_center
-
+    
     update
+    cache_bounding_box
   end
   
   def die
@@ -287,6 +288,7 @@ class Block < GameObject
   def setup
     @image = Image["black_block.png"]
     @color = Color.new(0xff808080)
+    cache_bounding_box
   end
 end
 

data/examples/example23_chipmunk.rb

@@ -12,6 +12,7 @@ class Game < Chingu::Window
     self.input = { :escape => :exit } # exits example on Escape    
     
     Player.create(:x => 0, :y => 0, :rotation_center => :top_left)
+    Text.create("NOTHING TO SEE HERE YET ;-)", :align => :center)
   end  
 end
 

data/lib/chingu.rb

@@ -37,7 +37,7 @@ require_all "#{CHINGU_ROOT}/chingu/traits"
 require_all "#{CHINGU_ROOT}/chingu"
 
 module Chingu
-  VERSION = "0.8.0.5"
+  VERSION = "0.8.1"
   
   DEBUG_COLOR = Gosu::Color.new(0xFFFF0000)
   DEBUG_ZORDER = 9999

data/lib/chingu/animation.rb

@@ -25,7 +25,8 @@ module Chingu
     #   - step: [steps] move animation forward [steps] frames each time we call #next
     #
     def initialize(options)
-      options = {:step => 1, :loop => true, :bounce => false, :width => 32, :height => 32, :index => 0, :delay => 100}.merge(options)
+      #options = {:step => 1, :loop => true, :bounce => false, :width => 32, :height => 32, :index => 0, :delay => 100}.merge(options)
+      options = {:step => 1, :loop => true, :bounce => false, :index => 0, :delay => 100}.merge(options)
       
       @loop = options[:loop]
       @bounce = options[:bounce]