metro-ld25 0.3.3

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

@@ -0,0 +1,84 @@
+module Metro
+  class Model
+
+    #
+    # A sample property maintains a Gosu::Sample.
+    #
+    # A sample is stored in the properties as the path in the assets folder and is converted into
+    # a Gosu::Sample when it is retrieved within the system. When retrieving a sample the Sample
+    # Property will attempt to use a sample that already exists that meets that criteria.
+    #
+    # @example Defining a sample property
+    #
+    #     class Hero < Metro::Model
+    #       property :sample
+    #     end
+    #
+    # @example Defining a sample property providing a default
+    #
+    #     class Hero < Metro::Model
+    #       property :sample, path: 'pickup.wav'
+    #     end
+    #
+    # @example Using a sample property with a different property name
+    #
+    #     class Hero < Metro::Model
+    #       property :pickup_sample, type: :sample, path: 'pickup.wav'
+    #     end
+    #
+    class SampleProperty < Metro::Model::Property
+
+      # By default, getting an unsupported value will return the default sample
+      get do |value|
+        default_sample
+      end
+
+      # Bu default, setting sn unsupported value will save the default sample filename
+      set do |value|
+        default_sample_filename
+      end
+
+      # Generate a sample from the specified string filepath
+      get String do |filename|
+        self.class.sample_for path: filename, window: model.window
+      end
+
+      # The assumption here is that the string is a sample filepath
+      set String do |filename|
+        filename
+      end
+
+      # Setting the song value with a Metro::Sample will save the string filepath
+      set Metro::Sample do |sample|
+        sample.path
+      end
+
+      #
+      # @return the default sample for the sample property. This is based on the default
+      #   sample name.
+      #
+      def default_sample
+        self.class.sample_for path: default_sample_filename, window: model.window
+      end
+
+      #
+      # @return a string sample name that is default. If the property was not created with
+      #   a default value the the default sample is the missing sample found in Metro.
+      #
+      def default_sample_filename
+        options[:path] or "missing.wav"
+      end
+
+      #
+      # Returns a Metro::Sample. This is composed of the metadata provided and a Gosu::Sample.
+      #
+      # @param [Hash] options the path, window, and other parameters necessary to generate
+      #   a sample.
+      #
+      def self.sample_for(options)
+        Metro::Sample.create(options)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+module Metro
+  class Model
+
+    #
+    # A scale property maintains an x and y scaling factor.
+    #
+    # A scale property also defines a `x_factor` property and a `y_factor`
+    # property which allows a more direct interface. Changing these values will
+    # update the scale the next time that it is used.
+    #
+    # A scale is stored in the properties as a string representation and is
+    # converted into a Scale when it is retrieved within the system.
+    #
+    # @example Defining a scale property
+    #
+    #     class Scoreboard < Metro::Model
+    #       property :font
+    #       property :color
+    #       property :scale
+    #
+    #       def draw
+    #         image.draw text, x, y, z_order, x_factor, y_factor, color
+    #       end
+    #
+    #     end
+    #
+    # @example Defining a scale property providing a default
+    #
+    #     class Hero < Metro::Model
+    #       property :image, path: 'hero.jpg'
+    #       property :scale, default: "1.0,1.0"
+    #     end
+    #
+    # @example Using a scale property with a different property name
+    #
+    #     class Hero < Metro::Model
+    #       property :image, path: 'hero.jpg'
+    #       property :enraged_scale, type: :scale, default: "4.0,4.0"
+    #       property :angle
+    #       property :color
+    #
+    #       def draw
+    #         image.draw_rot x, y, z_order, angle.to_f, 0.5, 0.5, 
+    #           enraged_scale_factor_x, enraged_scale_factor_y, color
+    #       end
+    #     end
+    #
+    class ScaleProperty < Property
+      define_property :x_factor
+
+      define_property :y_factor
+
+      get do |value|
+        default_scale
+      end
+
+      get String do |value|
+        Scale.parse(value)
+      end
+
+      set do |value|
+        default_scale.to_s
+      end
+
+      set String do |value|
+        value
+      end
+
+      set Scale do |value|
+        value.to_s
+      end
+
+      def default_scale
+        (options[:default] and options[:default].is_a? Scale) ? options[:default] : Scale.one
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,89 @@
+module Metro
+  class Model
+
+    #
+    # A song property maintains a Gosu::Song.
+    #
+    # A song is stored in the properties as the path in the assets folder and is converted into
+    # a Gosu::Song when it is retrieved within the system. When retrieving a song the Song
+    # Property will attempt to use a song that already exists that meets that criteria.
+    #
+    # The songs are cached within the song property to help performance by reducing the unncessary
+    # creation of similar song.
+    #
+    # @example Defining a song property
+    #
+    #     class Song < Metro::Model
+    #       property :song
+    #     end
+    #
+    # @example Defining a song property providing a default
+    #
+    #     class Song < Metro::Model
+    #       property :song, path: 'happy-song.wav'
+    #     end
+    #
+    # @example Using a song property with a different property name
+    #
+    #     class Song < Metro::Model
+    #       property :intro, type: :song, path: 'intro-song.wav'
+    #     end
+    #
+    class SongProperty < Metro::Model::Property
+
+      # By default, getting an unsupported value will return the default song
+      get do |value|
+        default_song
+      end
+
+      # By default, setting an unsupported value will save the default song
+      set do |value|
+        default_song_name
+      end
+
+      # Generate a song from the specified string filepath
+      get String do |filename|
+        self.class.song_for path: filename, window: model.window
+      end
+
+      # The assumption here is that the string is a song filepath
+      set String do |filename|
+        filename
+      end
+
+      # Setting the song value with a Metro::Song will save the string filepath
+      set Metro::Song do |song|
+        song.path
+      end
+
+      #
+      # @return the default song for the song property. This is based on the default
+      #   song name.
+      #
+      def default_song
+        self.class.song_for path: default_song_name, window: model.window
+      end
+
+      #
+      # @return a string song name that is default. If the property was not created with
+      #   a default value the the default song is the missing song found in Metro.
+      #
+      def default_song_name
+        options[:path] or 'missing.ogg'
+      end
+
+      #
+      # Returns a Metro::Song. This is composed of the metadata provided and a Gosu::Song.
+      #
+      # Songs are cached within the property to increase performance.
+      #
+      # @param [Hash] options the path, window, and other parameters necessary to generate
+      #   a song.
+      #
+      def self.song_for(options)
+        Song.find_or_create(options)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module Metro
+  class Model
+
+    #
+    # A text property maintains a string of text
+    #
+    # Text is stored as text in properties. When retrieving the text, the contents of the text will
+    # be evaluated within the instance of the model's scene. Which means that text may contain
+    # escaped variables referencing anything in the scene or the game.
+    #
+    # @example Defining a text property
+    #
+    #     class Scoreboard < Metro::Model
+    #       property :font
+    #       property :position
+    #       property :color
+    #       property :scale
+    #       property :text
+    #
+    #       def draw
+    #         font.draw text, x, y, z_order, x_factor, y_factor, color
+    #       end
+    #
+    #     end
+    #
+    # @example Defining with a default and text that will be instance evaluated.
+    #
+    #     class ScoreBoard < Metro::Model
+    #       property :score
+    #       property :text, default: 'Score is #{score}'
+    #     end
+    #
+    # @example Using a text property with a different property name
+    #
+    #     class Hero < Metro::Model
+    #       proeprty :font
+    #       property :position
+    #       property :color
+    #       property :scale
+    #       property :description, type: :text
+    #
+    #       def draw
+    #         font.draw description, x, y, z_order, x_factor, y_factor, color
+    #       end
+    #     end
+    #
+    class TextProperty < Property
+
+      # When no text is found for the field use the default text.
+      get do |value|
+        evalute_within_scene default_text
+      end
+
+      # When getting the text, evaluate the text within the scene.
+      get String do |value|
+        evalute_within_scene(value)
+      end
+
+      # When saving, simply save whatever is given as text.
+      set do |value|
+        value.to_s
+      end
+
+      def evalute_within_scene(text)
+        model.scene.instance_eval( "\"#{text}\"" )
+      end
+
+      def default_text
+        options[:default] || 'TEXT NOT SPECIFIED!'
+      end
+
+    end
+
+  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.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
+        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

@@ -0,0 +1,95 @@
+module Metro
+  module UI
+
+    #
+    # Draws a rectanglar border around the specififed position and dimensions
+    # with the width provided. This is an unfilled rectangle.
+    #
+    class Border < Model
+
+      # @attribute
+      # The starting position of the border.
+      property :position
+
+      # @attribute
+      # The dimension of the border.
+      property :dimensions
+
+      # @attribute
+      # The color which to use to draw the border.
+      property :color, default: "rgba(255,255,255,1.0)"
+
+      # @attribute
+      # The width of the border lines
+      property :border, default: 2
+
+      def draw
+        draw_border
+      end
+
+      def draw_border
+        draw_top
+        draw_bottom
+        draw_left
+        draw_right
+      end
+
+      def draw_top
+        draw_line left_with_border, top, right, top_with_border
+      end
+
+      def draw_left
+        draw_line left, top, left_with_border, bottom_with_border
+      end
+
+      def draw_right
+        draw_line right, top, right_with_border, bottom_with_border
+      end
+
+      def draw_bottom
+        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
+
+  end
+end