metro 0.3.2 → 0.3.3

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

@@ -0,0 +1,54 @@
+module Metro
+  module UI
+
+    class FPS < Metro::Model
+
+      property :placement, type: :text, default: 'top'
+      property :color, default: "rgba(255,255,255,1.0)"
+
+      property :label, type: :model do
+        create "metro::ui::label", text: "FPS: 0", color: color
+      end
+
+      def valid_placements
+        @valid_placements ||= begin
+          {
+           top_left:     { position: Game.bounds.top_left, align: 'left', vertical_align: 'top' },
+           top:          { position: Point.at(Game.center.x, Game.bounds.top), align: 'center', vertical_align: 'top' },
+           top_right:    { position: Game.bounds.top_right, align: 'right', vertical_align: 'top' },
+           right:        { position: Point.at(Game.bounds.right, Game.center.y), align: 'right', vertical_align: 'center' },
+           bottom_right: { position: Game.bounds.bottom_right, align: 'right', vertical_align: 'bottom' },
+           bottom:       { position: Point.at(Game.center.x, Game.bounds.bottom), align: 'right', vertical_align: 'bottom' },
+           bottom_left:  { position: Game.bounds.bottom_right, align: 'left', vertical_align: 'bottom' },
+           left:         { position: Point.at(Game.bounds.left, Game.center.y), align: 'left', vertical_align: 'center' }
+          }
+        end
+
+        @valid_placements.default = :top
+        @valid_placements
+      end
+
+      def show
+        place_label
+      end
+
+      def place_label
+        placement_hash = valid_placements[placement.to_sym]
+        
+        label.align = placement_hash[:align]
+        label.vertical_align = placement_hash[:vertical_align]
+        label.position = placement_hash[:position]
+      end
+
+      def update
+        label.text = "FPS: #{Gosu.fps}"
+      end
+
+      def draw
+        label.draw
+      end
+
+    end
+
+  end
+end

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

@@ -18,7 +18,14 @@ module Metro
     #
     class Generic < Model
 
-      attr_accessor :warned
+      # @attribute
+      # Sets whether the generic model has warned the user in the logs about it
+      # being a generic model.
+      property :warned, type: :boolean, default: false
+
+      def show
+        self.saveable_to_view = false
+      end
 
       def draw
         log.warn cannot_draw_message unless warned

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

@@ -15,23 +15,35 @@ module Metro
     #
     class GridDrawer < Model
 
+      # @attribute
+      # The position to start drawing the grid
       property :position, default: Point.at(0,0,100)
+
+      # @attribute
+      # The color of the grid lines
       property :color, default: "rgba(255,255,255,0.1)"
+
+      # @attribute
+      # The interval which to draw the lines
       property :spacing, type: :numeric, default: 10
 
+      # @attribute
+      # The dimension of the grid
       property :dimensions do
         Dimensions.of Game.width, Game.height
       end
 
-      def saveable?
-        false
-      end
+      # @attribute
+      # This controls whether the grid should be drawn. By default
+      # the grid will be drawn.
+      property :enabled, type: :boolean, default: true
 
-      def contains?(x,y)
-        false
+      def show
+        self.saveable_to_view = false
       end
 
       def draw
+        return unless enabled
         draw_horizontal_lines
         draw_vertical_lines
       end

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

@@ -13,32 +13,47 @@ module Metro
     #
     class Image < Model
 
+      # @attribute
+      # The position of the image
       property :position
 
+      # @attribute
+      # The scale of the image
       property :scale, default: Scale.one
 
+      # @attribute
+      # The color of the image, by default this is white to display the image
+      # as normal, but this can be used to augment the look of the image. Mostly
+      # color is use for the sub-property :alpha which allows an image to be
+      # faded-in and faded-out
       property :color
 
+      # @attribute
+      # The angle at which to draw the image
       property :angle, type: :numeric, default: 0
 
+      # @attribute
+      # The center x position of the image as expressed in a scale of from left
+      # to right (0.0 to 1.0).
       property :center_x, type: :numeric, default: 0.5
+
+      # @attribute
+      # The center y position of the image as expressed in a scale of from top
+      # to bottom (0.0 to 1.0).
       property :center_y, type: :numeric, default: 0.5
 
+      # @attribute
+      # The image asset to draw.
       property :image
 
+      # @attribute
+      # The dimensions of the image.
       property :dimensions do
         image.dimensions
       end
 
-      def contains?(x,y)
-        bounds.contains?(x,y)
-      end
-
       def bounds
-        Bounds.new x: x - (width * center_x),
-                   y: y - (height * center_y),
-                   width: width,
-                   height: height
+        Bounds.new left: left_x, right: right_x, top: top_y, bottom: bottom_y
       end
 
       def draw
@@ -49,6 +64,23 @@ module Metro
           color
       end
 
+      private
+
+      def left_x
+        x - (width * center_x)
+      end
+
+      def right_x
+        left_x + width
+      end
+
+      def top_y
+        y - (height * center_y)
+      end
+
+      def bottom_y
+        top_y + height
+      end
     end
 
   end

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

@@ -15,21 +15,54 @@ module Metro
     #
     class Label < Model
 
+      # @attribute
+      # The position of the label
       property :position
 
+      # @attribute
+      # The scale of the text
       property :scale, default: Scale.one
 
+      # @attribute
+      # The text color
       property :color, default: "rgba(255,255,255,1.0)"
 
+      # @attribute
+      # The font to use for the label text
       property :font, default: { size: 20 }
 
+      # @attribute
+      # The text to appear on the label
       property :text
 
+      # @attribute
+      # The alignment for the label. This influences where the text draws in
+      # relation to the specified position. Your choices are 'left', 'center',
+      # and 'right'. The default is 'left'.
       property :align, type: :text, default: "left"
+
+      # @attribute
+      # The vertical alignment for the label. This influences where the text
+      # draws in relation to the specified position. Your choices are 'top',
+      # 'center', and 'bottom'. This default is 'top'
       property :vertical_align, type: :text, default: "top"
 
+      # @attribute
+      # When calculating the dimensions of the label, this is the minimum
+      # dimensions. This is necessary in cases when the text is blank. This 
+      # allows for the label to have size when in the edit mode.
+      property :minimum_dimensions, type: :dimensions, default: "16,16"
+
+      # @attribute
+      # The dimensions of label. If the label text is blank, then the dimensions
+      # of the label will return a minimum dimension.
       property :dimensions do
-        Dimensions.of (longest_line * x_factor), (line_height * line_count * 2 * y_factor)
+        calculated = Dimensions.of (longest_line * x_factor), (line_height * line_count * y_factor)
+        [ calculated, minimum_dimensions ].max
+      end
+
+      def bounds
+        Bounds.new left: left_x, right: right_x, top: top_y, bottom: bottom_y
       end
 
       def draw
@@ -38,15 +71,23 @@ module Metro
         end
       end
 
-      def bounds
-        Bounds.new x: x, y: y, width: width, height: height
+      private
+
+      def left_x
+        line_count.times.map { |index| x_position(index) }.min
       end
 
-      def contains?(x,y)
-        bounds.contains?(x,y)
+      def right_x
+        left_x + width
       end
 
-      private
+      def top_y
+        y_position(0)
+      end
+
+      def bottom_y
+        top_y + height
+      end
 
       def line_height
         font.height
@@ -61,7 +102,7 @@ module Metro
       end
 
       def longest_line
-        parsed_text.map { |line| line_width(line) }.max
+        parsed_text.map { |line| line_width(line) }.max || 0
       end
 
       def line_count

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

@@ -56,20 +56,42 @@ module Metro
     #
     class Menu < Model
 
+      # @attribute
+      # The position of the menu
       property :position, default: Game.center
+
+      # @attribute
+      # The alpha level of the menu from 0 to 255.
       property :alpha, default: 255
 
+      # @attribute
+      # The scale at which the menu should be drawn.
       property :scale, default: Scale.one
 
-      property :padding, default: 10
+      # @attribute
+      # The distance between each of the menu items
+      property :padding, default: 20
 
+      # @attribute
+      # The dimensions of the menu. This is based on the items within the
+      # menu.
       property :dimensions do
-        Dimensions.none
+        Dimensions.of (right_x - left_x), (bottom_y - top_y)
       end
 
+      # @attribute
+      # The options that are displayed in the menu. These are by default
+      # 'metro::ui::labels' But can be defined more dynamically as neeeded.
+      #
+      # @see Metro::Model::Property::OptionsProperty
       property :options
 
+      # @attribute
+      # The color for all the currently unselected items.
       property :unselected_color, type: :color, default: "rgba(119,119,119,1.0)"
+
+      # @attribute
+      # The color of the item that currently has focus.
       property :selected_color, type: :color, default: "rgba(255,255,255,1.0)"
 
       def alpha_changed(alpha)
@@ -82,20 +104,51 @@ module Metro
         self.unselected_color_alpha = alpha
       end
 
+      # @attribute
+      # The sample sound that plays when a selection has been made.
       property :selection_sample, type: :sample, path: "menu-selection.wav"
+
+      # @attribute
+      # The sample sound when moving between the different options in the menu.
       property :movement_sample, type: :sample, path: "menu-movement.wav"
 
+      # @attribute
+      # Determines whether the menu is currently enabled or disabled.
       property :enabled, type: :boolean, default: true
 
-      # Allows the menu to be layouted out horizontal or vertical
+      # @attribute
+      # Allows the menu to be layouted out in a 'horizontal' or 'vertical'
+      # fashion. By default this is 'vertical'
       property :layout, type: :text, default: "vertical"
 
-      def contains?(x,y)
-        bounds.contains?(x,y)
+      def bounds
+        Bounds.new left: left_x, right: right_x, top: top_y, bottom: bottom_y
       end
 
-      def bounds
-        Bounds.new x: x, y: y, width: width, height: height
+      #
+      # When the position has changed on every other time beside the first time
+      # we want to update the position of all the options defined in the menu.
+      #
+      def position_changed(new_position)
+        return unless properties[:position]
+        difference = Point.parse(new_position) - Point.parse(properties[:position])
+        options.each { |option| option.position += difference }
+      end
+
+      def left_x
+        options.map {|option| option.bounds.left }.min
+      end
+
+      def right_x
+        options.map {|option| option.bounds.right }.max
+      end
+
+      def top_y
+        options.map {|option| option.bounds.top }.min
+      end
+
+      def bottom_y
+        options.map {|option| option.bounds.bottom }.max
       end
 
       # @TODO: enable the user to define the events for this interaction
@@ -153,7 +206,7 @@ module Metro
       end
 
       def draw
-        options.each_with_index { |label| label.draw }
+        options.each { |label| label.draw }
       end
 
     end

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

@@ -0,0 +1,65 @@
+module Metro
+  module UI
+
+    #
+    # The model label will draw a bounding box and label around another model
+    #
+    # The model label is used by the model labeler which is a facet of the
+    # edit scene
+    #
+    class ModelLabel < Metro::Model
+
+      # Stores the model that is currently being labeled.
+      attr_accessor :target
+
+      def bounds=(bounds)
+        bounding_box.position = bounds.top_left
+        label.position = bounds.top_left + Point.at(4,2,label_z_order)
+        label_background.position = label.position - Point.at(2,0,1)
+      end
+
+      property :bounding_box_color, type: :color, default: "rgba(255,0,0,0.5)"
+      property :font, default: { size: 16 }
+      property :label_color, type: :color, default: "rgba(255,255,255,1.0)"
+      property :label_background_color, type: :color, default: "rgba(255,0,0,0.5)"
+
+      property :should_draw_bounding_box, type: :boolean, default: true
+      property :should_draw_label, type: :boolean, default: true
+
+      property :bounding_box, type: :model do
+        create "metro::ui::border", color: bounding_box_color,
+          dimensions: target.bounds.dimensions
+      end
+
+      property :label, type: :model do
+        create "metro::ui::label", text: target.name, font: font,
+          position: target.bounds.top_left + Point.at(4,2,label_z_order)
+      end
+
+      def label_z_order
+        target.respond_to?(:z_order) ? target.z_order + 2 : 0
+      end
+
+      property :label_background, type: :model do
+        create "metro::ui::rectangle", color: label_background_color,
+          position: label.position - Point.at(2,0,1),
+          dimensions: label.dimensions + Dimensions.of(6,4)
+      end
+
+      def draw
+        draw_bounding_box if should_draw_bounding_box
+        draw_label if should_draw_label
+      end
+
+      def draw_bounding_box
+        bounding_box.draw
+      end
+
+      def draw_label
+        label_background.draw
+        label.draw
+      end
+    end
+
+  end
+end