minigl 2.3.6 → 2.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8b9de89a3372e81cfdef102808b9bbaec3fbd88a930c95cd5af2f946cb744d
-  data.tar.gz: d4fd66ee8e177e80fcbbe14808e4a8518a526fc6cec47d41adfc032da881750c
+  metadata.gz: ff7475dd66f98076ad86cc143943c75f186e6b696aba46083b71727ad69e95b0
+  data.tar.gz: 87bec4f94e32553a70ea4ca4318357bbadb71ffc6600859a8c63ec772e708137
 SHA512:
-  metadata.gz: c966227f4b6a7d020c5e07c601fc18d8ea6603f07f6d661bc92127ae1335b02118e71ed997c2f25fd1c9089ae0e4730d61d0395a82ef0c2e495025b25fd019c3
-  data.tar.gz: e603e887d2c595c61e16bdeee8fd1b928414cf895caa7f98dd69b2aed0cf7bf2eb2dd0d115a460b07797d19ce3dccfeafc825151935012c62bc94671fdd90f2d
+  metadata.gz: '09094e3898b3a19939f39acf33ba4514db24bb1771b7795769a632e7f7230874058f921609d0760ea5958b42ca70e0a5b2224c974c5d3a80b4f1d2d1e59ad4cc'
+  data.tar.gz: ad1fc0475cee6c71ec019e5f8516b077da8ba4f37fbd95136137acb4716f83fe3fff42f68a5c458841c80732e8117776ac14c696c70b776d06c8b73860b379f5

data/README.md

@@ -14,6 +14,14 @@ It provides the following features:
 More functionalities are coming. Feel free to contribute! You can send feedback
 to victordavidsantos@gmail.com.
 
+## Made with MiniGL
+
+Below are two full games built with MiniGL, both available for free download and also open source.
+* [Super Bombinhas](https://github.com/victords/super-bombinhas)
+* [ConnecMan](https://github.com/victords/connecman)
+
+If you create a project using MiniGL, feel free to open a PR to include it in this list.
+
 ## Installing
 
 MiniGL was built on top of the Gosu gem. This gem has its own dependencies for
@@ -29,9 +37,10 @@ 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.3.6
+## Version 2.3.9
 
-  * Added inverted ramps (for sloped ceilings, still has some issues).
+  * Fixed click detection for very short clicks.
+  * Allow combining `center` and `margin` for `Button` text.
 
 ## Contributing
 

data/lib/minigl/forms.rb

@@ -98,6 +98,9 @@ module MiniGL
     # Gets or sets whether the panel (and thus all components inside it) are visible.
     attr_accessor :visible
 
+    # The components contained in this panel.
+    attr_reader :controls
+
     # Creates a new Panel.
     # Parameters:
     # [x] The horizontal coordinate of the top-left corner of the panel, or the horizontal offset from the anchor, if provided.
@@ -314,12 +317,12 @@ module MiniGL
       super x, y, font, text, text_color, disabled_text_color
       @over_text_color = over_text_color
       @down_text_color = down_text_color
-      if center_x; @text_x = x + @w / 2 if @w
-      else; @text_x = x + margin_x * @scale_x; end
-      if center_y; @text_y = y + @h / 2 if @h
-      else; @text_y = y + margin_y * @scale_y; end
       @center_x = center_x
       @center_y = center_y
+      @margin_x = margin_x
+      @margin_y = margin_y
+      set_position(x, y)
+
       @action = action
       @params = params
 
@@ -348,8 +351,10 @@ module MiniGL
           @img_index = 0
           @state = :up
         elsif mouse_press
-          @img_index = 2
-          @state = :down
+          Mouse.add_click(@z_index || 0, lambda do
+            @img_index = 2
+            @state = :down
+          end)
         else
           @img_index = 1
         end
@@ -360,7 +365,7 @@ module MiniGL
         elsif mouse_rel
           @img_index = 1
           @state = :over
-          click
+          Mouse.add_click(@z_index || 0, method(:perform_action))
         else
           @img_index = 2
         end
@@ -379,7 +384,7 @@ module MiniGL
 
     # Executes the button click action.
     def click
-      @action.call @params if @action
+      perform_action
     end
 
     # Sets the position of the button in the screen.
@@ -388,10 +393,10 @@ module MiniGL
     # [x] The new x-coordinate for the button.
     # [y] The new y-coordinate for the button.
     def set_position(x, y)
-      if @center_x; @text_x = x + @w / 2
-      else; @text_x += x - @x; end
-      if @center_y; @text_y = y + @h / 2
-      else; @text_y += y - @y; end
+      @text_x = @center_x ? x + @w / 2 : x
+      @text_y = @center_y ? y + @h / 2 : y
+      @text_x += @margin_x
+      @text_y += @margin_y
       @x = x; @y = y
     end
 
@@ -404,6 +409,7 @@ module MiniGL
     #           will be drawn on top of the ones with smaller z-orders.
     # [color] Color to apply a filter to the image.
     def draw(alpha = 0xff, z_index = 0, color = 0xffffff)
+      @z_index = z_index
       return unless @visible
 
       color = (alpha << 24) | color
@@ -435,6 +441,12 @@ module MiniGL
       @state = :up
       @img_index = 3
     end
+
+    private
+
+    def perform_action
+      @action.call(@params) if @action
+    end
   end
 
   # This class represents a toggle button, which can be also interpreted as a
@@ -502,8 +514,6 @@ module MiniGL
         else; height * @scale_y; end
       _, x, y = FormUtils.check_anchor(anchor, @anchor_offset_x, @anchor_offset_y, @w, @h)
       set_position(x, y)
-      @text_x = x + @w / 2 if center_x
-      @text_y = y + @h / 2 if center_y
       @checked = checked
     end
 
@@ -517,20 +527,12 @@ module MiniGL
       @img_index += 1 if @checked
     end
 
-    # Executes the button click action, and toggles its state. The +action+
-    # block always receives as a first parameter +true+, if the button has
-    # been changed to checked, or +false+, otherwise.
-    def click
-      @checked = !@checked
-      @action.call @checked, @params if @action
-    end
-
     # Sets the state of the button to the value given.
     #
     # Parameters:
     # [value] The state to be set (+true+ for checked, +false+ for unchecked).
     def checked=(value)
-      click if value != @checked
+      @action.call(value, @params) if @action && value != @checked
       @checked = value
     end
 
@@ -539,6 +541,13 @@ module MiniGL
       @state = :up
       @img_index = @checked ? 7 : 6
     end
+
+    private
+
+    def perform_action
+      @checked = !@checked
+      @action.call(@checked, @params) if @action
+    end
   end
 
   # This class represents a text field (input).
@@ -547,6 +556,9 @@ module MiniGL
     # INCOMPLETE!
     attr_reader :locale
 
+    # Whether the text field is focused (accepting input)
+    attr_reader :focused
+
     # Creates a new text field.
     #
     # Parameters:
@@ -566,9 +578,9 @@ module MiniGL
     # [margin_x] The x offset, from the field x-coordinate, to draw the text.
     # [margin_y] The y offset, from the field y-coordinate, to draw the text.
     # [max_length] The maximum length of the text inside the field.
-    # [active] Whether the text field must be focused by default. If +false+,
-    #          focus can be granted by clicking inside the text field or by
-    #          calling the +focus+ method.
+    # [focused] Whether the text field must be focused by default. If +false+,
+    #           focus can be granted by clicking inside the text field or by
+    #           calling the +focus+ method.
     # [text] The starting text. Must not be +nil+.
     # [allowed_chars] A string containing all characters that can be typed
     #                 inside the text field. The complete set of supported
@@ -606,7 +618,7 @@ module MiniGL
     # *Obs.:* This method accepts named parameters, but +x+, +y+, +font+ and
     # +img+ are mandatory.
     def initialize(x, y = nil, font = nil, img = nil, cursor_img = nil, disabled_img = nil, margin_x = 0, margin_y = 0,
-                   max_length = 100, active = false, text = '', allowed_chars = nil,
+                   max_length = 100, focused = false, text = '', allowed_chars = nil,
                    text_color = 0, disabled_text_color = 0, selection_color = 0, locale = 'en-us',
                    params = nil, retro = nil, scale_x = 1, scale_y = 1, anchor = nil, &on_text_changed)
       if x.is_a? Hash
@@ -618,7 +630,7 @@ module MiniGL
         margin_x = x.fetch(:margin_x, 0)
         margin_y = x.fetch(:margin_y, 0)
         max_length = x.fetch(:max_length, 100)
-        active = x.fetch(:active, false)
+        focused = x.fetch(:focused, false)
         text = x.fetch(:text, '')
         allowed_chars = x.fetch(:allowed_chars, nil)
         text_color = x.fetch(:text_color, 0)
@@ -647,7 +659,7 @@ module MiniGL
       @cursor_img = Res.img(cursor_img, false, false, '.png', retro) if cursor_img
       @disabled_img = Res.img(disabled_img, false, false, '.png', retro) if disabled_img
       @max_length = max_length
-      @active = active
+      @focused = focused
       @text_x = x + margin_x * @scale_x
       @text_y = y + margin_y * @scale_y
       @selection_color = selection_color
@@ -690,14 +702,14 @@ module MiniGL
 
       ################################ Mouse ################################
       if Mouse.over? @x, @y, @w, @h
-        if not @active and Mouse.button_pressed? :left
-          focus
+        if not @focused and Mouse.button_pressed? :left
+          Mouse.add_click(@z_index || 0, method(:focus))
         end
       elsif Mouse.button_pressed? :left
         unfocus
       end
 
-      return unless @active
+      return unless @focused
 
       if Mouse.double_click? :left
         if @nodes.size > 1
@@ -708,11 +720,7 @@ module MiniGL
         end
         set_cursor_visible
       elsif Mouse.button_pressed? :left
-        set_node_by_mouse
-        @anchor1 = @cur_node
-        @anchor2 = nil
-        @double_clicked = false
-        set_cursor_visible
+        Mouse.add_click(@z_index || 0, method(:focus))
       elsif Mouse.button_down? :left
         if @anchor1 and not @double_clicked
           set_node_by_mouse
@@ -902,7 +910,12 @@ module MiniGL
 
     # Grants focus to the text field, so that it allows keyboard input.
     def focus
-      @active = true
+      @focused = true
+      set_node_by_mouse
+      @anchor1 = @cur_node
+      @anchor2 = nil
+      @double_clicked = false
+      set_cursor_visible
     end
 
     # Removes focus from the text field, so that no keyboard input will be
@@ -911,7 +924,7 @@ module MiniGL
       @anchor1 = @anchor2 = nil
       @cursor_visible = false
       @cursor_timer = 0
-      @active = false
+      @focused = false
     end
 
     # Sets the position of the text field in the screen.
@@ -941,6 +954,7 @@ module MiniGL
     # [disabled_color] Color to apply a filter to the image when the field is
     #                  disabled.
     def draw(alpha = 0xff, z_index = 0, color = 0xffffff, disabled_color = 0x808080)
+      @z_index = z_index
       return unless @visible
 
       color = (alpha << 24) | ((@enabled or @disabled_img) ? color : disabled_color)
@@ -1250,6 +1264,9 @@ module MiniGL
     # The selected value in the drop-down list. This is one of the +options+.
     attr_reader :value
 
+    # Whether the list of options is currently visible.
+    attr_reader :open
+
     # An array containing all the options (each of them +String+s) that can be
     # selected in the drop-down list.
     attr_accessor :options

data/lib/minigl/game_object.rb

@@ -304,6 +304,14 @@ module MiniGL
     # This is +true+ when the effect's lifetime has already passed.
     attr_reader :dead
 
+    # The lifetime of the effect, in updates, i.e., how many calls to +update+
+    # must happen before the effect is marked as +dead+, since its creation.
+    attr_reader :lifetime
+
+    # The number of times +update+ has been called for this effect, while it
+    # was still active (not +dead+).
+    attr_reader :elapsed_time
+
     # Creates a new Effect.
     #
     # Parameters:
@@ -352,7 +360,7 @@ module MiniGL
       end
 
       super x, y, img, sprite_cols, sprite_rows
-      @timer = 0
+      @elapsed_time = 0
       if indices
         @indices = indices
       else
@@ -369,15 +377,21 @@ module MiniGL
 
     # Updates the effect, animating and counting its remaining lifetime.
     def update
-      unless @dead
-        animate @indices, @interval
-        @timer += 1
-        @dead = true if @timer == @lifetime
-      end
+      return if @dead
+
+      animate(@indices, @interval)
+      @elapsed_time += 1
+      @dead = true if @elapsed_time == @lifetime
     end
 
     def draw(map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil, z_index = 0)
       super unless @dead
     end
+
+    # The remaining number of calls to +update+ until the effect is marked
+    # +dead+.
+    def time_left
+      @lifetime - @elapsed_time
+    end
   end
 end

data/lib/minigl/global.rb

@@ -245,6 +245,16 @@ module MiniGL
     def toggle_fullscreen
       self.fullscreen = !fullscreen?
     end
+
+    def button_down(id)
+      super
+      Mouse.register_button_down(id)
+    end
+
+    def button_up(id)
+      super
+      Mouse.register_button_up(id)
+    end
   end
 
   # Exposes methods for controlling keyboard and gamepad events.
@@ -387,6 +397,7 @@ module MiniGL
       def initialize
         @down = {}
         @prev_down = {}
+        @next_down = {}
         @dbl_click = {}
         @dbl_click_timer = {}
       end
@@ -394,23 +405,29 @@ module MiniGL
       # Updates the mouse position and the state of all buttons.
       def update
         @prev_down = @down.clone
-        @down.clear
+        @down = @next_down.clone
+        @next_down.delete_if { |_, v| v.zero? }
         @dbl_click.clear
 
+        if @click
+          @click[:action].call
+          @click = nil
+        end
+
         @dbl_click_timer.each do |k, v|
-          if v < G.double_click_delay; @dbl_click_timer[k] += 1
-          else; @dbl_click_timer.delete k; end
+          if v < G.double_click_delay
+            @dbl_click_timer[k] += 1
+          else
+            @dbl_click_timer.delete(k)
+          end
         end
 
-        k1 = [Gosu::MsLeft, Gosu::MsMiddle, Gosu::MsRight]
-        k2 = [:left, :middle, :right]
-        (0..2).each do |i|
-          if G.window.button_down? k1[i]
-            @down[k2[i]] = true
-            @dbl_click[k2[i]] = true if @dbl_click_timer[k2[i]]
-            @dbl_click_timer.delete k2[i]
-          elsif @prev_down[k2[i]]
-            @dbl_click_timer[k2[i]] = 0
+        %i[left middle right].each do |key|
+          if @down[key]
+            @dbl_click[key] = true if @dbl_click_timer[key]
+            @dbl_click_timer.delete(key)
+          elsif @prev_down[key]
+            @dbl_click_timer[key] = 0
           end
         end
 
@@ -474,6 +491,38 @@ module MiniGL
         return @x >= x.x && @x < x.x + x.w && @y >= x.y && @y < x.y + x.h if x.is_a? Rectangle
         @x >= x && @x < x + w && @y >= y && @y < y + h
       end
+
+      # :nodoc:
+      def add_click(z_index, action)
+        return if @click && @click[:z_index] > z_index
+
+        @click = { z_index: z_index, action: action }
+      end
+
+      # :nodoc:
+      def register_button_down(id)
+        key = key_from_id(id)
+        @next_down[key] = 1 if key
+      end
+
+      # :nodoc:
+      def register_button_up(id)
+        key = key_from_id(id)
+        @next_down[key] = 0 if key && @next_down[key]
+      end
+
+      private
+
+      def key_from_id(id)
+        case id
+        when Gosu::MS_LEFT
+          :left
+        when Gosu::MS_RIGHT
+          :right
+        when Gosu::MS_MIDDLE
+          :middle
+        end
+      end
     end
   end
 

data/lib/minigl/text.rb

@@ -11,9 +11,18 @@ module MiniGL
   #   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
+    # A string containing the characters supported by this font.
+    attr_reader :chars
+
     # The height of this font in pixels.
     attr_reader :height
 
+    # The width of the white space character in this font, in pixels.
+    attr_reader :space_width
+
+    # The spacing between characters, in pixels (can be a decimal number).
+    attr_reader :char_spacing
+
     # Creates an +ImageFont+.
     #
     # Parameters:
@@ -26,16 +35,19 @@ module MiniGL
     #          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.
+    # [char_spacing] The spacing between non-white-space characters when writing text with
+    #                this font. It can be a decimal number, useful when scaling the text up.
     # [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)
+    def initialize(img_path, chars, widths, height, space_width, char_spacing = 0, 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
+      @char_spacing = char_spacing
       wa = widths.is_a?(Array)
       if wa && widths.length != chars.length
         raise 'Wrong widths array size!'
@@ -60,7 +72,17 @@ module MiniGL
     # 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 }
+      w = 0
+      text.chars.each_with_index do |c, i|
+        if c == ' '
+          w += @space_width
+        else
+          idx = @chars.index(c)
+          w += idx ? @images[idx].width : 0
+          w += @char_spacing if i < text.chars.size - 1
+        end
+      end
+      w
     end
 
     # See <code>Gosu::Font#draw_markup_rel</code> for details.
@@ -82,7 +104,7 @@ module MiniGL
         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
+        x += (scale_x * (@images[i].width + @char_spacing)).round
       end
     end
 

data/test/game.rb

@@ -19,7 +19,7 @@ class MyGame < GameWindow
     @font2 = Res.font :font1, 50
     @writer1 = TextHelper.new @font1, 5
     @writer2 = TextHelper.new @font2, 5
-    @btn = Button.new(10, 560, @font1, 'Test', :btn, 0x008000, 0x808080, 0xffffff, 0xff9980, true, true, 0, 4, 0, 0, 'friends', nil, 2, 2) { |x| puts "hello #{x}" }
+    @btn = Button.new(10, 560, @font1, 'Test', :btn, 0x008000, 0x808080, 0xffffff, 0xff9980, true, false, -10, 4, 0, 0, 'friends', nil, 2, 2) { |x| puts "hello #{x}" }
     @btn.enabled = false
     @chk =
       ToggleButton.new(x: 0, y: 30, font: @font1, text: 'Click me', img: :check, center_x: false, margin_x: 36, params: 'friends', anchor: :south) { |c, x|
@@ -32,11 +32,12 @@ class MyGame < GameWindow
     @ddl = DropDownList.new(0, 10, @font1, nil, nil, ['olá amigos', 'opção 2', 'terceira'], 0, 3, 150, 25, 0, 0x808080, 0xffffff, 0xffff00, nil, 2, 2.5, :north) { |a, b|
       puts "mudou de #{a} para #{b}"
     }
+    @btn2 = Button.new(x: 0, y: 80, font: @font1, text: 'Below', img: :btn, anchor: :north) { puts 'Below the dropdown' }
 
     @panel = Panel.new(10, 10, 720, 520, [
-      Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn),
+      TextField.new(x: 5, y: 5, font: @font1, text: 'Opa', img: :text, margin_x: 5, margin_y: 5, anchor: :top_left),
+      Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn) { puts 'top left' },
       @lbl = Label.new(0, 70, @font1, 'Teste de label', 0, 0x666666, 1, 1, :north),
-      TextField.new(x: 5, y: 40, font: @font1, text: 'Opa', img: :text, margin_x: 5, margin_y: 5, anchor: :top_left),
       Button.new(x: 0, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :top),
       DropDownList.new(x: 0, y: 40, width: 150, height: 25, font: @font1, options: ['olá amigos', 'opção 2', 'terceira'], anchor: :north),
       Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :northeast),
@@ -44,7 +45,7 @@ class MyGame < GameWindow
       Button.new(x: 0, y: 0, font: @font1, text: 'Teste', img: :btn, anchor: :center),
       Button.new(x: 5, y: 0, font: @font1, text: 'Teste', img: :btn, anchor: :right),
       ToggleButton.new(x: 5, y: 40, img: :check, center_x: false, margin_x: 36, anchor: :east),
-      Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :southwest),
+      Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :southwest) { @lbl.visible = !@lbl.visible },
       Button.new(x: 0, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :south),
       ProgressBar.new(0, 40, 200, 20, :barbg, :barfg, 3456, 70, 2, 2, @font1, 0xff000080, nil, nil, 1, 1, :bottom)
     ], :text, :tiled, true, 2, 2, :bottom_right)
@@ -80,7 +81,11 @@ class MyGame < GameWindow
     @panel.enabled = !@panel.enabled if KB.key_pressed? Gosu::KbN
     @panel.visible = !@panel.visible if KB.key_pressed? Gosu::KbM
 
-    @panel.add_component(Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :southeast)) if KB.key_pressed?(Gosu::KbB)
+    if KB.key_pressed?(Gosu::KbB)
+      @panel.add_component(Button.new(x: 5, y: 5, font: @font1, text: 'Teste', img: :btn, anchor: :southeast) {
+        puts 'new button added'
+      })
+    end
     @lbl.text = 'Test of changed text' if KB.key_pressed?(Gosu::KB_C)
     @lbl2.text = 'Shorter text' if KB.key_pressed?(Gosu::KB_X)
 
@@ -112,6 +117,7 @@ class MyGame < GameWindow
     @chk.update
     @txt.update
     @ddl.update
+    @btn2.update
 
     @panel.update
 
@@ -145,6 +151,7 @@ class MyGame < GameWindow
                             780, 450, 300, :right, 0xff0000, 255, 1
 
     @ddl.draw 0x80, 1, 0xff8080
+    @btn2.draw
     @btn.draw 0xcc, 1, 0x33ff33
     @chk.draw
     @txt.draw

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 2.3.6
+  version: 2.3.9
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu