metro 0.3.3 → 0.3.4

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

@@ -1,7 +1,7 @@
 module Metro
   module UI
 
-    class FPS < Metro::Model
+    class FPS < Model
 
       property :placement, type: :text, default: 'top'
       property :color, default: "rgba(255,255,255,1.0)"

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

@@ -35,9 +35,30 @@ module Metro
       private
 
       def cannot_draw_message
-        [ "Unable to draw #{name} in #{scene}", "",
-          "  The actor named '#{name}' does not specify a suitable model so it could not be drawn in the scene.",
-          "", "  " + properties.to_s, "" ].join("\n")
+        %{Unable to draw #{name} in #{scene}
+
+  The actor named '#{name}' does not specify a suitable model so it could not be drawn in the scene.
+
+  #{properties}
+
+  Did you mean to use one of the following models:
+
+  Models defined in #{Game.name}:
+
+  #{user_defined_models.join(', ')}
+
+  Models defined in Metro:
+
+  #{metro_models.join(', ')}
+}
+      end
+
+      def metro_models
+        Models.list.find_all {|m| m =~ /metro(::|\/).+(::|\/).+/i }
+      end
+
+      def user_defined_models
+        Models.list - metro_models
       end
 
     end

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

@@ -7,7 +7,7 @@ module Metro
     # The model label is used by the model labeler which is a facet of the
     # edit scene
     #
-    class ModelLabel < Metro::Model
+    class ModelLabel < Model
 
       # Stores the model that is currently being labeled.
       attr_accessor :target

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

@@ -9,7 +9,7 @@ module Metro
     # the bounding boxes and labeles around all the actors within the scene
     # being edited.
     #
-    class ModelLabeler < Metro::Model
+    class ModelLabeler < Model
 
       # @attribute
       # The color use for the border surrounding each actor and the background
@@ -58,7 +58,7 @@ module Metro
           label = labels[drawer.name]
 
           unless label
-            label = create "metro::ui::modellabel", target: drawer
+            label = create "metro::ui::model_label", target: drawer
             labels[drawer.name] = label
           end
 

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

@@ -12,7 +12,7 @@ module Metro
     #         color: "rgba(255,0,0,1.0)", dimensions: "200,200"
     #     end
     #
-    class Rectangle < ::Metro::Model
+    class Rectangle < Model
 
       # @attribute
       # The position of the upper-left corner of the rectangle

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

@@ -0,0 +1,79 @@
+module Metro
+  module UI
+
+    #
+    # A sprite is a Metro model that is specially designed to draw and manage
+    # an image. A sprite maintains an image, location information, and rotation.
+    #
+    class Sprite < Model
+
+      # @attribute
+      # The image that will be drawn for the sprite
+      property :image
+
+      # @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.5
+
+      # @attribute
+      # The center, vertical position, as expressed in a ratio, of the image.
+      property :center_y, type: :numeric, default: 0.5
+
+      # @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
+        image.dimensions
+      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
+
+      #
+      # By default the sprite will draw the image defined for it.
+      #
+      def draw
+        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/ui.rb

@@ -0,0 +1,12 @@
+require_relative 'generic'
+require_relative 'label'
+require_relative 'menu'
+require_relative 'image'
+require_relative 'rectangle'
+require_relative 'grid_drawer'
+require_relative 'border'
+require_relative 'model_label'
+require_relative 'model_labeler'
+require_relative 'fps'
+require_relative 'sprite'
+require_relative 'animated_sprite'

data/lib/metro/scene.rb

@@ -1,9 +1,5 @@
 require_relative 'views/scene_view'
-
-require_relative 'events/has_events'
-require_relative 'events/event_relay'
-require_relative 'events/unknown_sender'
-
+require_relative 'events/events'
 require_relative 'models/draws'
 
 require_relative 'animation/has_animations'
@@ -19,7 +15,6 @@ module Metro
   # @see #show
   # @see #update
   # @see #draw
-  # @see #events
   #
   # A fair number of private methods within Scene are prefaced with an underscore.
   # These methods often call non-underscored methods within those methods. This allows
@@ -102,16 +97,12 @@ module Metro
     end
 
     #
-    # Post a custom notification event. This will trigger any objects that are listening
-    # for custom events.
+    # Post a custom notification event. This will trigger an event for all the
+    # objects that are registered for notification with the current state.
     #
     def notification(event,sender=nil)
-
       sender = sender || UnknownSender
-
-      event_relays.each do |relay|
-        relay.fire_events_for_notification(event,sender)
-      end
+      state.fire_events_for_notification(event,sender)
     end
 
     #
@@ -203,7 +194,8 @@ module Metro
     def window=(window)
       @window = window
 
-      event_relays.clear
+      state.window = window
+      state.clear
 
       register_events!
       register_actors!
@@ -335,11 +327,9 @@ module Metro
     #
     # Captures all classes that subclass Scene.
     #
-    # @see #self.scenes
-    #
     def self.inherited(base)
       scenes << base.to_s
-      Scenes.add_scene(base)
+      Scenes.add(base)
     end
 
     #
@@ -455,58 +445,20 @@ module Metro
     #   be mapped to the specified target.
     #
     def register_events_for_target(target,events)
-      target_relay = EventRelay.new(target,window)
-
-      events.each do |target_event|
-        target_relay.send target_event.event, *target_event.buttons, &target_event.block
-      end
-
-      event_relays.push(target_relay)
+      state.add_events_for_target(target,events)
     end
 
     #
-    # The events object that is configured through the {#events} method, which stores
-    # all the gamepad and keyboard events defined. By default a scene has an event
-    # relay defined. Additional relays can be defined based on the components added.
+    # The event state manager is configured through the {#events} method, which
+    # stores all the gamepad and keyboard events defined. By default a scene is
+    # placed in the default state and events that are added to this basic state.
     #
     # @see Events
-    # @see #add_event_relay
     #
-    def event_relays
-      @event_relays ||= []
+    def state
+      @event_state_manager ||= EventStateManager.new
     end
 
-    #
-    # This method is called during a scene update and will fire all the events
-    # that have been defined for all held buttons for all defined event relays.
-    #
-    def fire_events_for_held_buttons
-      event_relays.each do |relay|
-        relay.fire_events_for_held_buttons
-      end
-    end
-
-    #
-    # This method is called before a scene update and passes the button up events
-    # to each of the defined event relays.
-    #
-    def button_up(id)
-      event_relays.each do |relay|
-        relay.fire_button_up(id)
-      end
-    end
-
-    #
-    # This method is called before a scene update and passes the button down events
-    # to each of the defined event relays.
-    #
-    def button_down(id)
-      event_relays.each do |relay|
-        relay.fire_button_down(id)
-      end
-    end
-
-
     #
     # A Scene represented as a hash currently only contains the drawers
     #

data/lib/metro/scenes.rb

@@ -33,7 +33,7 @@ module Metro
     #
     # @param [Scene] scene the scene to be added to the hash of Scenes.
     #
-    def add_scene(scene)
+    def add(scene)
       all_scenes_for(scene).each { |scene| scenes_hash[scene.scene_name] = scene.to_s }
     end
 
@@ -44,7 +44,14 @@ module Metro
     # @return the Scene class that is found matching the specified scene name.
     #
     def find(scene_name)
-      scene_class( scenes_hash[scene_name] )
+      scenes_hash[scene_name].constantize
+    end
+
+    #
+    # @return [Array<String>] all the names supported by the scenes hash.
+    #
+    def list
+      scenes_hash.keys
     end
 
     #
@@ -119,7 +126,7 @@ module Metro
     #
     def hash_with_missing_scene_default
       hash = HashWithIndifferentAccess.new do |hash,key|
-        missing_scene = scene_class(hash[:missing_scene])
+        missing_scene = hash[:missing_scene].constantize
         missing_scene.missing_scene = key.to_sym
         missing_scene
       end
@@ -136,20 +143,11 @@ module Metro
     #
     def all_scenes_for(scenes)
       Array(scenes).map do |scene_class_name|
-        scene = scene_class(scene_class_name)
+        scene = scene_class_name.constantize
         [ scene ] + all_scenes_for(scene.scenes)
       end.flatten.compact
     end
 
-    #
-    # @param [String,Symbol] class_name the name of the class that you want the class
-    #
-    # @return the class with the given class name
-    #
-    def scene_class(class_or_class_name)
-      class_or_class_name.class == Class ? class_or_class_name : class_or_class_name.constantize
-    end
-
   end
 end
 

data/lib/metro/transitions/edit_transition_scene.rb

@@ -28,8 +28,8 @@ module Metro
       # easier to dup scenes.
       #
       self.class.drawings.clear
-      self.class.draw :overlay, model: "metro::ui::griddrawer"
-      self.class.draw :labeler, model: "metro::ui::modellabeler"
+      self.class.draw :overlay, model: "metro::ui::grid_drawer"
+      self.class.draw :labeler, model: "metro::ui::model_labeler"
       add_actors_to_scene
       after_initialize
     end

data/lib/metro/units/calculation_validations.rb

@@ -0,0 +1,74 @@
+module Metro
+  module Units
+    module CalculationValidations
+
+      #
+      # @param [Object] value the other object that needs to be validated.
+      #
+      def check_calculation_requirements(value)
+        if calculation_requirements.find { |method| ! value.respond_to?(method) }
+          raise "Unable to perform operation with #{value} #{value.class} It is missing a property #{calculation_requirements.join(",")}"
+        end
+      end
+
+      #
+      # @return [Array] an array of methods that are required to be on the
+      #   object for it to be correctly calculated.
+      #
+      # @note this method is intended to be defined in the including class. This
+      #   method is included here when one has not been provided.
+      def calculation_requirements
+        []
+      end
+
+      #
+      # Add this object to another object.
+      #
+      # @return a new object that is the sum of the two objects
+      #
+      def +(value)
+        self.class.new *calculate(value,:+)
+      end
+
+      #
+      # Subtract the other object from this object.
+      #
+      # @return a new object that is the difference of the original object
+      #   and the value specified.
+      #
+      def -(value)
+        self.class.new *calculate(value,:-)
+      end
+
+      #
+      # Multiply this object and another object.
+      #
+      # @return a new object that is the product of the two objects.
+      #
+      def *(value)
+        self.class.new *calculate(value,:*)
+      end
+
+      #
+      # This generic method will perform the calculation defined by the
+      # operation for all the calculation requirements defined.
+      #
+      # @param [value] value this is the other value that is being added,
+      #   subtracted, etc. to the current object.
+      # @param [Symbol] operation this is the mathematical operation that
+      #   is being performed between all the calc requirements of the current
+      #   object and other value.
+      #
+      # @return [Array] an array of reults from the calculations of all the
+      #   requirements.
+      #
+      def calculate(value,operation)
+        check_calculation_requirements(value)
+        calculation_requirements.map do |requirement|
+          send(requirement).send(operation,value.send(requirement))
+        end
+      end
+
+    end
+  end
+end

data/lib/metro/units/dimensions.rb

@@ -5,6 +5,7 @@ module Metro
     # Represents an object that contains both the width and height.
     #
     class Dimensions < Struct.new(:width,:height)
+      include CalculationValidations
 
       #
       # Create a dimensions objects with zero width and zero height.
@@ -37,30 +38,21 @@ module Metro
       end
 
       #
-      # Add the dimensions to another dimensions-like structure. A
-      # dimensions like structure is anything that responds to width and height.
+      # Compare the dimension to another dimensions-like structure.
       #
-      # @return a new dimensions which is the sum of the two dimensions
+      # @return [Fixnum] -1 if the dimensions is smaller than the other dimension,
+      #   0 if the dimensions are exactly the same, 1 if the dimensions are bigger
+      #   then the other dimensions.
       #
-      def +(value)
-        raise "Unable to add dimension to #{value} #{value.class}" if [ :width, :height ].find { |method| ! value.respond_to?(method) }
-        self.class.of (width + value.width.to_f), (height + value.height.to_f)
+      def <=>(value)
+        check_calculation_requirements(value)
+        (width * height) <=> (value.width * value.height)
       end
 
-      #
-      # Subtract the dimensions-like structure from this dimension. A
-      # dimensions like structure is anything that responds to width and height.
-      #
-      # @return a new dimensions which is the different of the two dimensions
-      #
-      def -(value)
-        raise "Unable to subtract from these dimensions with #{value} #{value.class}" if [ :width, :height ].find { |method| ! value.respond_to?(method) }
-        self.class.of (width - value.width.to_f), (height - value.height.to_f)
-      end
+      private
 
-      def <=>(value)
-        raise "Unable to subtract from these dimensions with #{value} #{value.class}" if [ :width, :height ].find { |method| ! value.respond_to?(method) }
-        (width * height) <=> (value.width * value.height)
+      def calculation_requirements
+        [ :width, :height ]
       end
 
     end