wads 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1cf7ab7c4229f57f2bb4691819c5a4282a3fd0f7703e5caa6c93e49aeb35053
-  data.tar.gz: a1f0e971db1ea5064e44fef39c31767125f844b8ab3ef87eeaf09e3e92f27ad1
+  metadata.gz: d4dcddbd32da59c1cd1a89fc9abb27b69314b63fcb413753d874140d34db6d5d
+  data.tar.gz: ab05677ab411b91457d17e3acdfa7b6547268af9e42d7364573fed177b989316
 SHA512:
-  metadata.gz: 315790b3c8fe99525c3ad78eaa90eecd17fadd09a2a3e16a13ba82cb61ea5279472c57ada6e88021e9c6649236bb598aad0a46a1954928a1c37dc8dbf8b45b5e
-  data.tar.gz: 89de4f997dcef2e1b9e25062af443d6994d7ee4070d89dab21f06cb492ed3d106f837a9c3bdf85d7ba7e6522d30a039694982d939d49dd41b7da30c2637299ea
+  metadata.gz: 67fb8ee6765014d4704d22cdb251595839f7b22593723204c198a85d943c59a80d37823eaec65aee58bb81177feb03c7fd92e831ada1c08e0cdb1d804a1e69e4
+  data.tar.gz: 3290687b9372191b80690d42f9ef825716898b3e2c123b0bee9ee8e72b630680320279a1a302d06b27f8aaf696dd2b406d13621e2b9a44f835eb230c12460bda

data/CHANGELOG.md

@@ -17,3 +17,12 @@
 ## [0.2.0] - 2021-10-05
 
 - Breaking change in order to refactor, including standardizing order of widget constructor args
+
+## [0.2.3] - 2021-10-21
+
+- Upgrade dependency versions
+
+## [0.2.4] - 2021-10-21
+
+- Add a callback for key up
+

data/lib/wads/app.rb

@@ -16,6 +16,7 @@ module Wads
             WadsConfig.instance.set_window(self)
             set_display(widget) 
             WadsConfig.instance.set_log_level("info")
+            @registered_hold_down_buttons = []
         end 
 
         #
@@ -30,8 +31,23 @@ module Wads
             @main_widget
         end
 
+        # Register a key (identified by the Gosu id) to check if it is being held down.
+        # If so, the handle_key_held_down callback will be invoked on widgets
+        # For example, register_hold_down_key(Gosu::KbLeft)
+        def register_hold_down_key(id)
+            @registered_hold_down_buttons << id 
+        end
+
         def update
             @main_widget.update(@update_count, mouse_x, mouse_y)
+
+            # Look for keys that are held down and delegate those events
+            @registered_hold_down_buttons.each do |id|
+                if button_down?(id)
+                    @main_widget.handle_key_held_down id, mouse_x, mouse_y 
+                end
+            end
+
             @update_count = @update_count + 1
         end 
     

data/lib/wads/version.rb

@@ -1,3 +1,3 @@
 module Wads
-    VERSION = "0.2.0"
+    VERSION = "0.2.4"
 end

data/lib/wads/widgets.rb

@@ -805,26 +805,6 @@ module Wads
             end
             container.get_coordinates(element_type, args)
         end
-
-        #
-        # This is a convenience method that creates a panel divided into a left and right,
-        # or east and west section. It will take up the entire space of the specified 
-        # ARG_SECTION in the args map.
-        #
-        def add_east_west_panel(args)
-            section = args[ARG_SECTION]
-            if section.nil?
-                raise "East west panels require the arg '#{ARG_SECTION}' with value #{@container_map.keys.join(', ')}"
-            end
-            container = @container_map[section]
-            new_panel = Panel.new(container.start_x, container.start_y,
-                                  container.max_width, container.max_height)
-            new_panel.set_layout(LAYOUT_EAST_WEST, args)
-            new_panel.base_z = @parent_widget.base_z
-            new_panel.disable_border
-            @parent_widget.add_child(new_panel)
-            new_panel
-        end
     end 
 
     # The layout sections are as follows:
@@ -841,9 +821,13 @@ module Wads
             super
             # Divide the height into 100, 100, and the middle gets everything else
             # Right now we are using 100 pixels rather than a percentage for the borders
-            middle_section_y_start = y + 100
-            height_middle_section = height - 100
-            @container_map[SECTION_NORTH] = GuiContainer.new(x, y, width, 100)
+            header_section_height = 100
+            if args[ARG_DESIRED_HEIGHT]
+                header_section_height = args[ARG_DESIRED_HEIGHT]
+            end
+            middle_section_y_start = y + header_section_height
+            height_middle_section = height - header_section_height
+            @container_map[SECTION_NORTH] = GuiContainer.new(x, y, width, header_section_height)
             @container_map[SECTION_CENTER] = GuiContainer.new(x, middle_section_y_start, width, height_middle_section, FILL_VERTICAL_STACK)
         end
     end 
@@ -1035,6 +1019,14 @@ module Wads
             @text_input_fields = []
         end
 
+        def pad(str, size, left_align = false)
+            str = str.to_s
+            if left_align
+                str[0, size].ljust(size, ' ')
+            else
+                str[0, size].rjust(size, ' ')
+            end
+        end
         def debug(message)
             WadsConfig.instance.get_logger.debug message 
         end
@@ -1077,8 +1069,10 @@ module Wads
         end
 
         def add_panel(section, args = {})
-            get_layout.add_max_panel({ ARG_SECTION => section,
-                                       ARG_THEME => @gui_theme}.merge(args))
+            new_panel = get_layout.add_max_panel({ ARG_SECTION => section,
+                                                   ARG_THEME => @gui_theme}.merge(args))
+            new_panel.disable_border
+            new_panel
         end
 
         def get_theme 
@@ -1406,9 +1400,11 @@ module Wads
             if id == Gosu::MsLeft
                 # Special handling for text input fields
                 # Mouse click: Select text field based on mouse position.
-                WadsConfig.instance.get_window.text_input = @text_input_fields.find { |tf| tf.under_point?(mouse_x, mouse_y) }
-                # Advanced: Move caret to clicked position
-                WadsConfig.instance.get_window.text_input.move_caret(mouse_x) unless WadsConfig.instance.get_window.text_input.nil?
+                if not @text_input_fields.empty?
+                    WadsConfig.instance.get_window.text_input = @text_input_fields.find { |tf| tf.under_point?(mouse_x, mouse_y) }
+                    # Advanced: Move caret to clicked position
+                    WadsConfig.instance.get_window.text_input.move_caret(mouse_x) unless WadsConfig.instance.get_window.text_input.nil?
+                end
 
                 result = handle_mouse_down mouse_x, mouse_y
             elsif id == Gosu::MsRight
@@ -1458,6 +1454,11 @@ module Wads
                 if not result.nil? and result.is_a? WidgetResult
                     return result 
                 end
+            else 
+                result = handle_key_up id, mouse_x, mouse_y
+                if not result.nil? and result.is_a? WidgetResult
+                    return result 
+                end
             end
 
             @children.each do |child| 
@@ -1468,6 +1469,11 @@ module Wads
                             return result 
                         end
                     end 
+                else 
+                    result = handle_key_up id, mouse_x, mouse_y
+                    if not result.nil? and result.is_a? WidgetResult
+                        return result 
+                    end
                 end
             end
         end
@@ -1702,6 +1708,25 @@ module Wads
             # empty base implementation
         end
 
+        #
+        # This callback is invoked for any key registered by the
+        # register_hold_down_key(id) method.
+        #
+        def handle_key_held_down id, mouse_x, mouse_y
+            # empty base implementation
+        end
+
+        #
+        # Override this method in your subclass to process when a key is released.
+        # The base implementation is empty.
+        # Note that the mouse was not necessarily positioned over this widget.
+        # You can check this using the contains_click(mouse_x, mouse_y) method
+        # and decide if you want to process the event based on that, if desired.
+        #
+        def handle_key_up id, mouse_x, mouse_y
+            # empty base implementation
+        end
+
         #
         # Override this method in your subclass to perform any logic needed
         # as part of the main Gosu update loop. In most cases, this method is
@@ -1762,6 +1787,9 @@ module Wads
                 @img = Gosu::Image.new(image)
             elsif image.is_a? Gosu::Image 
                 @img = image 
+            elsif image.is_a? Gosu::Color
+                @img = nil
+                @override_color = image
             else 
                 raise "ImageWidget requires either a filename or a Gosu::Image object"
             end
@@ -1771,11 +1799,16 @@ module Wads
             @scale = 1
             disable_border
             disable_background
-            set_dimensions(@img.width, @img.height)
+            set_dimensions(@img.width, @img.height) if @img
         end
 
         def render 
-            @img.draw @x, @y, z_order, @scale, @scale
+            if @img.nil?
+                # TODO draw a box
+                Gosu::draw_rect(@x, @y, @width - 1, @height - 1, @override_color, relative_z_order(Z_ORDER_GRAPHIC_ELEMENTS))
+            else
+                @img.draw @x, @y, z_order, @scale, @scale
+            end
         end
 
         def widget_z 

data/samples/gosu_bouncing_ball.rb

@@ -0,0 +1,34 @@
+require 'gosu'
+ 
+class AppWindow < Gosu::Window
+  def initialize
+    super(800, 600)
+    self.caption = 'Bouncing Ball'
+    @img = Gosu::Image.new("media/CircleYellow.png")
+    @x = 400
+    @y = 300
+    @delta_x = 2
+    @delta_y = 2
+  end
+ 
+  def update 
+    @x = @x + @delta_x
+    @y = @y + @delta_y
+    if @x < 0
+      @delta_x = 2
+    elsif @x > 800 - @img.width
+      @delta_x = -2
+    end
+    if @y < 0
+      @delta_y = 2
+    elsif @y > 600 - @img.height
+      @delta_y = -2
+    end
+  end 
+
+  def draw
+    @img.draw @x, @y, 1
+  end
+end
+ 
+AppWindow.new.show

data/samples/gosu_hello_world.rb

@@ -0,0 +1,16 @@
+require 'gosu'
+ 
+class GameWindow < Gosu::Window
+  def initialize
+    super(400, 300)
+    self.caption = 'Hello World App'
+    @font = Gosu::Font.new(24)
+  end
+ 
+  def draw
+    @font.draw_text("Hello World", 144, 120, 1)
+  end
+end
+ 
+window = GameWindow.new
+window.show

data/samples/gosu_reaction_time.rb

@@ -0,0 +1,121 @@
+require 'gosu'
+
+AVERAGE_RESPONSE_TIME = 284.to_f     # Per humanbenchmark.com, in milliseconds
+GAME_STATE_PROMPT_TO_START = 0
+GAME_STATE_RED = 1
+GAME_STATE_YELLOW = 2
+GAME_STATE_GREEN = 3
+GAME_STATE_OVER = 4
+
+class AppWindow < Gosu::Window
+  def initialize
+    super(600, 300)
+    self.caption = 'Reaction Time Game'
+    @update_count = 0
+    @next_light_count = 0
+    @messages = []
+    @font = Gosu::Font.new(32)
+    @red_light = Gosu::Image.new("media/CircleRed.png")
+    @yellow_light = Gosu::Image.new("media/CircleYellow.png")
+    @green_light = Gosu::Image.new("media/CircleGreen.png")
+    #  game state            0           1           2              3             4
+    #  state                 Prompt      Red         Yellow         Green         Game over
+    @traffic_light_images = [@red_light, @red_light, @yellow_light, @green_light, @green_light]
+    @traffic_light_color = GAME_STATE_PROMPT_TO_START
+  end
+ 
+  def update
+    @update_count = @update_count + 1
+    @traffic_light_image = @traffic_light_images[@traffic_light_color]
+
+    # Once the game is started, the lights progress automatically until green
+    if @traffic_light_color > GAME_STATE_PROMPT_TO_START
+      next_traffic_light unless @update_count < @next_light_count
+      @button_text = "Click when the light turns green" unless @traffic_light_color > GAME_STATE_GREEN
+    end
+  end
+
+  def draw
+    @font.draw_text("Reaction Time Game", 180, 10, 1)
+    @traffic_light_image.draw(248, 60, 1)
+    
+    if @traffic_light_color == GAME_STATE_PROMPT_TO_START
+      @font.draw_text("Press 'p' to play", 200, 200, 1)
+    elsif @traffic_light_color == GAME_STATE_OVER
+      @font.draw_text("Press 'p' to play again", 50, 200, 1)
+    else 
+      draw_button(@button_text) unless @button_text.nil?
+    end
+
+    y = 232
+    @messages.each do |msg|
+      @font.draw_text(msg, 50, y, 1)
+      y = y + 32
+    end
+  end
+
+  def button_down id
+    close if id == Gosu::KbEscape 
+
+    if @traffic_light_color == GAME_STATE_PROMPT_TO_START or @traffic_light_color == GAME_STATE_OVER
+      if id == Gosu::KbP
+        next_traffic_light
+      end
+      return
+    end
+    
+    if id == Gosu::MsLeft and button_contains_click
+      if @traffic_light_color < GAME_STATE_YELLOW 
+        next_traffic_light
+      elsif @traffic_light_color == GAME_STATE_YELLOW 
+        @traffic_light_color = GAME_STATE_OVER
+        @messages = ["Sorry, you were too early"]
+        @button_text = "Click to play again"
+      elsif @traffic_light_color == GAME_STATE_GREEN
+        @button_text = nil
+        time_since_green = ((Time.now - @mark_time) * 1000.to_f).round(3)
+        @messages = ["Response time: #{time_since_green} ms"]
+        diff_from_average = (((time_since_green - AVERAGE_RESPONSE_TIME) / AVERAGE_RESPONSE_TIME) * 100).round
+        if diff_from_average > 0
+          @messages << "#{diff_from_average}% slower than the average human"
+        elsif diff_from_average < 0
+          @messages << "#{-diff_from_average}% faster than the average human"
+        else 
+          @messages << "Wow, that is exactly the human average."
+        end 
+        @button_text = "Click to play again"
+        @traffic_light_color = GAME_STATE_OVER
+      else 
+        @traffic_light_color = GAME_STATE_PROMPT_TO_START
+        @messages = []
+      end 
+    end
+  end
+
+  def next_traffic_light 
+    return unless @traffic_light_color < GAME_STATE_GREEN
+    @traffic_light_color = @traffic_light_color + 1
+    @mark_time = Time.now
+    @next_light_count = @update_count + 60 + rand(100)
+  end
+
+  def button_contains_click 
+    mouse_x > 100 and mouse_x < 500 and mouse_y > 198 and mouse_y < 232
+  end 
+
+  def draw_button(text)
+    text_width = @font.text_width(text)
+    draw_box(100, 198, 500, 232)
+    text_x = (600 - text_width) / 2
+    @font.draw_text(@button_text, text_x, 200, 1)
+  end 
+
+  def draw_box(x1, y1, x2, y2, color = Gosu::Color::WHITE)
+    Gosu::draw_line x1, y1, color, x2, y1, color, 1
+    Gosu::draw_line x1, y1, color, x1, y2, color, 1
+    Gosu::draw_line x1, y2, color, x2, y2, color, 1
+    Gosu::draw_line x2, y1, color, x2, y2, color, 1
+  end
+end
+ 
+AppWindow.new.show

data/samples/stocks.rb

@@ -122,5 +122,5 @@ class StocksDisplay < Widget
     end 
 end
 
-WadsConfig.instance.set_current_theme(WadsBrightTheme.new)
+WadsConfig.instance.set_current_theme(WadsAquaTheme.new)
 SampleStocksApp.new.show

data/samples/wads_reaction_time.rb

@@ -0,0 +1,117 @@
+require 'gosu'
+require_relative '../lib/wads'
+
+include Wads 
+
+AVERAGE_RESPONSE_TIME = 284.to_f     # Per humanbenchmark.com, in milliseconds
+GAME_STATE_PROMPT_TO_START = 0
+GAME_STATE_RED = 1
+GAME_STATE_YELLOW = 2
+GAME_STATE_GREEN = 3
+GAME_STATE_OVER = 4
+
+
+class ReactionTimeApp < WadsApp
+    def initialize
+        super(600, 400, "Reaction Time Game", ReactionTimeDisplay.new)
+    end 
+end
+
+class ReactionTimeDisplay < Widget
+    def initialize
+        super(0, 0, 600, 400)
+        set_layout(LAYOUT_HEADER_CONTENT)
+        set_theme(WadsAquaTheme.new)
+        disable_border
+        @next_light_count = 0
+        @messages = []
+        @font = Gosu::Font.new(22)
+        @red_light = Gosu::Image.new("media/RedLight.png")
+        @yellow_light = Gosu::Image.new("media/YellowLight.png")
+        @green_light = Gosu::Image.new("media/GreenLight.png")
+        #  game state            0           1           2              3             4
+        #  state                 Prompt      Red         Yellow         Green         Game over
+        @traffic_light_images = [@red_light, @red_light, @yellow_light, @green_light, @green_light]
+        @traffic_light_color = GAME_STATE_PROMPT_TO_START
+
+        add_panel(SECTION_NORTH).get_layout.add_text("Reaction Time Game",
+                                                     { ARG_TEXT_ALIGN => TEXT_ALIGN_CENTER,
+                                                       ARG_USE_LARGE_FONT => true})
+        
+        content_panel = get_layout.add_max_panel({ARG_SECTION => SECTION_CENTER,
+                                                  ARG_LAYOUT => LAYOUT_EAST_WEST,
+                                                  ARG_THEME => WadsAquaTheme.new,
+                                                  ARG_PANEL_WIDTH => 140})
+        @traffic_light_image = content_panel.get_layout.add_image(@red_light,
+                                                 {ARG_SECTION => SECTION_WEST})
+
+        left_side_panel = content_panel.add_panel(SECTION_EAST)
+        left_side_panel.disable_border
+        @start_button = left_side_panel.get_layout.add_button("Click to play") do 
+            handle_button_click
+        end
+        @messages = left_side_panel.get_layout.add_document("")
+    end 
+
+    def handle_update update_count, mouse_x, mouse_y
+        @traffic_light_image.img = @traffic_light_images[@traffic_light_color]
+
+        if @traffic_light_color == GAME_STATE_PROMPT_TO_START or @traffic_light_color == GAME_STATE_OVER
+            @start_button.visible = true
+
+        elsif @traffic_light_color == GAME_STATE_RED or
+              @traffic_light_color == GAME_STATE_YELLOW or 
+              @traffic_light_color == GAME_STATE_GREEN
+            @messages.lines = ["Hit the space bar when the light turns green"]
+            @start_button.visible = false
+            if @mark_time.nil?
+                @mark_time = Time.now
+                @next_light_count = update_count + 60 + rand(100)
+            end
+            next_traffic_light unless update_count < @next_light_count
+        end  
+    end
+
+    def handle_button_click
+        if @traffic_light_color == GAME_STATE_PROMPT_TO_START or @traffic_light_color == GAME_STATE_OVER
+            @messages.lines = []
+            next_traffic_light
+        end
+    end
+
+    def handle_key_press id, mouse_x, mouse_y
+        return WidgetResult.new(true) if id == Gosu::KbEscape
+
+        if id == Gosu::KbSpace
+            if @traffic_light_color < GAME_STATE_YELLOW 
+                next_traffic_light
+            elsif @traffic_light_color == GAME_STATE_YELLOW 
+                @traffic_light_color = GAME_STATE_OVER
+                @messages.lines = ["Sorry, you were too early"]
+            elsif @traffic_light_color == GAME_STATE_GREEN
+                time_since_green = ((Time.now - @mark_time) * 1000.to_f).round(3)
+                @messages.lines = ["Response time: #{time_since_green} ms"]
+                diff_from_average = (((time_since_green - AVERAGE_RESPONSE_TIME) / AVERAGE_RESPONSE_TIME) * 100).round
+                if diff_from_average > 0
+                    @messages.lines << "#{diff_from_average}% slower than the average human"
+                elsif diff_from_average < 0
+                    @messages.lines << "#{-diff_from_average}% faster than the average human"
+                else 
+                    @messages.lines << "Wow, that is exactly the human average."
+                end 
+                @traffic_light_color = GAME_STATE_OVER
+            end 
+        end
+    end
+
+    def next_traffic_light
+        if @traffic_light_color == GAME_STATE_OVER
+            @traffic_light_color = GAME_STATE_RED
+        elsif @traffic_light_color < GAME_STATE_OVER
+            @traffic_light_color = @traffic_light_color + 1
+        end
+        @mark_time = nil
+    end
+end
+
+ReactionTimeApp.new.show

data/wads.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "gosu", "~> 1.1.0"
+  spec.add_dependency "gosu", ">= 1.1.0"
   spec.add_dependency "minigl", "~> 2.3.5"
   spec.add_dependency "tty-option"
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: wads
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.4
 platform: ruby
 authors:
 - dbroemme
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-09 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
@@ -87,18 +87,25 @@ files:
 - media/CircleRed.png
 - media/CircleWhite.png
 - media/CircleYellow.png
+- media/GreenLight.png
+- media/RedLight.png
 - media/SampleGraph.png
 - media/StocksSample.png
 - media/WadsScreenshot.png
+- media/YellowLight.png
 - run-graph
 - run-star-wars
 - run-stocks
 - run-theme-test
 - samples/basic_gosu_with_graph_widget.rb
+- samples/gosu_bouncing_ball.rb
+- samples/gosu_hello_world.rb
+- samples/gosu_reaction_time.rb
 - samples/graph.rb
 - samples/star_wars.rb
 - samples/stocks.rb
 - samples/theme_test.rb
+- samples/wads_reaction_time.rb
 - wads.gemspec
 homepage: https://github.com/dbroemme/ruby-wads
 licenses: []
@@ -121,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Simple, easy to use data structure classes and Gosu widgets