metro 0.1.2 → 0.1.3

data/lib/metro/models/menu.rb

@@ -10,25 +10,26 @@ module Metro
     #
     class Menu < Model
 
-      event :on_up, Gosu::KbLeft, Gosu::GpLeft, Gosu::KbUp, Gosu::GpUp do
+      event :on_up, KbLeft, GpLeft, KbUp, GpUp do
         previous_option
       end
 
-      event :on_up, Gosu::KbRight, Gosu::GpRight, Gosu::KbDown, Gosu::GpDown do
+      event :on_up, KbRight, GpRight, KbDown, GpDown do
         next_option
       end
 
-      event :on_up, Gosu::KbEnter, Gosu::KbReturn, Gosu::GpButton0 do
+      event :on_up, KbEnter, KbReturn, GpButton0 do
         selection
       end
 
       attr_reader :selected_index, :menu_options
 
-      attr_accessor :padding
+      attr_accessor :padding, :z_order
 
       def after_initialize
         @selected_index = 0
         @padding = 40
+        @z_order = 1
       end
 
       def window=(value)
@@ -79,7 +80,7 @@ module Metro
           draw_color = highlight_color if index == selected_index
 
           y_position = y + padding * index
-          font.draw option_name, x, y_position, Metro::Game::UI, 1.0, 1.0, draw_color
+          font.draw option_name, x, y_position, z_order, 1.0, 1.0, draw_color
         end
       end
 

data/lib/metro/models/model.rb

@@ -1,3 +1,5 @@
+require_relative 'key_value_coding'
+
 module Metro
 
   #
@@ -32,6 +34,8 @@ module Metro
     # @see Scene
     attr_accessor :scene
 
+    include KeyValueCoding
+
     #
     # This is an entry point for customization. As the model's {#initialize}
     # method performs may perform some initialization that may be necessary.
@@ -44,14 +48,14 @@ module Metro
     # Generate a custom notification event with the given name.
     #
     # @param [Symbol] event the name of the notification to generate.
-    # 
+    #
     def notification(event)
       scene.notification(event.to_sym)
     end
 
     #
     # Allows for the definition of events within the scene.
-    # 
+    #
     include HasEvents
 
     #
@@ -62,7 +66,9 @@ module Metro
     #
     # @see #alpha
     #
-    attr_reader :color
+    def color
+      @color
+    end
 
     #
     # Sets the color of the model.
@@ -199,4 +205,5 @@ end
 require_relative 'generic'
 require_relative 'label'
 require_relative 'menu'
-require_relative 'image'
+require_relative 'image'
+require_relative 'rectangle'

data/lib/metro/models/rectangle.rb

@@ -0,0 +1,28 @@
+module Metro
+  module Models
+
+    class Rectangle < ::Metro::Model
+
+      attr_accessor :x, :y, :z_order, :width, :height
+
+      def after_initialize
+        @x = @y = 0
+        @z_order = 1
+      end
+
+      def width
+        @width || window.width
+      end
+
+      def height
+        @height || window.height
+      end
+
+      def draw
+        window.draw_quad(x,y,color,width,x,color,
+                         width,height,color,y,height,color,
+                         z_order)
+      end
+    end
+  end
+end

data/lib/metro/scene.rb

@@ -7,7 +7,8 @@ require_relative 'events/unknown_sender'
 require_relative 'models/draws'
 
 require_relative 'animation/has_animations'
-require_relative 'animation/animation'
+require_relative 'animation/scene_animation'
+require_relative 'animation/after_interval_factory'
 
 module Metro
 
@@ -91,8 +92,12 @@ module Metro
     #
     # @return the actor with the given name.
     #
-    def actor(name)
-      send(name)
+    def actor(actor_or_actor_name)
+      if actor_or_actor_name.is_a? String or actor_or_actor_name.is_a? Symbol
+        send(actor_or_actor_name)
+      else
+        actor_or_actor_name
+      end
     end
 
     #
@@ -125,6 +130,47 @@ module Metro
     #
     include HasAnimations
 
+    #
+    # Allow the definition of a updater that will be executed when the scene starts.
+    #
+    # @example Setting up an event to 2 seconds after the scene has started.
+    #
+    #     class ExampleScene
+    #
+    #       draws :title
+    #
+    #       after 2.seconds do
+    #         transition_to :next_scene
+    #       end
+    #     end
+    #
+    def self.after(ticks,&block)
+      after_intervals.push AfterIntervalFactory.new ticks, &block
+    end
+
+    #
+    # Perform an operation after the specified interval.
+    #
+    #     class ExampleScene
+    #
+    #       draws :player
+    #
+    #       def update
+    #         if player.is_dead?
+    #           after 2.seconds do
+    #             transition_to :game_over
+    #           end
+    #         end
+    #       end
+    #
+    #     end
+    #
+    def after(ticks,&block)
+      tick = OnUpdateOperation.new interval: ticks, context: self
+      tick.on_complete(&block)
+      enqueue tick
+    end
+
     #
     # Setups up the Actors for the Scene based on the ModelFactories that have been
     # defined.
@@ -166,6 +212,7 @@ module Metro
       register_events!
       register_actors!
       register_animations!
+      register_after_intervals!
 
       show
     end
@@ -189,7 +236,13 @@ module Metro
     #
     def register_animations!
       self.class.animations.each do |animation|
-        animate animation.options, &animation.on_complete_block
+        animate animation.actor, animation.options, &animation.on_complete_block
+      end
+    end
+
+    def register_after_intervals!
+      self.class.after_intervals.each do |after_interval|
+        after after_interval.ticks, &after_interval.block
       end
     end
 
@@ -282,13 +335,20 @@ module Metro
     # A simplier syntax to enqueue an animation. At the moment this animation is going
     # to be an implicit animation.
     #
-    def animate(options,&block)
-      options[:actor] = actor(options[:actor]) if options[:actor].is_a? Symbol
-      animation = Metro::ImplicitAnimation.new options.merge(context: self)
-      animation.on_complete(&block) if block
-      enqueue animation
+    def animate(actor_or_actor_name,options,&block)
+      options[:actor] = actor(actor_or_actor_name)
+      options[:context] = self
+      animation_group = SceneAnimation.build options, &block
+      enqueue animation_group
     end
 
+    #
+    # The class defined updaters which will be converted to instance updaters when the scene
+    # has started.
+    #
+    def self.after_intervals
+      @after_intervals ||= []
+    end
 
     #
     # The objects that need to be executed on every update. These objects are traditionally
@@ -334,11 +394,12 @@ module Metro
     # `transition_to` performs the work of transitioning this scene
     # to another scene.
     #
-    # @param [String,Symbol,Class] scene_name the name of the Scene which can be either
-    #   the class or a string/symbol representation of the shortened scene name.
+    # @param [String,Symbol,Object] scene_or_scene_name the name of the Scene which can
+    #   be either the class or a string/symbol representation of the shortened scene name.
+    #   This could also be an instance of scene.
     #
-    def transition_to(scene_name)
-      new_scene = Scenes.generate(scene_name)
+    def transition_to(scene_or_scene_name,options = {})
+      new_scene = Scenes.generate(scene_or_scene_name,options)
       _prepare_transition(new_scene)
       window.scene = new_scene
     end
@@ -412,7 +473,7 @@ module Metro
     #
     def button_up(id)
       event_relays.each do |relay|
-        relay.button_up(id)
+        relay.fire_button_up(id)
       end
     end
 
@@ -422,7 +483,7 @@ module Metro
     #
     def button_down(id)
       event_relays.each do |relay|
-        relay.button_down(id)
+        relay.fire_button_down(id)
       end
     end
 

data/lib/metro/scene_view/yaml_view.rb

@@ -12,7 +12,7 @@ module Metro
       # @return a true if the yaml view exists and false if it does not exist.
       #
       def self.exists?(view_name)
-        File.exists? yaml_view_name(view_name)
+        yaml_view_names(view_name).find { |view_name| File.exists? view_name }
       end
 
       #
@@ -25,12 +25,19 @@ module Metro
         YAML.load File.read yaml_view_name(view_name)
       end
 
+      #
+      # A helper method to get the view file.
+      # 
+      def self.yaml_view_name(view_name)
+        yaml_view_names(view_name).find { |view_name| File.exists? view_name }
+      end
+
       #
       # A helper method to generate the name of the yaml view file. In this case
-      # it is the view name with the suffix .yaml.
+      # it is the view name with the suffix `.yaml` or `.yml`.
       #
-      def self.yaml_view_name(view_name)
-        File.extname(view_name) == "" ? "#{view_name}.yaml" : view_name
+      def self.yaml_view_names(view_name)
+        File.extname(view_name) == "" ? [ "#{view_name}.yaml", "#{view_name}.yml" ] : [ view_name ]
       end
     end
 

data/lib/metro/scenes.rb

@@ -1,3 +1,5 @@
+require_relative 'transitions/scene_transitions'
+
 module Metro
 
   #
@@ -49,11 +51,33 @@ module Metro
     # Finds the scene with the specified name and then creates an instance of that
     # scene.
     #
-    # @param [String,Symbol] scene_name the name of the scene to locate.
+    # @param [String,Symbol,Object] scene_name the name of the scene to locate.
     # @return an instance of Scene that is found matching the specified scene name
     #
-    def generate(scene_name)
-      find(scene_name).new
+    def generate(scene_or_scene_name,options = {})
+      new_scene = use_scene_or_generate_scene(scene_or_scene_name)
+
+      post_filters.inject(new_scene) {|scene,post| post.filter(scene,options) }
+    end
+
+    #
+    # If we have been given a scene, then we simply want to use it otherwise
+    # we need to find and generate our scene from the scene name.
+    # 
+    def use_scene_or_generate_scene(scene_or_scene_name)
+      if scene_or_scene_name.is_a? Scene
+        scene_or_scene_name
+      else
+        find(scene_or_scene_name).new
+      end
+    end
+
+    #
+    # Post filters are applied to the scene after it has been found. These are
+    # all objects that can respond to the #filter method.
+    # 
+    def post_filters
+      [ SceneTransitions ]
     end
 
     private

data/lib/metro/template_message.rb

@@ -2,18 +2,47 @@ class TemplateMessage
 
   def initialize(details = {})
     @messages = Array(details[:message]) + Array(details[:messages])
+    @details = details[:details]
     @website = details[:website]
-    @email = Array(details[:email])
+    @email = details[:contact]
   end
 
-  attr_reader :messages
+  class Message
+    
+    attr_reader :name, :details
+    
+    def initialize(name,details)
+      @name = name
+      @details = details
+    end
+
+    def field_locale(field)
+      I18n.t("#{name}.#{field}",details)
+    end
+
+    def title
+      field_locale 'title'
+    end
+
+    def message
+      field_locale 'message'
+    end
+
+    def actions
+      Array( field_locale('actions') ).map {|action| "* #{action}" }.join("\n")
+    end
+  end
+
+  def messages
+    @messages.map {|m| Message.new m, @details }
+  end
 
   def website
-    "* #{@website}"
+    Array(@website).map {|website| "* #{website}" }.join("\n")
   end
 
   def email
-    @email.map {|email| "* #{email}" }.join("\n")
+    Array(@email).map {|email| "* #{email}" }.join("\n")
   end
 
   def message_filename

data/lib/metro/transitions/fade_transition_scene.rb

@@ -0,0 +1,59 @@
+module Metro
+  class FadeTransitionScene < TransitionScene
+
+    draw :rectangle, model: "metro::models::rectangle"
+
+    #
+    # When the scene is shown set up the starting color for the rectangle
+    # and queue the animation to transition the color to the final color.
+    #
+    def show
+      rectangle.color = starting_color
+
+      animate :rectangle, to: { color: final_color }, interval: interval do
+        transition_to next_scene
+      end
+    end
+
+    def interval
+      options[:interval] || default_interval
+    end
+
+    def default_interval
+      60
+    end
+
+    def starting_color
+      options_starting_color || default_starting_color
+    end
+
+    def options_starting_color
+      color_from_options(:from)
+    end
+
+    def default_starting_color
+      Gosu::Color.new "rgb(255,255,255)"
+    end
+
+    def final_color
+      options_final_color || default_final_color
+    end
+
+    def options_final_color
+      color_from_options(:to)
+    end
+
+    def default_final_color
+      Gosu::Color.new "rgb(0,0,0)"
+    end
+
+    def color_from_options(position)
+      if options[position]
+        if options[position][:color]
+          Gosu::Color.new options[position][:color]
+        end
+      end
+    end
+
+  end
+end