gosu-examples 1.0.4 → 1.0.7

data/examples/text_input.rb

@@ -0,0 +1,157 @@
+# This example demonstrates use of the TextInput class with three text field widgets.
+# One can cycle through them with tab, or click into the text fields and change their contents.
+
+# The way TextInput works is that you create an instance of it, and then assign it to the text_input
+# attribute of your window.
+# Until you set this attribute to nil again, the TextInput object will then build a string from user
+# input that can be accessed via TextInput#text.
+
+# The TextInput object also maintains the position of the caret, which is defined as the index of
+# its right neighbour character, i.e. a carent_pos of 0 is always the left-most position, and a
+# caret_pos of text.length is always the right-most position.
+# There is a second attribute called selection_start that is equal to caret_pos when there is no
+# selection, and otherwise defines the selected range. If you set caret_pos to a different value,
+# you usually want to set selection_start as well.
+
+# A TextInput object is purely abstract. Drawing the input field is left to the user.
+# In this example, we are subclassing TextInput to add this code, but you can also work with
+# composition instead of inheritance.
+
+require "gosu"
+
+class TextField < Gosu::TextInput
+  FONT = Gosu::Font.new(20)
+  WIDTH = 350
+  LENGTH_LIMIT = 20
+  PADDING = 5
+
+  INACTIVE_COLOR = 0xcc_666666
+  ACTIVE_COLOR = 0xcc_ff6666
+  SELECTION_COLOR = 0xcc_0000ff
+  CARET_COLOR = 0xff_ffffff
+
+  attr_reader :x, :y
+
+  def initialize(window, x, y)
+    # It's important to call the inherited constructor.
+    super()
+
+    @window, @x, @y = window, x, y
+
+    # Start with a self-explanatory text in each field.
+    self.text = "Click to edit"
+  end
+
+  # In this example, we use the filter method to prevent the user from entering a text that exceeds
+  # the length limit. However, you can also use this to blacklist certain characters, etc.
+  def filter(new_text)
+    allowed_length = [LENGTH_LIMIT - text.length, 0].max
+    new_text[0, allowed_length]
+  end
+
+  def draw(z)
+    # Change the background colour if this is the currently selected text field.
+    if @window.text_input == self
+      color = ACTIVE_COLOR
+    else
+      color = INACTIVE_COLOR
+    end
+    Gosu.draw_rect x - PADDING, y - PADDING, WIDTH + 2 * PADDING, height + 2 * PADDING, color, z
+
+    # Calculate the position of the caret and the selection start.
+    pos_x = x + FONT.text_width(self.text[0...self.caret_pos])
+    sel_x = x + FONT.text_width(self.text[0...self.selection_start])
+    sel_w = pos_x - sel_x
+
+    # Draw the selection background, if any. (If not, sel_x and pos_x will be
+    # the same value, making this a no-op call.)
+    Gosu.draw_rect sel_x, y, sel_w, height, SELECTION_COLOR, z
+
+    # Draw the caret if this is the currently selected field.
+    if @window.text_input == self
+      Gosu.draw_line pos_x, y, CARET_COLOR, pos_x, y + height, CARET_COLOR, z
+    end
+
+    # Finally, draw the text itself!
+    FONT.draw_text self.text, x, y, z
+  end
+
+  def height
+    FONT.height
+  end
+
+  # Hit-test for selecting a text field with the mouse.
+  def under_mouse?
+    @window.mouse_x > x - PADDING and @window.mouse_x < x + WIDTH + PADDING and
+      @window.mouse_y > y - PADDING and @window.mouse_y < y + height + PADDING
+  end
+
+  # Tries to move the caret to the position specifies by mouse_x
+  def move_caret_to_mouse
+    # Test character by character
+    1.upto(self.text.length) do |i|
+      if @window.mouse_x < x + FONT.text_width(text[0...i])
+        self.caret_pos = self.selection_start = i - 1
+        return
+      end
+    end
+    # Default case: user must have clicked the right edge
+    self.caret_pos = self.selection_start = self.text.length
+  end
+end
+
+class TextInputDemo < (Example rescue Gosu::Window)
+  def initialize
+    super 640, 480
+    self.caption = "Text Input Demo"
+
+    text =
+      "This demo explains (in the source code) how to use the Gosu::TextInput API by building a little TextField class around it.
+
+      Each text field can take up to 30 characters, and you can use Tab to switch between them.
+
+      As in every example, press <b>E</b> to look at the source code."
+
+    # Remove all leading spaces so the text is left-aligned
+    text.gsub! /^ +/, ""
+
+    @text = Gosu::Image.from_markup text, 20, width: 540
+
+    # Set up an array of three text fields.
+    @text_fields = Array.new(3) { |index| TextField.new(self, 50, 300 + index * 50) }
+  end
+
+  def needs_cursor?
+    true
+  end
+
+  def draw
+    @text.draw 50, 50, 0
+    @text_fields.each { |tf| tf.draw(0) }
+  end
+
+  def button_down(id)
+    if id == Gosu::KB_TAB
+      # Tab key will not be 'eaten' by text fields; use for switching through
+      # text fields.
+      index = @text_fields.index(self.text_input) || -1
+      self.text_input = @text_fields[(index + 1) % @text_fields.size]
+    elsif id == Gosu::KB_ESCAPE
+      # Escape key will not be 'eaten' by text fields; use for deselecting.
+      if self.text_input
+        self.text_input = nil
+      else
+        close
+      end
+    elsif id == Gosu::MS_LEFT
+      # Mouse click: Select text field based on mouse position.
+      self.text_input = @text_fields.find { |tf| tf.under_mouse? }
+      # Also move caret to clicked position
+      self.text_input.move_caret_to_mouse unless self.text_input.nil?
+    else
+      super
+    end
+  end
+end
+
+TextInputDemo.new.show if __FILE__ == $0

data/examples/tutorial.rb

@@ -1,7 +1,4 @@
-# Encoding: UTF-8
-
-require 'rubygems'
-require 'gosu'
+require "gosu"
 
 module ZOrder
   BACKGROUND, STARS, PLAYER, UI = *0..3
@@ -9,45 +6,45 @@ end
 
 class Player
   attr_reader :score
-  
+
   def initialize
     @image = Gosu::Image.new("media/starfighter.bmp")
     @beep = Gosu::Sample.new("media/beep.wav")
     @x = @y = @vel_x = @vel_y = @angle = 0.0
     @score = 0
   end
-  
+
   def warp(x, y)
     @x, @y = x, y
   end
-  
+
   def turn_left
     @angle -= 4.5
   end
-  
+
   def turn_right
     @angle += 4.5
   end
-  
+
   def accelerate
     @vel_x += Gosu.offset_x(@angle, 0.5)
     @vel_y += Gosu.offset_y(@angle, 0.5)
   end
-  
+
   def move
     @x += @vel_x
     @y += @vel_y
     @x %= 640
     @y %= 480
-    
+
     @vel_x *= 0.95
     @vel_y *= 0.95
   end
-  
+
   def draw
     @image.draw_rot(@x, @y, ZOrder::PLAYER, @angle)
   end
-  
+
   def collect_stars(stars)
     stars.reject! do |star|
       if Gosu.distance(@x, @y, star.x, star.y) < 35
@@ -63,7 +60,7 @@ end
 
 class Star
   attr_reader :x, :y
-  
+
   def initialize(animation)
     @animation = animation
     @color = Gosu::Color::BLACK.dup
@@ -73,11 +70,11 @@ class Star
     @x = rand * 640
     @y = rand * 480
   end
-  
+
   def draw
     img = @animation[Gosu.milliseconds / 100 % @animation.size]
     img.draw(@x - img.width / 2.0, @y - img.height / 2.0,
-        ZOrder::STARS, 1, 1, @color, :add)
+             ZOrder::STARS, 1, 1, @color, :add)
   end
 end
 
@@ -85,18 +82,18 @@ class Tutorial < (Example rescue Gosu::Window)
   def initialize
     super 640, 480
     self.caption = "Tutorial Game"
-    
-    @background_image = Gosu::Image.new("media/space.png", :tileable => true)
-    
+
+    @background_image = Gosu::Image.new("media/space.png", tileable: true)
+
     @player = Player.new
     @player.warp(320, 240)
-    
+
     @star_anim = Gosu::Image::load_tiles("media/star.png", 25, 25)
     @stars = Array.new
-    
+
     @font = Gosu::Font.new(20)
   end
-  
+
   def update
     if Gosu.button_down? Gosu::KB_LEFT or Gosu.button_down? Gosu::GP_LEFT
       @player.turn_left
@@ -109,19 +106,19 @@ class Tutorial < (Example rescue Gosu::Window)
     end
     @player.move
     @player.collect_stars(@stars)
-    
+
     if rand(100) < 4 and @stars.size < 25
       @stars.push(Star.new(@star_anim))
     end
   end
-  
+
   def draw
     @background_image.draw(0, 0, ZOrder::BACKGROUND)
     @player.draw
     @stars.each { |star| star.draw }
-    @font.draw("Score: #{@player.score}", 10, 10, ZOrder::UI, 1.0, 1.0, Gosu::Color::YELLOW)
+    @font.draw_text("Score: #{@player.score}", 10, 10, ZOrder::UI, 1.0, 1.0, Gosu::Color::YELLOW)
   end
-  
+
   def button_down(id)
     if id == Gosu::KB_ESCAPE
       close

data/examples/welcome.rb

@@ -1,55 +1,52 @@
-# Encoding: UTF-8
-
-require 'rubygems'
-require 'gosu'
+require "gosu"
 
 WIDTH, HEIGHT = 640, 480
 
 class Welcome < (Example rescue Gosu::Window)
   PADDING = 20
-  
+
   def initialize
     super WIDTH, HEIGHT
-    
+
     self.caption = "Welcome!"
-    
+
     text =
       "<b>Welcome to the Gosu Example Box!</b>
-      
+
       This little tool lets you launch any of Gosu’s example games from the list on the right hand side of the screen.
-      
+
       Every example can be run both from this tool <i>and</i> from the terminal/command line as a stand-alone Ruby script.
-      
+
       Keyboard shortcuts:
-      
+
       • To see the source code of an example or feature demo, press <b>E</b>.
       • To open the ‘examples’ folder, press <b>O</b>.
       • To quit this tool, press <b>Esc</b>.
       • To toggle fullscreen mode, press <b>Alt+Enter</b> (Windows, Linux) or <b>cmd+F</b> (macOS).
-      
-      Why not take a look at the code for this example right now? Simply press <b>S</b>."
-    
+
+      Why not take a look at the code for this example right now? Simply press <b>E</b>."
+
     # Remove all leading spaces so the text is left-aligned
-    text.gsub! /^ +/, ''
-    
-    @text = Gosu::Image.from_text text, 20, :width => WIDTH - 2 * PADDING
-    
+    text.gsub! /^ +/, ""
+
+    @text = Gosu::Image.from_markup text, 20, width: WIDTH - 2 * PADDING
+
     @background = Gosu::Image.new "media/space.png"
   end
-  
+
   def draw
     draw_rotating_star_backgrounds
-    
+
     @text.draw PADDING, PADDING, 0
   end
-  
+
   def draw_rotating_star_backgrounds
     # Disregard the math in this method, it doesn't look as good as I thought it
     # would. =(
-    
+
     angle = Gosu.milliseconds / 50.0
     scale = (Gosu.milliseconds % 1000) / 1000.0
-    
+
     [1, 0].each do |extra_scale|
       @background.draw_rot WIDTH * 0.5, HEIGHT * 0.75, 0, angle, 0.5, 0.5,
         scale + extra_scale, scale + extra_scale

data/lib/gosu-examples/example.rb

@@ -1,57 +1,78 @@
 class Example
   attr_accessor :caption
   attr_reader :width, :height
-  
+  attr_writer :parent_window
+
   def initialize(width, height, *options)
     @width, @height = width, height
   end
-  
+
   def draw
   end
-  
+
   def update
   end
-  
+
   def button_down(id)
   end
-  
+
   def button_up(id)
   end
-  
+
   def close
     # no-op, examples cannot close the containing window.
   end
 
+  def mouse_x
+    @parent_window && @parent_window.mouse_x
+  end
+
+  def mouse_y
+    @parent_window && @parent_window.mouse_y
+  end
+
+  def text_input
+    @parent_window && @parent_window.text_input
+  end
+
+  def text_input=(text_input)
+    @parent_window && @parent_window.text_input = text_input
+  end
+
   def self.current_source_file
     @current_source_file
   end
-  
+
   def self.current_source_file=(current_source_file)
     @current_source_file = current_source_file
   end
-  
+
   def self.inherited(subclass)
     @@examples ||= {}
     @@examples[subclass] = self.current_source_file
   end
-  
+
   def self.examples
     @@examples.keys
   end
-  
+
   def self.source_file
     @@examples[self]
   end
-  
+
+  def self.initial_example
+    @@examples.keys.find { |cls| cls.name.end_with? "::Welcome" }
+  end
+
   def self.load_examples(pattern)
-    Dir.glob(pattern) do |file| 
+    Dir.glob(pattern) do |file|
       begin
         # Remember which file we are loading.
         Example.current_source_file = File.expand_path(file)
 
         # Load the example in a sandbox module (second parameter to load()). This way, examples can
         # define classes and constants with the same names, and they will not collide.
-        # 
+        #
         # load() does not let us refer to the anonymous module it creates, but we can enumerate all
         # loaded examples using Example.examples thanks to the "inherited" callback above.
         load file, true

data/lib/gosu-examples/sidebar.rb

@@ -2,57 +2,57 @@ class Sidebar
   WIDTH = 300
   HEIGHT = 600
   FONT = Gosu::Font.new(20)
-  HEADER = Gosu::Image.new("media/header@2x.psd", :tileable => true)
-  
+  HEADER = Gosu::Image.new("media/header@2x.psd", tileable: true)
+
   class Button
     HEIGHT = 25
     SPACING = 5
     TOP_Y = HEADER.height / 2 + 15
-    
+
     attr_reader :filename
-    
+
     def initialize(top, filename, &handler)
       @top, @filename, @handler = top, filename, handler
     end
-    
+
     def draw(is_current)
       text_color = Gosu::Color::BLACK
-      
+
       if is_current
-        Gosu.draw_rect 0, @top, Sidebar::WIDTH, HEIGHT, 0xff_1565e5 if is_current
+        Gosu.draw_rect 0, @top, Sidebar::WIDTH, HEIGHT, 0xff_1565e5
         text_color = Gosu::Color::WHITE
       end
-      
-      FONT.draw File.basename(@filename), 13, @top + 2, 0, 1, 1, text_color
+
+      FONT.draw_text File.basename(@filename), 13, @top + 2, 0, 1, 1, text_color
     end
-    
+
     def click
       @handler.call
     end
   end
-  
+
   def initialize
     y = Button::TOP_Y - Button::HEIGHT - Button::SPACING
-    
+
     @buttons = Example.examples.map do |example|
       y += (Button::HEIGHT + Button::SPACING)
-      
+
       Button.new(y, example.source_file) do
         yield(example)
       end
     end
   end
-  
+
   def draw(current_filename)
     Gosu.draw_rect 0, 0, WIDTH, HEIGHT, Gosu::Color::WHITE
     HEADER.draw 0, 0, 0, 0.5, 0.5
-    
+
     @buttons.each do |button|
       is_current = (button.filename == current_filename)
       button.draw(is_current)
     end
   end
-  
+
   def click(x, y)
     index = (y - Button::TOP_Y).floor / (Button::HEIGHT + Button::SPACING)
     @buttons[index].click if @buttons[index]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosu-examples
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.7
 platform: ruby
 authors:
 - Julian Raschke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-22 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.0.0
 description: The `gosu-examples` tool provides an easy way to run and inspect example
   games written for the Gosu game development library.
 email: julian@raschke.de
@@ -38,29 +38,6 @@ files:
 - examples/chipmunk_and_rmagick.rb
 - examples/chipmunk_integration.rb
 - examples/cptn_ruby.rb
-- examples/media/BrokenPNG.png
-- examples/media/Cursor.png
-- examples/media/JingleBells.mp3
-- examples/media/JingleBells.ogg
-- examples/media/Loop.wav
-- examples/media/Sample.wav
-- examples/media/SquareTexture.png
-- examples/media/Wallpaper.png
-- examples/media/WallpaperXXL.png
-- examples/media/WhiteAlpha.png
-- examples/media/audio_formats/aiff_32bit_float.aiff
-- examples/media/audio_formats/au_16bit_pcm.au
-- examples/media/audio_formats/caf_be_16bit_44khz.caf
-- examples/media/audio_formats/caf_le_16bit_44khz.caf
-- examples/media/audio_formats/caf_le_8bit_44khz.caf
-- examples/media/audio_formats/general_midi.mid
-- examples/media/audio_formats/impulse_tracker.it
-- examples/media/audio_formats/mp3_128k_stereo.mp3
-- examples/media/audio_formats/mp3_avg_96kbit_jointstereo.mp3
-- examples/media/audio_formats/ogg_vorbis.ogg
-- examples/media/audio_formats/wav_16bit_pcm.wav
-- examples/media/audio_formats/wav_32bit_pcm.wav
-- examples/media/audio_formats/wav_4bit_ms_adpcm.wav
 - examples/media/beep.wav
 - examples/media/cptn_ruby.png
 - examples/media/cptn_ruby_map.txt
@@ -68,8 +45,6 @@ files:
 - examples/media/explosion.wav
 - examples/media/gem.png
 - examples/media/header@2x.psd
-- examples/media/image_formats/test.jpg
-- examples/media/image_formats/test.psd
 - examples/media/landscape.svg
 - examples/media/large_star.png
 - examples/media/smoke.png
@@ -78,9 +53,9 @@ files:
 - examples/media/star.png
 - examples/media/starfighter.bmp
 - examples/media/tileset.png
-- examples/media/vera.ttf
 - examples/opengl_integration.rb
 - examples/rmagick_integration.rb
+- examples/text_input.rb
 - examples/tutorial.rb
 - examples/welcome.rb
 - lib/gosu-examples/example.rb
@@ -88,7 +63,7 @@ files:
 homepage: http://www.libgosu.org/
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,16 +71,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.2
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Ruby examples for the Gosu library
 test_files: []