minigl 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 450b8d40d9d7a949621ae94fac7cdf702742e80a
-  data.tar.gz: e70c4b21bcf68daed5a06704dfbbb2cc16234cfe
+  metadata.gz: 667a3bf9b0c24c5b639a09bd70f8020fa09d7f88
+  data.tar.gz: 6c57295ac2e1e00a442d8ab87a959c4dc10b63d9
 SHA512:
-  metadata.gz: 159a32f1c0ea9688e10d8599984b6d0e65ed4579e49c94b80a02bf77c065d7bceca0127be3a011acf174c6d5cd1067f51996c60e17d9a36ed56dece1e340aa7b
-  data.tar.gz: c9bc082ef4e2ce42b531d665ad0be11e65897830fdf4367e6262c2aba790f23bfba857ff4cf01a7d776313a264293b43c9c07851ce6407b73005b1d129d3d3bc
+  metadata.gz: 3e958267a7ff88286ed27bba81e4e59554fbb91dc80f5fe351368060074b4c6a12439f43fd91ef388d6117f73bf0e8a8931e69209eb0b8ef3acf3ee134bcf4d8
+  data.tar.gz: a5f27fd536134d5a4dd69113ed5c35d98db356fe0afaad3856be0160489fe98606c877e3d0fcb26a86f2e2f7e673fd2e12d9298b73903df6b3d75338bea0c150

data/README.md

@@ -22,8 +22,9 @@ this [working game example](https://github.com/victords/aventura-do-saber).
   * An auxiliary, tutorial-like documentation is under construction
 [here](https://github.com/victords/minigl/wiki).
 
-**Version 1.2.7**
+**Version 1.3.0**
 
-  * Completed and added documentation for the `Effect` class.
-  * Slight adjusts in the documentation.
-  * Slight adjust in the implementation of `Button`.
+  * Introduced the `ToggleButton` class.
+  * `Button` action now accepts parameters.
+  * `TextField` now triggers a "text changed" event (which accepts parameters,
+as well).

data/lib/minigl/forms.rb

@@ -28,9 +28,15 @@ module AGL
 		#         if +img+ is +nil+.
 		# [height] Height of the button clickable area. This parameter is used
 		#          only if +img+ is +nil+.
+		# [params] An object containing any parameters you want passed to the
+		#          +action+ block. When the button is clicked, the following is
+		#          called:
+		#            @action.call @params
+		#          Note that this doesn't force you to declare a block that takes
+		#          parameters.
 		# [action] The block of code executed when the button is clicked (or by
 		#          calling the +click+ method).
-		def initialize x, y, font, text, img, text_color = 0, center = true, margin_x = 0, margin_y = 0, width = nil, height = nil, &action
+		def initialize x, y, font, text, img, text_color = 0, center = true, margin_x = 0, margin_y = 0, width = nil, height = nil, params = nil, &action
 			@x = x
 			@y = y
 			@font = font
@@ -54,6 +60,7 @@ module AGL
 			@text_color = text_color
 			@center = center
 			@action = action
+			@params = params
 		
 			@state = :up
 			@img_index = 0
@@ -70,6 +77,8 @@ module AGL
 				if mouse_over
 					@img_index = 1
 					@state = :over
+				else
+					@img_index = 0
 				end
 			elsif @state == :over
 				if not mouse_over
@@ -78,30 +87,36 @@ module AGL
 				elsif mouse_press
 					@img_index = 2
 					@state = :down
+				else
+					@img_index = 1
 				end
 			elsif @state == :down
 				if not mouse_over
 					@img_index = 0
 					@state = :down_out
 				elsif mouse_rel
-					@img_index = 0
-					@state = :up
+					@img_index = 1
+					@state = :over
 					click
+				else
+					@img_index = 2
 				end
-			elsif @state == :down_out
+			else # :down_out
 				if mouse_over
 					@img_index = 2
 					@state = :down
 				elsif mouse_rel
 					@img_index = 0
 					@state = :up
+				else
+					@img_index = 0
 				end
 			end
 		end
 		
 		# Executes the button click action.
 		def click
-			@action.call
+			@action.call @params
 		end
 		
 		# Sets the position of the button in the screen.
@@ -141,6 +156,64 @@ module AGL
 		end
 	end
 	
+	# This class represents a toggle button, which can be also interpreted as a
+	# check box. It is always in one of two states, given as +true+ or +false+
+	# by its property +checked+.
+	class ToggleButton < Button
+		# Defines the state of the button (returns +true+ or +false+).
+		attr_reader :checked
+		
+		# Creates a ToggleButton. All parameters work the same as in Button,
+		# except the image, +img+, which now has to be composed of two columns
+		# and three rows, the first column with images for the unchecked state,
+		# and the second with images for the checked state.
+		# 
+		# The +action+ block now will always receive a first boolean parameter
+		# corresponding to the value of +checked+. So, if you want to pass
+		# parameters to the block, you should declare it like this:
+		#   b = ToggleButton.new ... { |checked, params|
+		#     puts "button was checked" if checked
+		#     # do something with params
+		#   }
+		def initialize x, y, font, text, img, text_color = 0, center = true, margin_x = 0, margin_y = 0, width = nil, height = nil, params = nil, &action
+			super x, y, font, text, nil, text_color, center, margin_x, margin_y, width, height, params, &action
+			@img =
+				if img; Res.imgs img, 2, 3, true
+				else; nil; end
+			@w =
+				if img; @img[0].width
+				else; width; end
+			@h =
+				if img; @img[0].height
+				else; height; end
+		end
+		
+		# Updates the button, checking the mouse movement and buttons to define
+		# the button state.
+		def update
+			super
+			@img_index *= 2
+			@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
+		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
+			@checked = value
+		end
+	end
+	
 	# This class represents a text field (input).
 	class TextField
 		# The current text inside the text field.
@@ -176,8 +249,17 @@ module AGL
 		# [selection_color] The color of the rectangle highlighting selected text,
 		#                   in hexadecimal RRGGBB format. The rectangle will
 		#                   always be drawn with 50% of opacity.
+		# [params] An object containing any parameters you want passed to the
+		#          +on_text_changed+ block. When the text of the text field is
+		#          changed, the following is called:
+		#            @on_text_changed.call @params
+		#          Note that this doesn't force you to declare a block that takes
+		#          parameters.
+		# [on_text_changed] The block of code executed when the text in the text
+		#                   field is changed, either by user input or by calling
+		#                   +text=+. Can be +nil+.
 		def initialize x, y, font, img, cursor_img = nil, margin_x = 0, margin_y = 0, max_length = 100, active = false, text = "",
-		               allowed_chars = nil, text_color = 0, selection_color = 0
+		               allowed_chars = nil, text_color = 0, selection_color = 0, params = nil, &on_text_changed
 			@x = x
 			@y = y
 			@font = font
@@ -221,6 +303,9 @@ module AGL
 				else
 					@chars
 				end
+			
+			@on_text_changed = on_text_changed
+			@params = params
 		end
 		
 		# Updates the text field, checking for mouse events and keyboard input.
@@ -280,7 +365,7 @@ module AGL
 			inserted = false
 			for i in 0..46 # alnum
 				if KB.key_pressed?(@k[i]) or KB.key_held?(@k[i])
-					remove_interval if @anchor1 and @anchor2
+					remove_interval true if @anchor1 and @anchor2
 					if i < 26
 #						bool capsLock = Console.CapsLock;
 						if shift
@@ -400,6 +485,7 @@ module AGL
 			@anchor1 = nil
 			@anchor2 = nil
 			set_cursor_visible
+			@on_text_changed.call @params if @on_text_changed
 		end
 		
 		# Returns the currently selected text.
@@ -495,19 +581,18 @@ module AGL
 		end
 		
 		def insert_char char
-			return unless @allowed_chars.index char
-			if @text.length < @max_length
-				@text.insert @cur_node, char
-				@nodes.insert @cur_node + 1, @nodes[@cur_node] + @font.text_width(char)
-				for i in (@cur_node + 2)..(@nodes.size - 1)
-					@nodes[i] += @font.text_width(char)
-				end
-				@cur_node += 1
-				set_cursor_visible
+			return unless @allowed_chars.index char and @text.length < @max_length
+			@text.insert @cur_node, char
+			@nodes.insert @cur_node + 1, @nodes[@cur_node] + @font.text_width(char)
+			for i in (@cur_node + 2)..(@nodes.size - 1)
+				@nodes[i] += @font.text_width(char)
 			end
+			@cur_node += 1
+			set_cursor_visible
+			@on_text_changed.call @params if @on_text_changed
 		end
 		
-		def remove_interval
+		def remove_interval will_insert = false
 			min = @anchor1 < @anchor2 ? @anchor1 : @anchor2
 			max = min == @anchor1 ? @anchor2 : @anchor1
 			interval_width = 0
@@ -523,6 +608,7 @@ module AGL
 			@anchor1 = nil
 			@anchor2 = nil
 			set_cursor_visible
+			@on_text_changed.call @params if @on_text_changed and not will_insert
 		end
 		
 		def remove_char back
@@ -534,6 +620,7 @@ module AGL
 				@nodes[i] -= char_width
 			end
 			set_cursor_visible
+			@on_text_changed.call @params if @on_text_changed
 		end
 	end
 end

data/test/game.rb

@@ -11,8 +11,9 @@ class MyGame < Gosu::Window
     
     @font = Res.font :font1, 20
     @writer = TextHelper.new @font, 5
-    @btn = Button.new(10, 560, @font, "Test", :btn, 0x008000) {}
-    @txt = TextField.new 10, 520, @font, :text, nil, 15, 5, 16, false, "", nil, 0, 0x0000ff
+    @btn = Button.new(10, 560, @font, "Test", :btn, 0x008000, 0, 0, 0, 0, 0, "friends") { |x| puts "hello #{x}" }
+    @chk = ToggleButton.new(210, 560, @font, "Click me", :check, 0xffffffff, false, 36, 5, 0, 0, "friends") { |c, x| puts "hello #{x}, checked: #{c}" }
+    @txt = TextField.new(10, 520, @font, :text, nil, 15, 5, 16, false, "", nil, 0, 0x0000ff, "test") { |x| puts "field #{x}" }
   end
   
   def needs_cursor?
@@ -26,6 +27,7 @@ class MyGame < Gosu::Window
     @obj1.y += 1 if KB.key_held? Gosu::KbDown
     @obj1.x -= 1 if KB.key_down? Gosu::KbLeft
     @btn.set_position rand(700), rand(550) if KB.key_pressed? Gosu::KbSpace
+    @chk.checked = false if KB.key_pressed? Gosu::KbEscape
     @txt.set_position rand(700), rand(550) if KB.key_pressed? Gosu::KbReturn
     
     Mouse.update
@@ -35,6 +37,7 @@ class MyGame < Gosu::Window
     end
     
     @btn.update
+    @chk.update
     @txt.update
   end
 
@@ -44,9 +47,10 @@ class MyGame < Gosu::Window
     @writer.write_breaking "Testing multiple line text.\nThis should draw text "\
                            "across multiple lines, respecting a limit width. "\
                            "Furthermore, the text must be right-aligned.",
-                           780, 300, 300, :right
+                           780, 300, 300, :right, 0xffffffff
     
     @btn.draw 0xcc
+    @chk.draw
     @txt.draw
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -41,6 +41,7 @@ files:
 - Rakefile
 - data/font/font1.ttf
 - data/img/btn.png
+- data/img/check.png
 - data/img/image.png
 - data/img/img1.png
 - data/img/text.png