metro 0.3.3 → 0.3.4

data/changelog.md

@@ -1,5 +1,12 @@
 # Metro
 
+## 0.3.4 / 2012-12-14
+
+* `metro::ui::sprite` and `metro::ui::animated_sprite` model classes
+  to make it easier to take care of all the basic model attributes.
+* Event Management changed in the background. The API remains the
+  same.
+  
 ## 0.3.3 / 2012-11-28
 
 * Edit Mode - actors within a scene can have their position edited
@@ -7,7 +14,7 @@
   specified will appear within the scene with name and bounding box.
 * Dimensions can now be defined as strings
 * Game bounds and Game dimensions return objects of that type
-* `metr::ui::fps` added and has some shortcut placements settings
+* `metro::ui::fps` added and has some shortcut placements settings
 
 ## 0.3.2 / 2012-11-26
 

data/lib/core_ext/class.rb

@@ -0,0 +1,14 @@
+
+class Class
+
+  #
+  # Within Metro often times a Class or the name of the class is being used.
+  # ActiveSupport provides the constantize on Strings and Symbols but does
+  # not provide it on Class. So instead of providing redundant checks in
+  # places this monkeypatch simply makes Classes adhere to the same interface.
+  #
+  # @return [Class] itself.
+  def constantize
+    self
+  end
+end

data/lib/metro.rb

@@ -15,6 +15,7 @@ require 'active_support/hash_with_indifferent_access'
 require 'gosu_ext/color'
 require 'gosu_ext/gosu_constants'
 require 'core_ext/numeric'
+require 'core_ext/class'
 
 require 'locale/locale'
 

data/lib/metro/events/event_data.rb

@@ -1,12 +1,11 @@
 module Metro
   class EventData
 
-    attr_reader :mouse_x, :mouse_y, :created_at
+    attr_reader :mouse_point, :created_at
 
     def initialize(window)
       @created_at = Time.now
-      @mouse_x = window.mouse_x
-      @mouse_y = window.mouse_y
+      @mouse_point = Metro::Units::Point.at window.mouse_x, window.mouse_y
 
       capture_modifier_keys(window)
     end
@@ -23,7 +22,7 @@ module Metro
 
     #
     # TODO: This attempt to reduce duplication is brittle and will likely end in heartache.
-    # 
+    #
 
     def self.modifier_key_list_names
       @modifier_key_list_names ||= %w[ KbLeftControl KbRightControl

data/lib/metro/events/event_state_manager.rb

@@ -0,0 +1,63 @@
+require_relative 'event_relay'
+
+module Metro
+
+  class EventStateManager
+    def initialize
+      @current_state = []
+    end
+
+    attr_accessor :window
+
+    attr_reader :current_state
+
+    #
+    # Clear all the event relays of the current game state
+    #
+    def clear
+      current_state.clear
+    end
+
+    #
+    # Fire events for held buttons within the current game state
+    #
+    def fire_events_for_held_buttons
+      current_state.each {|cs| cs.fire_events_for_held_buttons }
+    end
+
+    #
+    # Fire events for button up for the current game state
+    #
+    def fire_button_up(id)
+      current_state.each {|cs| cs.fire_button_up(id) }
+    end
+
+    #
+    # Fire events for button down within the current game state
+    #
+    def fire_button_down(id)
+      current_state.each {|cs| cs.fire_button_down(id) }
+    end
+
+    #
+    # Fire notification events within the current game state
+    #
+    def fire_events_for_notification(event,sender)
+      current_state.each {|cs| cs.fire_events_for_notification(event,sender) }
+    end
+
+    #
+    # An an event relay to the current game state
+    #
+    def add_events_for_target(target,events)
+      relay = EventRelay.new(target,window)
+
+      events.each do |target_event|
+        relay.send target_event.event, *target_event.buttons, &target_event.block
+      end
+
+      current_state.push relay
+    end
+  end
+
+end

data/lib/metro/events/events.rb

@@ -0,0 +1,3 @@
+require_relative 'has_events'
+require_relative 'event_state_manager'
+require_relative 'unknown_sender'

data/lib/metro/events/hit_list.rb

@@ -10,7 +10,6 @@ module Metro
   #     hit_list.update(next_event)
   #     hit_list.release(last_event)
   #
-  #
   # @see EditTransitionScene
   #
   class HitList
@@ -22,7 +21,7 @@ module Metro
     attr_reader :drawers
 
     def hit(event)
-      add drawers_at(event.mouse_x,event.mouse_y)
+      add drawers_at(event.mouse_point)
       save_event event
     end
 
@@ -41,8 +40,8 @@ module Metro
       clear
     end
 
-    def drawers_at(x,y)
-      hit_drawers = drawers.find_all { |drawer| drawer.bounds.contains?(x,y) }
+    def drawers_at(point)
+      hit_drawers = drawers.find_all { |drawer| drawer.bounds.contains?(point) }
 
       # assumed that we only want one item
       top_drawer = hit_drawers.inject(hit_drawers.first) {|top,drawer| drawer.z_order > top.z_order ? drawer : top }
@@ -51,7 +50,7 @@ module Metro
 
     def offset_from_last_event(event)
       return Point.zero unless @last_event
-      Metro::Units::Point.at (event.mouse_x - @last_event.mouse_x).to_i, (event.mouse_y - @last_event.mouse_y).to_i
+      event.mouse_point - @last_event.mouse_point
     end
 
     def save_event(event)

data/lib/metro/events/unknown_sender.rb

@@ -1,5 +1,5 @@
 module Metro
   class UnknownSender
-    
+
   end
 end

data/lib/metro/models/model.rb

@@ -1,5 +1,6 @@
 require_relative 'key_value_coding'
 require_relative 'properties/property'
+require_relative 'models'
 
 module Metro
 
@@ -64,6 +65,11 @@ module Metro
     #
     def draw ; end
 
+    def self.model_name(model_name=nil)
+      @model_name ||= to_s.underscore
+      model_name ? @model_name = model_name.to_s : @model_name
+    end
+
     #
     # @return [String] the name of the model class.
     #
@@ -129,7 +135,7 @@ module Metro
     #
     def create(model_name,options={})
       # @TODO: this is another path that parallels the ModelFactory
-      model_class = Metro::Model.model(model_name).constantize
+      model_class = Metro::Models.find(model_name)
       mc = model_class.new options
       mc.scene = scene
       mc.window = window
@@ -211,37 +217,20 @@ module Metro
     #
     # Captures all classes that subclass Model.
     #
-    # @see #self.models_hash
-    #
-    def self.inherited(model)
-      models_hash[model.to_s] = model.to_s
-      models_hash[model.to_s.downcase] = model.to_s
-      models_hash[model.to_s.underscore] = model.to_s
+    def self.inherited(base)
+      models << base.to_s
+      Models.add(base)
     end
 
     #
-    # Convert the specified model name into the class of the model.
+    # All subclasses of Model, this should be all the defined
     #
-    # @return the Model class given the specified model name.
-    def self.model(name)
-      models_hash[name]
-    end
-
-    def self.models_hash
-      @models_hash ||= HashWithIndifferentAccess.new("Metro::UI::Generic")
+    def self.models
+      @models ||= []
     end
 
   end
 end
 
-require_relative 'ui/generic'
-require_relative 'ui/label'
-require_relative 'ui/menu'
-require_relative 'ui/image'
-require_relative 'ui/rectangle'
-require_relative 'ui/grid_drawer'
-require_relative 'ui/border'
-require_relative 'ui/model_label'
-require_relative 'ui/model_labeler'
-require_relative 'ui/fps'
+require_relative 'ui/ui'
 require_relative 'audio/song'

data/lib/metro/models/model_factory.rb

@@ -26,7 +26,7 @@ module Metro
     end
 
     def class_for_actor(model_name)
-      Model.model(model_name).constantize
+      Models.find(model_name)
     end
   end
 end

data/lib/metro/models/models.rb

@@ -0,0 +1,62 @@
+module Metro
+
+
+  module Models
+    extend self
+
+    #
+    # Add a model, and all it's subclasses, to the list of available models.
+    #
+    # A model has several names added so that it accessible in many ways:
+    #
+    # * Model Class Name
+    # * Model Name
+    # * Model Name with slashes replaced with `::` separator
+    #
+    def add(model)
+      all_models_for(model).each do |model|
+        models_hash[model.to_s] = model.to_s
+        name_with_slashes = model.model_name
+        models_hash[name_with_slashes] = model.to_s
+        name_with_colons  = name_with_slashes.gsub('/','::')
+        models_hash[name_with_colons] = model.to_s
+      end
+    end
+
+    #
+    # @param [String] name the name of the model that you want to return.
+    #
+    # @return [String] the name of the model class
+    #
+    def find(name)
+      models_hash[name].constantize
+    end
+
+    #
+    # @return [Array<String>] all the names supported by the models hash.
+    #
+    def list
+      models_hash.keys
+    end
+
+    #
+    # @return [Hash] a hash of the available models. The keys are the various
+    #   supported names, with the values being the names of the model classes.
+    def models_hash
+      @models_hash ||= HashWithIndifferentAccess.new("Metro::UI::Generic")
+    end
+
+    #
+    # @param [Class,Array<Class>] models a model or array of models.
+    # @return [Array] an array that contains the model itself and all of the
+    #   models that are sub-classes of this model on down.
+    #
+    def all_models_for(models)
+      Array(models).map do |model_class_name|
+        model = model_class_name.constantize
+        [ model ] + all_models_for(models.models)
+      end.flatten.compact
+    end
+
+  end
+end

data/lib/metro/models/properties/position_property.rb

@@ -81,7 +81,7 @@ module Metro
       end
 
       def default_point
-        (options[:default] and options[:default].is_a? Point) ? options[:default] : Point.zero
+        Point.parse(options[:default])
       end
 
     end

data/lib/metro/models/ui/animated_sprite.rb

@@ -0,0 +1,85 @@
+module Metro
+  module UI
+
+    #
+    # A sprite is a Metro model that is specially designed to draw and manage
+    # an animation. A sprite maintains an animation, location information, and
+    # rotation.
+    #
+    class AnimatedSprite < Model
+
+      # @attribute
+      # The animation that will be drawn for the sprite
+      property :animation
+
+      # @attribute
+      # The point at which the sprite should be drawn
+      property :position
+
+      # @attribute
+      # This is the color of the spirte. The color usually remains white, and
+      # the color property is implemented by the `alpha` value is the one thing
+      # that is altered to fade in and fade out the sprite.
+      property :color
+
+      # @attribute
+      # The scale at which to draw the sprite. This is default scale of 1.
+      property :scale
+
+      # @attribute
+      # The center, horizontal position, as expressed in a ratio, of the image.
+      property :center_x, type: :numeric, default: 0.0
+
+      # @attribute
+      # The center, vertical position, as expressed in a ratio, of the image.
+      property :center_y, type: :numeric, default: 0.0
+
+      # @attribute
+      # The angle at which the sprite should be drawn. This is by default 0.
+      property :angle
+
+      # @attribute
+      # The height and width of the sprite is based on the image of the sprite.
+      property :dimensions do
+        Dimensions.of current_image.width, current_image.height
+      end
+
+      # @return [RectangleBounds] the bounds of the sprite.
+      def bounds
+        Bounds.new left: left, right: right, top: top, bottom: bottom
+      end
+
+      # @return [Float] the left-most x position of the sprite
+      def left
+        x - width * center_x
+      end
+
+      # @return [Float] the right-most x position of the sprite
+      def right
+        left + width * x_factor
+      end
+
+      # @return [Float] the top-most y position of the sprite
+      def top
+        y - height * center_y
+      end
+
+      # @return [Float] the bottom-most y position of the sprite
+      def bottom
+        top + height * y_factor
+      end
+
+      # @return [Gosu::Image] the current image in the animation sequence.
+      def current_image
+        animation.image
+      end
+
+      #
+      # By default the sprite will draw the current image of the animation.
+      #
+      def draw
+        current_image.draw_rot x, y, z_order, angle, center_x, center_y, x_factor, y_factor, color
+      end
+    end
+  end
+end

data/lib/metro/models/ui/border.rb

@@ -5,7 +5,7 @@ module Metro
     # Draws a rectanglar border around the specififed position and dimensions
     # with the width provided. This is an unfilled rectangle.
     #
-    class Border < Metro::Model
+    class Border < Model
 
       # @attribute
       # The starting position of the border.
@@ -35,32 +35,58 @@ module Metro
       end
 
       def draw_top
-        window.draw_quad(x + border,y,color,
-          width + x,y,color,
-          x + width,y + border,color,
-          x + border,y + border,color,z_order)
+        draw_line left_with_border, top, right, top_with_border
       end
 
       def draw_left
-        window.draw_quad(x,y,color,
-          border + x,y,color,
-          x + border,y + border + height,color,
-          x,y + border + height,color,z_order)
+        draw_line left, top, left_with_border, bottom_with_border
       end
 
       def draw_right
-        window.draw_quad(x + width,y,color,
-          x + width + border,y,color,
-          x + width + border,y + border + height,color,
-          x + width,y + border + height,color,z_order)
-
+        draw_line right, top, right_with_border, bottom_with_border
       end
 
       def draw_bottom
-        window.draw_quad(x + border,y + height,color,
-          width + x,y + height,color,
-          x + width,y + border + height,color,
-          x + border,y + border + height,color,z_order)
+        draw_line left_with_border, bottom, right,bottom_with_border
+      end
+
+      def draw_line(start_x,start_y,finish_x,finish_y)
+        window.draw_quad start_x, start_y, color,
+          finish_x, start_y, color,
+          finish_x, finish_y, color,
+          start_x, finish_y, color, z_order
+      end
+
+      def left
+        x
+      end
+
+      def left_with_border
+        x + border
+      end
+
+      def right
+        x + width
+      end
+
+      def right_with_border
+        right + border
+      end
+
+      def top
+        y
+      end
+
+      def top_with_border
+        top + border
+      end
+
+      def bottom
+        y + height
+      end
+
+      def bottom_with_border
+        bottom + border
       end
 
     end