minigl 2.2.8 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b4770937913304de29f2696a7d7a0e75fc468185579efa3b421a4abe46253e8
-  data.tar.gz: 84c72db0c03039a09767d39138b681201a2d5028e3ef278b1096b1c89b9e472d
+  metadata.gz: f8864115892b3cc8a853b6bea09aaa768f0750f40e1f39f247177db200c52dcc
+  data.tar.gz: 29bb72b4cf14e1e0b53850b46b5eeabc9de348854af4947ee803310e9fd7ff42
 SHA512:
-  metadata.gz: 36242a7d0fd3c52df939408e744bc01139b2b34b7f9b3f86e6e64989778a0eb51b48fa7eb56ebf74c8a0e59a6781cadf186e4cd0719002afa6abf4c2f14998c3
-  data.tar.gz: b0706f37c19fd9e48bf43fc0921b9c9991e355044c5e99374df4821a5be18b5abda87c73375d1cdc84a3bd964a28fbc7e0c176c2e78167b50ebcd5ae015a2137
+  metadata.gz: '09d5fdd7c6d7bfed2ef5a026b8b1754ca24c9cd1116e8dc4c3e2ef113e8253f15831cb9a8d29d5ccd6a71e8a002b46ee27ccffe42f9ccca15c2cdfe00646862b'
+  data.tar.gz: 5ea1ff3572568e194a6ee4dae01b9ed9df11bedfa31738457ca449401708b0490a7f73e1a3f3a9f82eced6030f4ec35418e2ef48f3fd30b542466879d3db5d0d

data/README.md

@@ -29,9 +29,9 @@ After installing the Gosu dependencies, you can just `gem install minigl`.
   * The [wiki](https://github.com/victords/minigl/wiki) is a work in progress with tutorials and examples.
   * Test package and examples aren't complete!
 
-## Version 2.2.8
+## Version 2.3.3
 
-  * Add `stop_time` parameter to the `cycle` method of `Movement` (included in `GameObject`).
+  * Fix bug in `Movement#cycle`.
 
 ## Contributing
 

data/lib/minigl/movement.rb

@@ -360,17 +360,19 @@ module MiniGL
     # [speed] If the first argument is a forces vector, then this should be
     #         +nil+. If it is a point, then this is the constant speed at which
     #         the object will move (provided as a scalar, not a vector).
-    # [obstacles] An array of obstacles to be considered in the collision
-    #             checking, and carried along when colliding from above.
-    #             Obstacles must be instances of Block (or derived classes),
-    #             or objects that <code>include Movement</code>.
-    # [obst_obstacles] Obstacles that should be considered when moving objects
-    #                  from the +obstacles+ array, i.e., these obstacles won't
-    #                  interfere in the elevator's movement, but in the movement
-    #                  of the objects being carried.
-    # [obst_ramps] Ramps to consider when moving objects from the +obstacles+
-    #              array, as described for +obst_obstacles+.
-    def move_carrying(arg, speed, obstacles, obst_obstacles, obst_ramps)
+    # [carried_objs] An array of objects that can potentially be carried by
+    #                this object while it moves. The objects must respond to
+    #                +x+, +y+, +w+ and +h+.
+    # [obstacles] Obstacles that should be considered for collision checking
+    #             with the carried objects, if they include the +Movement+
+    #             module, and with this object too, if moving with forces and
+    #             the +ignore_collision+ flag is false.
+    # [ramps] Ramps that should be considered for the carried objects, if they
+    #         include the +Movement+ module, and for this object too, if moving
+    #         with forces and +ignore_collision+ is false.
+    # [ignore_collision] Set to true to make this object ignore collision even
+    #                    when moving with forces.
+    def move_carrying(arg, speed, carried_objs, obstacles, ramps, ignore_collision = false)
       if speed
         x_d = arg.x - @x; y_d = arg.y - @y
         distance = Math.sqrt(x_d**2 + y_d**2)
@@ -382,18 +384,14 @@ module MiniGL
 
         @speed.x = 1.0 * x_d * speed / distance
         @speed.y = 1.0 * y_d * speed / distance
+        x_aim = @x + @speed.x; y_aim = @y + @speed.y
       else
-        arg += G.gravity
-        @speed.x += arg.x / @mass; @speed.y += arg.y / @mass
-        @speed.x = 0 if @speed.x.abs < G.min_speed.x
-        @speed.y = 0 if @speed.y.abs < G.min_speed.y
-        @speed.x = (@speed.x <=> 0) * @max_speed.x if @speed.x.abs > @max_speed.x
-        @speed.y = (@speed.y <=> 0) * @max_speed.y if @speed.y.abs > @max_speed.y
+        x_aim = @x + @speed.x + G.gravity.x + arg.x
+        y_aim = @y + @speed.y + G.gravity.y + arg.y
       end
 
-      x_aim = @x + @speed.x; y_aim = @y + @speed.y
       passengers = []
-      obstacles.each do |o|
+      carried_objs.each do |o|
         if @x + @w > o.x && o.x + o.w > @x
           foot = o.y + o.h
           if foot.round(6) == @y.round(6) || @speed.y < 0 && foot < @y && foot > y_aim
@@ -415,25 +413,30 @@ module MiniGL
           @y = y_aim
         end
       else
-        @x = x_aim; @y = y_aim
+        move(arg, ignore_collision ? [] : obstacles, ignore_collision ? [] : ramps)
       end
 
       forces = Vector.new @x - prev_x, @y - prev_y
       prev_g = G.gravity.clone
       G.gravity.x = G.gravity.y = 0
       passengers.each do |p|
-        prev_speed = p.speed.clone
-        prev_forces = p.stored_forces.clone
-        prev_bottom = p.bottom
-        p.speed.x = p.speed.y = 0
-        p.stored_forces.x = p.stored_forces.y = 0
-        p.instance_exec { @bottom = nil }
-        p.move forces * p.mass, obst_obstacles, obst_ramps
-        p.speed.x = prev_speed.x
-        p.speed.y = prev_speed.y
-        p.stored_forces.x = prev_forces.x
-        p.stored_forces.y = prev_forces.y
-        p.instance_exec(prev_bottom) { |b| @bottom = b }
+        if p.class.included_modules.include?(Movement)
+          prev_speed = p.speed.clone
+          prev_forces = p.stored_forces.clone
+          prev_bottom = p.bottom
+          p.speed.x = p.speed.y = 0
+          p.stored_forces.x = p.stored_forces.y = 0
+          p.instance_exec { @bottom = nil }
+          p.move(forces * p.mass, obstacles, ramps)
+          p.speed.x = prev_speed.x
+          p.speed.y = prev_speed.y
+          p.stored_forces.x = prev_forces.x
+          p.stored_forces.y = prev_forces.y
+          p.instance_exec(prev_bottom) { |b| @bottom = b }
+        else
+          p.x += forces.x
+          p.y += forces.y
+        end
       end
       G.gravity = prev_g
     end
@@ -510,6 +513,8 @@ module MiniGL
       unless @cycle_setup
         @cur_point = 0 if @cur_point.nil?
         if obstacles
+          obst_obstacles = [] if obst_obstacles.nil?
+          obst_ramps = [] if obst_ramps.nil?
           move_carrying points[@cur_point], speed, obstacles, obst_obstacles, obst_ramps
         else
           move_free points[@cur_point], speed

data/lib/minigl/text.rb

@@ -1,23 +1,127 @@
 module MiniGL
+  # This class represents a font and exposes most of the methods from +Gosu::Font+,
+  # but allows the font to be created from an image, allowing for better customization
+  # and also using the +retro+ option. Moreover, this class can be passed to the
+  # +TextHelper+ constructor as if it was a +Gosu::Font+.
+  #
+  # The image used to load the font must meet these criteria:
+  # * The characters should be laid out in lines of the same height in pixels.
+  # * The full image must have a height that is a multiple of that line height.
+  # * The characters should occupy the maximum available space in each line, i.e.,
+  #   if a character fits in the current line it must not be placed in the next
+  #   one. In the last line there can be any amount of free space at the end.
+  class ImageFont
+    # The height of this font in pixels.
+    attr_reader :height
+
+    # Creates an +ImageFont+.
+    #
+    # Parameters:
+    # [img_path] Identifier of an image fitting the description in the class documentation,
+    #            as used in +Res.img+.
+    # [chars] A string containing all characters that will be present in the image, in the
+    #         same order as they appear in the image. Do not include white space.
+    # [widths] An integer representing the width of the chars in pixels, if this is a fixed
+    #          width font, or an array containing the width of each char, in the same order
+    #          as they appear in the +chars+ string.
+    # [height] The height of the lines in the image (see description above).
+    # [space_width] The width of the white space character in this font.
+    # [global] Parameter that will be passed to +Res.img+ when loading the image.
+    # [ext] Parameter that will be passed to +Res.img+ when loading the image.
+    # [retro] Parameter that will be passed to +Res.img+ when loading the image.
+    def initialize(img_path, chars, widths, height, space_width, global = true, ext = '.png', retro = nil)
+      retro = Res.retro_images if retro.nil?
+      img = Res.img(img_path, global, false, ext, retro)
+      @chars = chars
+      @images = []
+      @height = height
+      @space_width = space_width
+      wa = widths.is_a?(Array)
+      if wa && widths.length != chars.length
+        raise 'Wrong widths array size!'
+      end
+      x = y = 0
+      (0...chars.length).each do |i|
+        @images.push(img.subimage(x, y, wa ? widths[i] : widths, height))
+        new_x = x + (wa ? widths[i] : widths)
+        if i < chars.length - 1 && new_x + (wa ? widths[i+1] : widths) > img.width
+          x = 0
+          y += height
+        else
+          x = new_x
+        end
+      end
+    end
+
+    # Returns the width, in pixels, of a given string written by this font.
+    # Note: Markup is not supported, this method is named this way to match
+    # <code>Gosu::Font</code>'s signature.
+    #
+    # Parameters:
+    # [text] The string to be measured
+    def markup_width(text)
+      text.chars.reduce(0) { |w, c| if c == ' '; w += @space_width; else; i = @chars.index(c); w += i ? @images[i].width : 0; end }
+    end
+
+    # See <code>Gosu::Font#draw_markup_rel</code> for details.
+    # Note: Markup is not supported, this method is named this way to match
+    # <code>Gosu::Font</code>'s signature.
+    def draw_markup_rel(text, x, y, z, rel_x, rel_y, scale_x, scale_y, color)
+      text = text.to_s unless text.is_a?(String)
+      if rel_x != 0
+        x -= scale_x * markup_width(text) * rel_x
+      end
+      if rel_y != 0
+        y -= scale_y * @height * rel_y
+      end
+      text.each_char do |c|
+        if c == ' '
+          x += scale_x * @space_width
+          next
+        end
+        i = @chars.index(c)
+        next if i.nil?
+        @images[i].draw(x, y, z, scale_x, scale_y, color)
+        x += scale_x * @images[i].width
+      end
+    end
+
+    # See <code>Gosu::Font#draw_markup</code> for details.
+    # Note: Markup is not supported, this method is named this way to match
+    # <code>Gosu::Font</code>'s signature.
+    def draw_markup(text, x, y, z, scale_x, scale_y, color)
+      draw_markup_rel(text, x, y, z, 0, 0, scale_x, scale_y, color)
+    end
+
+    alias :draw_text_rel :draw_markup_rel
+    alias :draw_text :draw_markup
+    alias :text_width :markup_width
+  end
+
   # This class provides methods for easily drawing one or multiple lines of
   # text, with control over the text alignment and coloring.
   class TextHelper
     # Creates a TextHelper.
     #
     # Parameters:
-    # [font] A <code>Gosu::Font</code> that will be used to draw the text.
-    # [line_spacing] When drawing multiple lines, the distance, in pixels,
-    #                between each line.
-    def initialize(font, line_spacing = 0)
+    # [font] A <code>Gosu::Font</code> or <code>ImageFont</code> that will
+    #        be used to draw the text.
+    # [line_spacing] When drawing multiple lines, the default distance, in
+    #                pixels, between each line.
+    # [scale_x] The default horizontal scale of the font.
+    # [scale_y] The default vertical scale of the font.
+    def initialize(font, line_spacing = 0, scale_x = 1, scale_y = 1)
       @font = font
       @line_spacing = line_spacing
+      @scale_x = scale_x
+      @scale_y = scale_y
     end
 
     # Draws a single line of text.
     #
     # Parameters:
     # [text] The text to be drawn. No line breaks are allowed. You can use the
-	#        `<b>` tag for bold, `<i>` for italic and `<c=rrggbb>` for colors.
+    #        `<b>` tag for bold, `<i>` for italic and `<c=rrggbb>` for colors.
     # [x] The horizontal reference for drawing the text. If +mode+ is +:left+,
     #     all text will be drawn from this point to the right; if +mode+ is
     #     +:right+, all text will be drawn from this point to the left; and if
@@ -43,12 +147,16 @@ module MiniGL
     #                provide less than 255.
     # [z_index] The z-order to draw the object. Objects with larger z-orders
     #           will be drawn on top of the ones with smaller z-orders.
+    # [scale_x] The horizontal scaling of the text. If +nil+, this instance's
+    #           +@scale_x+ value will be used.
+    # [scale_y] The vertical scaling of the text. If +nil+, this instance's
+    #           +@scale_y+ value will be used.
     #
     # *Obs.:* This method accepts named parameters, but +text+, +x+ and +y+ are
     # mandatory.
     def write_line(text, x = nil, y = nil, mode = :left, color = 0, alpha = 0xff,
                    effect = nil, effect_color = 0, effect_size = 1, effect_alpha = 0xff,
-                   z_index = 0)
+                   z_index = 0, scale_x = nil, scale_y = nil)
       if text.is_a? Hash
         x = text[:x]
         y = text[:y]
@@ -60,9 +168,13 @@ module MiniGL
         effect_size = text.fetch(:effect_size, 1)
         effect_alpha = text.fetch(:effect_alpha, 0xff)
         z_index = text.fetch(:z_index, 0)
+        scale_x = text.fetch(:scale_x, nil)
+        scale_y = text.fetch(:scale_y, nil)
         text = text[:text]
       end
 
+      scale_x = @scale_x if scale_x.nil?
+      scale_y = @scale_y if scale_y.nil?
       color = (alpha << 24) | color
       rel =
         case mode
@@ -74,19 +186,19 @@ module MiniGL
       if effect
         effect_color = (effect_alpha << 24) | effect_color
         if effect == :border
-          @font.draw_markup_rel text, x - effect_size, y - effect_size, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x, y - effect_size, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x + effect_size, y - effect_size, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x + effect_size, y, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x + effect_size, y + effect_size, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x, y + effect_size, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x - effect_size, y + effect_size, z_index, rel, 0, 1, 1, effect_color
-          @font.draw_markup_rel text, x - effect_size, y, z_index, rel, 0, 1, 1, effect_color
+          @font.draw_markup_rel text, x - effect_size, y - effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x, y - effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x + effect_size, y - effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x + effect_size, y, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x + effect_size, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x - effect_size, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
+          @font.draw_markup_rel text, x - effect_size, y, z_index, rel, 0, scale_x, scale_y, effect_color
         elsif effect == :shadow
-          @font.draw_markup_rel text, x + effect_size, y + effect_size, z_index, rel, 0, 1, 1, effect_color
+          @font.draw_markup_rel text, x + effect_size, y + effect_size, z_index, rel, 0, scale_x, scale_y, effect_color
         end
       end
-      @font.draw_markup_rel text, x, y, z_index, rel, 0, 1, 1, color
+      @font.draw_markup_rel text, x, y, z_index, rel, 0, scale_x, scale_y, color
     end
 
     # Draws text, breaking lines when needed and when explicitly caused by the
@@ -94,7 +206,7 @@ module MiniGL
     #
     # Parameters:
     # [text] The text to be drawn. Line breaks are allowed. You can use the
-	#        `<b>` tag for bold, `<i>` for italic and `<c=rrggbb>` for colors.
+	  #        `<b>` tag for bold, `<i>` for italic and `<c=rrggbb>` for colors.
     # [x] The horizontal reference for drawing the text. Works like in
     #     +write_line+ for the +:left+, +:right+ and +:center+ modes. For the
     #     +:justified+ mode, works the same as for +:left+.
@@ -109,11 +221,20 @@ module MiniGL
     #         transparent) to 255 (fully opaque).
     # [z_index] The z-order to draw the object. Objects with larger z-orders
     #           will be drawn on top of the ones with smaller z-orders.
-    def write_breaking(text, x, y, width, mode = :left, color = 0, alpha = 0xff, z_index = 0)
+    # [scale_x] The horizontal scaling of the text. If +nil+, this instance's
+    #           +@scale_x+ value will be used.
+    # [scale_y] The vertical scaling of the text. If +nil+, this instance's
+    #           +@scale_y+ value will be used.
+    # [line_spacing] The spacing between lines, in pixels. If +nil+, this
+    #                instance's +@line_spacing+ value will be used.
+    def write_breaking(text, x, y, width, mode = :left, color = 0, alpha = 0xff, z_index = 0, scale_x = nil, scale_y = nil, line_spacing = nil)
+      line_spacing = @line_spacing if line_spacing.nil?
+      scale_x = @scale_x if scale_x.nil?
+      scale_y = @scale_y if scale_y.nil?
       color = (alpha << 24) | color
       text.split("\n").each do |p|
         if mode == :justified
-          y = write_paragraph_justified p, x, y, width, color, z_index
+          y = write_paragraph_justified p, x, y, width, color, z_index, scale_x, scale_y, line_spacing
         else
           rel =
             case mode
@@ -122,40 +243,40 @@ module MiniGL
             when :right then 1
             else 0
             end
-          y = write_paragraph p, x, y, width, rel, color, z_index
+          y = write_paragraph p, x, y, width, rel, color, z_index, scale_x, scale_y, line_spacing
         end
       end
     end
 
   private
 
-    def write_paragraph(text, x, y, width, rel, color, z_index)
+    def write_paragraph(text, x, y, width, rel, color, z_index, scale_x, scale_y, line_spacing)
       line = ''
       line_width = 0
       text.split(' ').each do |word|
-        w = @font.markup_width word
-        if line_width + w > width
-          @font.draw_markup_rel line.chop, x, y, z_index, rel, 0, 1, 1, color
+        w = @font.markup_width(word)
+        if line_width + w * scale_x > width
+          @font.draw_markup_rel line.chop, x, y, z_index, rel, 0, scale_x, scale_y, color
           line = ''
           line_width = 0
-          y += @font.height + @line_spacing
+          y += (@font.height + line_spacing) * scale_y
         end
         line += "#{word} "
-        line_width += @font.markup_width "#{word} "
+        line_width += @font.markup_width("#{word} ") * scale_x
       end
-      @font.draw_markup_rel line.chop, x, y, z_index, rel, 0, 1, 1, color unless line.empty?
-      y + @font.height + @line_spacing
+      @font.draw_markup_rel line.chop, x, y, z_index, rel, 0, scale_x, scale_y, color unless line.empty?
+      y + (@font.height + line_spacing) * scale_y
     end
 
-    def write_paragraph_justified(text, x, y, width, color, z_index)
-      space_width = @font.text_width ' '
+    def write_paragraph_justified(text, x, y, width, color, z_index, scale_x, scale_y, line_spacing)
+      space_width = @font.text_width(' ') * scale_x
       spaces = [[]]
       line_index = 0
       new_x = x
       words = text.split(' ')
       words.each do |word|
-        w = @font.markup_width word
-        if new_x + w > x + width
+        w = @font.markup_width(word)
+        if new_x + w * scale_x > x + width
           space = x + width - new_x + space_width
           index = 0
           while space > 0
@@ -170,7 +291,7 @@ module MiniGL
 
           new_x = x
         end
-        new_x += @font.markup_width(word) + space_width
+        new_x += @font.markup_width(word) * scale_x + space_width
         spaces[line_index] << space_width
       end
 
@@ -178,11 +299,11 @@ module MiniGL
       spaces.each do |line|
         new_x = x
         line.each do |s|
-          @font.draw_markup words[index], new_x, y, z_index, 1, 1, color
-          new_x += @font.markup_width(words[index]) + s
+          @font.draw_markup(words[index], new_x, y, z_index, scale_x, scale_y, color)
+          new_x += @font.markup_width(words[index]) * scale_x + s
           index += 1
         end
-        y += @font.height + @line_spacing
+        y += (@font.height + line_spacing) * scale_y
       end
       y
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.3.3
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -98,37 +98,37 @@ signing_key:
 specification_version: 4
 summary: MiniGL
 test_files:
+- test/vector_tests.rb
 - test/res_tests.rb
-- test/iso_game.rb
 - test/mov_game.rb
+- test/movement_tests.rb
 - test/map_tests.rb
-- test/game.rb
+- test/iso_game.rb
 - test/game_object_tests.rb
-- test/vector_tests.rb
-- test/movement_tests.rb
+- test/game.rb
 - test/test.png
+- test/data/tileset/tileset1.png
 - test/data/font/font1.ttf
+- test/data/sound/1.wav
+- test/data/img/check.png
 - test/data/img/square.svg
-- test/data/img/barbg.png
-- test/data/img/img1.png
-- test/data/img/tile1.png
-- test/data/img/tile2b.png
-- test/data/img/text.png
-- test/data/img/btn.png
-- test/data/img/square2.svg
-- test/data/img/square2.png
+- test/data/img/tile2.svg
 - test/data/img/barfg.png
-- test/data/img/tile1b.png
 - test/data/img/tile2.png
-- test/data/img/check.png
-- test/data/img/tile2.svg
-- test/data/img/square3.png
+- test/data/img/tile1.svg
 - test/data/img/square3.svg
+- test/data/img/text.png
+- test/data/img/square2.svg
 - test/data/img/image.png
-- test/data/img/tile1.svg
-- test/data/img/square.png
+- test/data/img/img1.png
+- test/data/img/square2.png
 - test/data/img/barbg.svg
 - test/data/img/barfg.svg
-- test/data/tileset/tileset1.png
-- test/data/sound/1.wav
+- test/data/img/tile1b.png
+- test/data/img/barbg.png
+- test/data/img/square.png
+- test/data/img/btn.png
+- test/data/img/square3.png
+- test/data/img/tile2b.png
+- test/data/img/tile1.png
 - test/data/img/sub/image.png