chingu 0.6.9 → 0.7.0

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gemspec.rubyforge_project = "chingu"
     gemspec.version = Chingu::VERSION
     
-    gemspec.add_dependency 'gosu', '>= 0.7.17'
+    gemspec.add_dependency 'gosu', '>= 0.7.18'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/chingu.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{chingu}
-  s.version = "0.6.9"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ippa"]
-  s.date = %q{2010-01-05}
+  s.date = %q{2010-01-14}
   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 = [
@@ -39,6 +39,7 @@ Gem::Specification.new do |s|
      "examples/example15_trait_timer2.rb",
      "examples/example16_online_high_scores.rb",
      "examples/example17_gosu_tutorial.rb",
+     "examples/example18_viewport.rb",
      "examples/example1_basics.rb",
      "examples/example2_gamestate_basics.rb",
      "examples/example3_parallax.rb",
@@ -121,6 +122,8 @@ Gem::Specification.new do |s|
      "lib/chingu/traits/retrofy.rb",
      "lib/chingu/traits/timer.rb",
      "lib/chingu/traits/velocity.rb",
+     "lib/chingu/traits/viewport.rb",
+     "lib/chingu/viewport.rb",
      "lib/chingu/window.rb"
   ]
   s.homepage = %q{http://github.com/ippa/chingu}
@@ -138,6 +141,7 @@ Gem::Specification.new do |s|
      "examples/example15_trait_timer2.rb",
      "examples/example16_online_high_scores.rb",
      "examples/example17_gosu_tutorial.rb",
+     "examples/example18_viewport.rb",
      "examples/example1_basics.rb",
      "examples/example2_gamestate_basics.rb",
      "examples/example3_parallax.rb",
@@ -155,12 +159,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<gosu>, [">= 0.7.17"])
+      s.add_runtime_dependency(%q<gosu>, [">= 0.7.18"])
     else
-      s.add_dependency(%q<gosu>, [">= 0.7.17"])
+      s.add_dependency(%q<gosu>, [">= 0.7.18"])
     end
   else
-    s.add_dependency(%q<gosu>, [">= 0.7.17"])
+    s.add_dependency(%q<gosu>, [">= 0.7.18"])
   end
 end
 

data/examples/example18_viewport.rb

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'opengl'
+require File.join(File.dirname($0), "..", "lib", "chingu")
+include Gosu
+include Chingu
+
+#
+# viewport-trait example
+#
+# Gotcha: collision_detection-trait debug mode currently borks up with viewports (only the visuals)
+# 
+class Game < Chingu::Window
+  attr_reader :factor
+  
+  def initialize
+    super    
+    @factor = 6
+    self.input = { :escape => :exit }          
+    switch_game_state(Level)
+  end
+end
+
+class Level < GameState
+  #
+  # This adds accessor 'viewport' to class and overrides draw() to use it.
+  #
+  has_trait :viewport
+  
+  #
+  # We create our 3 different game objects in this order: 
+  # 1) map 2) stars 3) player
+  # Since we don't give any zorders Chingu automatically increments zorder between each object created, putting player on top
+  #
+  def initialize(options = {})
+    super
+    @map = GameObject.create(:image => "background1.png", :factor => $window.factor, :rotation_center => :top_left, :retrofy => true)    
+    self.viewport.x_min = 0
+    self.viewport.y_min = 0
+    self.viewport.x_max = @map.image.width * $window.factor - $window.width
+    self.viewport.y_max = @map.image.height * $window.factor - $window.height
+    
+    # Create 40 stars scattered around the map
+    40.times { |nr| Star.create(:x => rand * self.viewport.x_max, :y => rand * self.viewport.y_max) }
+  
+    @droid = Droid.create(:x => 100, :y => 100)
+  end
+  
+  def update    
+    super
+
+    @droid.each_collision(Star) do |droid, star|
+      star.destroy
+      Sound["laser.wav"].play(0.5)
+    end
+    
+    #
+    # Align viewport with the droid in the middle.
+    # This will make droid will be in the center of the screen all the time...
+    # ...except when hitting outer borders and viewport x/y _ min/max kicks in.
+    #
+    self.viewport.x = @droid.x - $window.width / 2
+    self.viewport.y = @droid.y - $window.height / 2
+        
+    $window.caption = "viewport-trait example. Move with arrows! x/y: #{@droid.x}/#{@droid.y} - viewport x/y: #{self.viewport.x}/#{self.viewport.y} - FPS: #{$window.fps}"
+  end
+end
+
+class Droid < Chingu::GameObject
+  has_trait :bounding_box
+  has_traits :timer, :collision_detection
+  
+  attr_accessor :last_x, :last_y
+  
+  def initialize(options = {})
+    super
+    
+    #
+    # This shows up the shorten versio of input-maps, where each key calls a method of the very same name.
+    # Use this by giving an array of symbols to self.input
+    #
+    self.input = [:holding_left, :holding_right, :holding_up, :holding_down]
+    
+    # Load the full animation from tile-file media/droid.bmp
+    @full_animation = Chingu::Animation.new(:file => "droid.bmp", :size => [11,16]).retrofy
+    
+    # Create new animations from specific frames and stuff them into easy to access hash
+    @animations = {}
+    @animations[:scan] = @full_animation[0..5]
+    @animations[:up] = @full_animation[6..7]
+    @animations[:down] = @full_animation[8..9]
+    @animations[:left] = @full_animation[10..11]
+    @animations[:right] = @full_animation[12..13]
+    
+    # Start out by animation frames 0-5 (contained by @animations[:scan])
+    @animation = @animations[:scan]
+    
+    self.factor = $window.factor
+    @last_x, @last_y = @x, @y
+    @speed = 3
+    
+    update
+  end
+    
+  def holding_left
+    @x -= @speed
+    @animation = @animations[:left]
+  end
+
+  def holding_right
+    @x += @speed
+    @animation = @animations[:right]
+  end
+
+  def holding_up
+    @y -= @speed
+    @animation = @animations[:up]
+  end
+
+  def holding_down
+    @y += @speed
+    @animation = @animations[:down]
+  end
+
+  # We don't need to call super() in update().
+  # By default GameObject#update is empty since it doesn't contain any gamelogic to speak of.
+  def update
+    
+    # Move the animation forward by fetching the next frame and putting it into @image
+    # @image is drawn by default by GameObject#draw
+    @image = @animation.next
+    
+    #
+    # If droid stands still, use the scanning animation
+    #
+    if @x == @last_x && @y == @last_y
+      @animation = @animations[:scan]
+    end
+    
+    @x, @y = @last_x, @last_y if self.parent.outside_viewport?(self)
+    @last_x, @last_y = @x, @y
+  end
+end
+
+class Star < GameObject
+  has_trait :bounding_circle
+  has_trait :collision_detection
+  
+  def initialize(options={})
+    super
+    
+    @animation = Chingu::Animation.new(:file => media_path("Star.png"), :size => 25)
+    @image = @animation.next
+    self.color = Gosu::Color.new(0xff000000)
+    self.color.red = rand(255 - 40) + 40
+    self.color.green = rand(255 - 40) + 40
+    self.color.blue = rand(255 - 40) + 40
+    
+    #
+    # A cached bounding circle will not adapt to changes in size, but it will follow objects X / Y
+    # Same is true for "cache_bounding_box"
+    #
+    cache_bounding_circle
+  end
+  
+  def update
+    # Move the animation forward by fetching the next frame and putting it into @image
+    # @image is drawn by default by GameObject#draw
+    @image = @animation.next
+  end
+end
+
+Game.new.show

data/lib/chingu.rb

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

data/lib/chingu/game_object.rb

@@ -118,8 +118,19 @@ module Chingu
       distance(self.x, self.y, object.x, object.y)
     end
     
+    #
+    # Our encapsulation of GOSU's image.draw_rot, uses the objects variables to draw it on screen if @visible is true
+    #
     def draw
       @image.draw_rot(@x, @y, @zorder, @angle, @center_x, @center_y, @factor_x, @factor_y, @color, @mode) if @visible
     end
+    
+    #
+    # Works as #draw() but takes offsets for all draw_rot()-arguments. Used among others by by viewport-trait
+    #
+    def draw_relative(x=0, y=0, zorder=0, angle=0, center_x=0, center_y=0, factor_x=0, factor_y=0)
+      @image.draw_rot(@x+x, @y+y, @zorder+zorder, @angle+angle, @center_x+center_x, @center_y+center_y, @factor_x+factor_x, @factor_y+factor_y, @color, @mode) if @visible
+    end
+    
   end  
 end

data/lib/chingu/game_object_list.rb

@@ -27,8 +27,8 @@ module Chingu
   #
   class GameObjectList
         
-    def initialize
-      @game_objects = Array.new
+    def initialize(options = {})
+      @game_objects = options[:game_objects] || []
       #@game_objects_by_class = Hash.new
     end
     
@@ -73,7 +73,14 @@ module Chingu
         object.draw
       end
     end
-    
+
+    def draw_relative(x=0, y=0, zorder=0, angle=0, center_x=0, center_y=0, factor_x=0, factor_y=0)
+      @game_objects.each{ |object| object.visible }.each do |object| 
+        object.draw_trait
+        object.draw_relative(x, y, zorder, angle, center_x, center_y, factor_x, factor_y)
+      end
+    end
+
     def update
       @game_objects.select{ |object| not object.paused }.each do |object| 
         object.update_trait 

data/lib/chingu/traits/viewport.rb

@@ -0,0 +1,75 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
+module Chingu
+  module Traits
+    #
+    # A chingu trait providing velocity and acceleration logic. 
+    # Adds parameters: velocity_x/y, acceleration_x/y and modifies self.x / self.y
+    # Also keeps previous_x and previous_y which is the x, y before modification.
+    # Can be useful for example collision detection
+    #
+    module Viewport
+      attr_accessor :viewport
+      
+      module ClassMethods
+        def initialize_trait(options = {})
+          trait_options[:viewport] = {:apply => true}.merge(options)
+        end
+      end
+      
+      def setup_trait(options)
+        @viewport_options = {:debug => false}.merge(options)
+        
+        @viewport = Chingu::Viewport.new()
+        @viewport.x = options[:viewport_x] || 0
+        @viewport.y = options[:viewport_y] || 0
+        
+        super
+      end
+            
+      #
+      # Returns true if object is inside view port, false if outside
+      # TODO: add view port height and width! (and use clip_to when painting?)
+      #
+      # This is a very flawed implementation, it Should take inte account objects 
+      # height,width,factor_x,factor_y,center_x,center_y as well...
+      #
+      def inside_viewport?(object)
+        object.x >= @viewport.x && object.x <= (@viewport.x + $window.width) && 
+        object.y >= @viewport.y && object.y <= (@viewport.y + $window.height)
+      end
+
+      # Returns true object is outside the view port
+      def outside_viewport?(object)
+        not inside_viewport?(object)
+      end
+      
+      #
+      # Override game states default draw that draws objects relative to the viewport.
+      # It only draws game objects inside the viewport. (GOSU does no such optimizations)
+      #
+      def draw
+        self.game_objects.draw_relative(-@viewport.x, -@viewport.y)
+      end      
+    end
+  end
+end

data/lib/chingu/viewport.rb

@@ -0,0 +1,68 @@
+#--
+#
+# Chingu -- OpenGL accelerated 2D game framework for Ruby
+# Copyright (C) 2009 ippa / ippa@rubylicio.us
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#++
+
+module Chingu
+  #
+  # A basic Viewport class
+  #
+  # TODO:
+  # Implement use of viewports angle, center_x, center_y, factor_x, factor_y
+  #
+  class Viewport
+    attr_accessor :x, :y, :x_min, :x_max, :y_min, :y_max
+    #attr_accessor :angle, :center_x, :center_y, :factor_x, :factor_y
+    
+    def initialize(options = {})
+      @x = options[:x] || 0
+      @y = options[:y] || 0
+      @angle = options[:angle] || 0
+      
+      #self.factor = options[:factor] || options[:scale] || 1.0
+      #@factor_x = options[:factor_x] if options[:factor_x]
+      #@factor_y = options[:factor_y] if options[:factor_y]
+      
+      #self.center = options[:center] || 0.5
+      #@rotation_center = options[:rotation_center]
+      #self.rotation_center(options[:rotation_center]) if options[:rotation_center]
+      
+      #@center_x = options[:center_x] if options[:center_x]
+      #@center_y = options[:center_y] if options[:center_y]
+      
+      @x_min = nil
+      @x_max = nil
+      @y_min = nil
+      @y_max = nil      
+    end
+    
+    def x=(x)
+      @x = x
+      @x = @x_min   if @x_min && @x < @x_min
+      @x = @x_max   if @x_max && @x > @x_max
+    end
+
+    def y=(y)
+      @y = y
+      @y = @y_min   if @y_min && @y < @y_min
+      @y = @y_max   if @y_max && @y > @y_max
+    end
+    
+  end
+end

data/lib/chingu/window.rb

@@ -37,7 +37,7 @@ module Chingu
     include Chingu::Helpers::GameState          # Easy access to the global game state-queue
     include Chingu::Helpers::GameObject         # Adds game_objects_of_class etc ...
     include Chingu::Helpers::InputDispatcher    # Input dispatch-helpers
-    include Chingu::Helpers::InputClient        # WIndow has its own inputmap
+    include Chingu::Helpers::InputClient        # Window has its own inputmap
     
     attr_reader :root, :game_state_manager, :game_objects, :milliseconds_since_last_tick
     
@@ -56,7 +56,7 @@ module Chingu
       
       @fps_counter = FPSCounter.new
       @game_state_manager = GameStateManager.new
-      @milliseconds_since_last_tick = 0
+      @milliseconds_since_last_tick = 0      
     end
     
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: chingu
 version: !ruby/object:Gem::Version 
-  version: 0.6.9
+  version: 0.7.0
 platform: ruby
 authors: 
 - ippa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-05 00:00:00 +01:00
+date: 2010-01-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.17
+        version: 0.7.18
     version: 
 description: 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.
 email: ippa@rubylicio.us
@@ -54,6 +54,7 @@ files:
 - examples/example15_trait_timer2.rb
 - examples/example16_online_high_scores.rb
 - examples/example17_gosu_tutorial.rb
+- examples/example18_viewport.rb
 - examples/example1_basics.rb
 - examples/example2_gamestate_basics.rb
 - examples/example3_parallax.rb
@@ -136,6 +137,8 @@ files:
 - lib/chingu/traits/retrofy.rb
 - lib/chingu/traits/timer.rb
 - lib/chingu/traits/velocity.rb
+- lib/chingu/traits/viewport.rb
+- lib/chingu/viewport.rb
 - lib/chingu/window.rb
 has_rdoc: true
 homepage: http://github.com/ippa/chingu
@@ -174,6 +177,7 @@ test_files:
 - examples/example15_trait_timer2.rb
 - examples/example16_online_high_scores.rb
 - examples/example17_gosu_tutorial.rb
+- examples/example18_viewport.rb
 - examples/example1_basics.rb
 - examples/example2_gamestate_basics.rb
 - examples/example3_parallax.rb