metro 0.3.2 → 0.3.3

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

@@ -0,0 +1,79 @@
+module Metro
+  module UI
+
+    #
+    # The model labeler will draw a bounding box and label around all the
+    # scene's drawers.
+    #
+    # The model labeler is used in the edit transition scene to generate
+    # the bounding boxes and labeles around all the actors within the scene
+    # being edited.
+    #
+    class ModelLabeler < Metro::Model
+
+      # @attribute
+      # The color use for the border surrounding each actor and the background
+      # behind the model's name.
+      property :color, default: "rgba(255,0,0,0.5)"
+
+      # @attribute
+      # Sets whether to draw the bounding boxes around the actors.
+      property :should_draw_bounding_boxes, type: :boolean, default: true
+
+      # @attribute
+      # The color of the model name text.
+      property :label_color, default: "rgba(255,255,255,1.0)"
+
+      # @attribute
+      # The font of the model name label.
+      property :font, default: { name: 'Arial', size: 16 }
+
+      # @attribute
+      # Sets whether to draw the model name labels
+      property :should_draw_labels, type: :boolean, default: true
+
+      # @attribute
+      # For actors that have no bounds, like sound or custom models without
+      # a position, they are normally hidden but can be shown. Currently they
+      # appear all overlapped in the upper-left corner of the screen.
+      #
+      # @todo when enabled the boundless actors should be presented in a cleaner
+      #   way to allow for easier viewing of them.
+      property :should_hide_boundless_actors, type: :boolean, default: true
+
+      # Store the labels that are being drawn in the scene. This hash of labels
+      # acts as a cache around the items that are being labeled based on the
+      # name of the objects that are being labeled.
+      def labels
+        @labels ||= {}
+      end
+
+      def show
+        self.saveable_to_view = false
+      end
+
+      def update
+        scene.drawers.each do |drawer|
+          next if (drawer.bounds == Bounds.none and should_hide_boundless_actors)
+          label = labels[drawer.name]
+
+          unless label
+            label = create "metro::ui::modellabel", target: drawer
+            labels[drawer.name] = label
+          end
+
+          label.should_draw_label = should_draw_labels
+          label.should_draw_bounding_box = should_draw_bounding_boxes
+          label.bounds = drawer.bounds
+        end
+
+      end
+
+      def draw
+        labels.values.each { |label| label.draw }
+      end
+
+    end
+
+  end
+end

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

@@ -14,10 +14,16 @@ module Metro
     #
     class Rectangle < ::Metro::Model
 
+      # @attribute
+      # The position of the upper-left corner of the rectangle
       property :position
 
+      # @attribute
+      # The color to rectangle
       property :color
 
+      # @attribute
+      # The dimensions of the rectangle
       property :dimensions do
         window.dimensions
       end

data/lib/metro/scene.rb

@@ -513,7 +513,7 @@ module Metro
     # @return a hash of all the drawers
     #
     def to_hash
-      drawn = drawers.find_all{|draw| draw.saveable? }.inject({}) do |hash,drawer|
+      drawn = drawers.find_all{|draw| draw.saveable_to_view }.inject({}) do |hash,drawer|
         drawer_hash = drawer.to_hash
         hash.merge drawer_hash
       end

data/lib/metro/transitions/edit_transition_scene.rb

@@ -2,6 +2,19 @@ require_relative '../events/hit_list'
 
 module Metro
 
+  #
+  # The Edit Transition Scene is place where scenes go to be edited. Any scene
+  # can transition into edit mode. This scene will copy all the actors and
+  # gain access to the view.
+  #
+  # This scene grants new keyboard commands that will enable, disable, and
+  # toggle feature of edit mode:
+  #
+  # * `e` will end edit mode
+  # * `g` will toggle the display of the grid
+  # * `l` will toggle the display of the model labels
+  # * `b` will toggle the bounding boxes around the models.
+  #
   class EditTransitionScene < Metro::TransitionScene
 
     def initialize
@@ -15,7 +28,8 @@ module Metro
       # easier to dup scenes.
       #
       self.class.drawings.clear
-      self.class.draw :overlay, model: "Metro::UI::GridDrawer"
+      self.class.draw :overlay, model: "metro::ui::griddrawer"
+      self.class.draw :labeler, model: "metro::ui::modellabeler"
       add_actors_to_scene
       after_initialize
     end
@@ -44,6 +58,18 @@ module Metro
       transition_to next_scene.scene_name
     end
 
+    event :on_up, KbG do
+      overlay.enabled = !overlay.enabled
+    end
+
+    event :on_up, KbL do
+      labeler.should_draw_labels = !labeler.should_draw_labels
+    end
+
+    event :on_up, KbB do
+      labeler.should_draw_bounding_boxes = !labeler.should_draw_bounding_boxes
+    end
+
     #
     # Generate a hitlist which manages the click start, hold, and release
     # of the mouse button.
@@ -65,6 +91,7 @@ module Metro
     end
 
     event :on_up, KbS do
+      log.info "Saving changes to Scene #{previous_scene} View - #{view_name}"
       save_view
     end
 

data/lib/metro/units/dimensions.rb

@@ -19,7 +19,7 @@ module Metro
       # two attributes width and height.
       #
       def self.parse(string)
-        of *string.split(",",2).map(&:to_f)
+        of *string.to_s.split(",",2).map(&:to_f)
       end
 
 
@@ -28,7 +28,7 @@ module Metro
       # will enforce that the values added are converted to floating
       # point numbers.
       #
-      def self.of(width,height)
+      def self.of(width=0.0,height=0.0)
         new width.to_f, height.to_f
       end
 
@@ -36,6 +36,33 @@ module Metro
         "#{width},#{height}"
       end
 
+      #
+      # Add the dimensions to another dimensions-like structure. A
+      # dimensions like structure is anything that responds to width and height.
+      #
+      # @return a new dimensions which is the sum of the two 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)
+      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
+
+      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)
+      end
+
     end
   end
 end

data/lib/metro/units/point.rb

@@ -40,14 +40,26 @@ module Metro
       end
 
       #
-      # Add the point to another point-like structure. Anything that also has
-      # the methods x, y, and z.
+      # Add this point to another another point-like structure. A point like structure
+      # is anything has the methods x, y, and z.
       #
       # @return a new point which is the sum of the point and the provided value.
       #
       def +(value)
-        raise "Unabled to add point to #{value} #{value.class}" if [ :x, :y, :z ].find { |method| ! value.respond_to?(method) }
-        self.class.at((x + value.x),(y + value.y),(z + value.z))
+        raise "Unable to add point to #{value} #{value.class}" if [ :x, :y, :z ].find { |method| ! value.respond_to?(method) }
+        self.class.at (x + value.x.to_f), (y + value.y.to_f), (z + value.z.to_f)
+      end
+
+      #
+      # Subtract the point-like structure from this point. A point like structure
+      # is anything has the methods x, y, and z.
+      #
+      # @return a new point which is the difference of the point and the
+      #   provided value.
+      #
+      def -(value)
+        raise "Unable to subtract from this point with #{value} #{value.class}" if [ :x, :y, :z ].find { |method| ! value.respond_to?(method) }
+        self.class.at (x - value.x.to_f), (y - value.y.to_f), (z - value.z.to_f)
       end
 
     end

data/lib/metro/units/rectangle_bounds.rb

@@ -4,46 +4,68 @@ module Metro
     #
     # An object that represents a rectanglar bounds.
     #
-    class RectangleBounds < Struct.new(:min_x,:min_y,:max_x,:max_y)
+    class RectangleBounds
 
       # Allow the ability to refer to the min, max values with their
       # other alternate names.
 
-      alias_method :left, :min_x
-      alias_method :left=, :min_x=
-      alias_method :right, :max_x
-      alias_method :right=, :max_x=
-      alias_method :top, :min_y
-      alias_method :top=, :min_y=
-      alias_method :bottom, :max_y
-      alias_method :bottom=, :max_y=
+      attr_accessor :left, :right, :top, :bottom
+
+      def self.none
+        new left: 0, right: 0, top: 0, bottom: 0
+      end
 
       #
       # Create a bounds with bounds.
       #
       def initialize(params = {})
-        self.min_x = params[:x] || params[:min_x]
-        self.min_y = params[:y] || params[:min_y]
-        self.max_x = (params[:max_x] || (min_x + params[:width]))
-        self.max_y = (params[:max_y] || (min_y + params[:height]))
+        @left = params[:left].to_f
+        @top = params[:top].to_f
+        @right = params[:right].to_f
+        @bottom = params[:bottom].to_f
+      end
+
+      def top_left
+        Point.at(left,top)
+      end
+
+      def top_right
+        Point.at(right,top)
+      end
+
+      def bottom_right
+        Point.at(right,bottom)
+      end
+
+      def bottom_left
+        Point.at(left,bottom)
+      end
+
+      def dimensions
+        Dimensions.of (right - left), (bottom - top)
+      end
+
+      def ==(value)
+        return if [ :left, :right, :top, :bottom ].find { |method| ! value.respond_to?(method) }
+        left == value.left and right == value.right and top == value.top and bottom == value.bottom
       end
 
       #
       # Does this bounds contain the following point?
       #
       def contains?(x,y)
-        x > min_x and x < max_x and y > min_y and y < max_y
+        x > left and x < right and y > top and y < bottom
       end
 
       #
       # Does this rectanglular bounds intersect with another rectanglular bounds?
       #
       def intersect?(b)
-        not(b.min_x > max_x or b.max_x < min_x or b.min_y > max_y or b.max_y < min_y)
+        not(b.left > right or b.right < left or b.top > bottom or b.bottom < top)
       end
 
       def to_s
-        "(#{min_x},#{min_y}) to (#{max_x},#{max_y})"
+        "(#{left},#{top}) to (#{right},#{bottom})"
       end
 
     end

data/lib/metro/version.rb

@@ -1,5 +1,5 @@
 module Metro
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
   WEBSITE = "https://github.com/burtlo/metro"
   CONTACT_EMAILS = ["dev@rubymetro.com"]
   

data/lib/setup_handlers/reload_game_on_game_file_changes.rb

@@ -64,9 +64,14 @@ module Metro
       def reload_game_because_files_changed(changed)
         log.debug "Metro has detected #{changed.count} game source #{changed.count != 1 ? 'files have' : 'file has'} changed. RELOADING GAME CODE!"
         if Metro.game_has_valid_code?
-          Game.current_scene.after(1.tick) { Metro.reload! ; transition_to(scene_name) }
+          Game.current_scene.after(1.tick) do
+            Metro.reload!
+            scene_is_being_edited = scene_name == "metro/edit_transition"
+            transition_to(scene_name) unless scene_is_being_edited
+          end
         end
       end
+
     end
   end
 

data/lib/templates/game/scenes/first_scene.rb

@@ -1,4 +1,8 @@
 class FirstScene < GameScene
+  
+  if Game.debug?
+    draw :fps, model: "metro::ui::fps", placement: 'bottom_right'
+  end
 
   draw :hero, position: Game.center
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metro
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -182,6 +182,7 @@ files:
 - lib/metro/models/properties/dimensions_property.rb
 - lib/metro/models/properties/font_property.rb
 - lib/metro/models/properties/image_property.rb
+- lib/metro/models/properties/model_property.rb
 - lib/metro/models/properties/numeric_property.rb
 - lib/metro/models/properties/options_property/no_option.rb
 - lib/metro/models/properties/options_property/options.rb
@@ -193,11 +194,15 @@ files:
 - lib/metro/models/properties/scale_property.rb
 - lib/metro/models/properties/song_property.rb
 - lib/metro/models/properties/text_property.rb
+- lib/metro/models/ui/border.rb
+- lib/metro/models/ui/fps.rb
 - lib/metro/models/ui/generic.rb
 - lib/metro/models/ui/grid_drawer.rb
 - lib/metro/models/ui/image.rb
 - lib/metro/models/ui/label.rb
 - lib/metro/models/ui/menu.rb
+- lib/metro/models/ui/model_label.rb
+- lib/metro/models/ui/model_labeler.rb
 - lib/metro/models/ui/rectangle.rb
 - lib/metro/parameters/command_line_args_parser.rb
 - lib/metro/parameters/options.rb
@@ -279,12 +284,13 @@ licenses:
 post_install_message: ! "    ______  ___      _____\n    ___   |/  /_____ __  /_______________\n
   \   __  /|_/ / _  _ \\_  __/__  ___/_  __ \\\n    _  /  / /  /  __// /_  _  /    /
   /_/ /\n    /_/  /_/   \\___/  \\__/ /_/     \\____/\n\n  Thank you for installing
-  metro 0.3.2 / 2012-11-26.\n  ---------------------------------------------------------------------\n
-  \ Changes:\n    \n  * Debug Mode will now automatically reload the game and scene
-  on source\n    file changes.\n  * Reloading the game will no longer take down the
-  app for syntax errors\n    and other errors that are easily detected by simply loading
-  the code.\n  * Template game is now automatically has debug mode enabled by default\n
-  \ \n\n  ---------------------------------------------------------------------\n"
+  metro 0.3.3 / 2012-11-28.\n  ---------------------------------------------------------------------\n
+  \ Changes:\n    \n  * Edit Mode - actors within a scene can have their position
+  edited\n    and saved. Actors within the scene that have a valid bounds\n    specified
+  will appear within the scene with name and bounding box.\n  * Dimensions can now
+  be defined as strings\n  * Game bounds and Game dimensions return objects of that
+  type\n  * `metr::ui::fps` added and has some shortcut placements settings\n  \n\n
+  \ ---------------------------------------------------------------------\n"
 rdoc_options: []
 require_paths:
 - lib