minigl 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6519693f68d4a4961b9b21e9379f46d76aaf042f
-  data.tar.gz: 9e5058266fb5de59417e4dcf13b6691700da5829
+  metadata.gz: d6075180b99d1cf18a53a683353828675ed18ca8
+  data.tar.gz: c01f4bd208021a2bff3f2c1aa3f86eac0c7ff093
 SHA512:
-  metadata.gz: 33c31a6af23f16ee8222642845d45f170508fe714a4e79d61aa3e1fc0f53eddc63438935ab5deaea6629ceac7a9c416626afb4e01c99a3682fc3108e9129d20a
-  data.tar.gz: cfeea61e4d33ef190302c82314c346c3ea7d37309dc5db38c42984cc2b29ffdec3bedc27330d07cd361125bdb76ddada346659bb12e25c0c77512568e166b2c4
+  metadata.gz: 6981a60cbd32da81a0c96553536dd77b440ccd913cd1a612a23b64292051ec69924e6ed2058df2de72ef75a5db4f5869edec3ded25963d8012b999b17575285a
+  data.tar.gz: 15e2fc67ac2b072da7e3a80b026fe5787b2df7804451aedd28d4e5a0f9e70dfd6ec299be7463b38e354279b87c27a6a9660d4fa00aaae6ae7f32fcad35d534ad

data/README.md

@@ -22,12 +22,11 @@ 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.3.2**
+**Version 1.3.3**
 
-  * Created documentation for the abstract class `Component`.
-  * Granted read and write access to the `params` attribute for all components.
-  * Fixed issue with `ToggleButton` instantiation with no width and height set.
-  * Added `checked` parameter to the constructor of `ToggleButton`.
+  * Added `mass` attribute to the GameObject class and Movement module.
+  * Added readers for the attributes of `Ramp`.
+  * Added z-index support to all drawing functions.
 
-**WARNING**: this version can generate incompatibility, because of the parameter
-order in the constructor for `ToggleButton`.
+**WARNING**: this version can generate incompatibility, because the `move`
+method of `Movement` now requires the calling object to have a `mass` attribute.

data/lib/minigl/forms.rb

@@ -173,17 +173,19 @@ module AGL
 		# Parameters:
 		# [alpha] The opacity with which the button will be drawn. Allowed values
 		#         vary between 0 (fully transparent) and 255 (fully opaque).
-		def draw alpha = 0xff
+		# [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 draw alpha = 0xff, z_index = 0
 			return unless @visible
 			
 			color = (alpha << 24) | 0xffffff
 			text_color = (alpha << 24) | (@enabled ? @text_color : @disabled_text_color)
-			@img[@img_index].draw @x, @y, 0, 1, 1, color if @img
+			@img[@img_index].draw @x, @y, z_index, 1, 1, color if @img
 			if @text
 				if @center
-					@font.draw_rel @text, @text_x, @text_y, 0, 0.5, 0.5, 1, 1, text_color
+					@font.draw_rel @text, @text_x, @text_y, z_index, 0.5, 0.5, 1, 1, text_color
 				else
-					@font.draw @text, @text_x, @text_y, 0, 1, 1, text_color
+					@font.draw @text, @text_x, @text_y, z_index, 1, 1, text_color
 				end
 			end
 		end
@@ -590,32 +592,34 @@ module AGL
 		# Parameters:
 		# [alpha] The opacity with which the text field will be drawn. Allowed
 		#         values vary between 0 (fully transparent) and 255 (fully opaque).
-		def draw alpha = 0xff
+		# [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 draw alpha = 0xff, z_index = 0
 			return unless @visible
 			
 			color = (alpha << 24) | ((@enabled or @disabled_img) ? 0xffffff : 0x808080)
 			text_color = (alpha << 24) | (@enabled ? @text_color : @disabled_text_color)
 			img = ((@enabled or @disabled_img.nil?) ? @img : @disabled_img)
-			img.draw @x, @y, 0, 1, 1, color
-			@font.draw @text, @text_x, @text_y, 0, 1, 1, text_color
+			img.draw @x, @y, z_index, 1, 1, color
+			@font.draw @text, @text_x, @text_y, z_index, 1, 1, text_color
 			
 			if @anchor1 and @anchor2
 				selection_color = ((alpha / 2) << 24) | @selection_color
 				Game.window.draw_quad @nodes[@anchor1], @text_y, selection_color,
 				                      @nodes[@anchor2] + 1, @text_y, selection_color,
 				                      @nodes[@anchor2] + 1, @text_y + @font.height, selection_color,
-				                      @nodes[@anchor1], @text_y + @font.height, selection_color, 0
+				                      @nodes[@anchor1], @text_y + @font.height, selection_color, z_index
 			end
 			
 			if @cursor_visible
 				if @cursor_img
-					@cursor_img.draw @nodes[@cur_node] - @cursor_img.width / 2, @text_y, 0
+					@cursor_img.draw @nodes[@cur_node] - @cursor_img.width / 2, @text_y, z_index
 				else
 					cursor_color = alpha << 24
 					Game.window.draw_quad @nodes[@cur_node], @text_y, cursor_color,
 					                      @nodes[@cur_node] + 1, @text_y, cursor_color,
 					                      @nodes[@cur_node] + 1, @text_y + @font.height, cursor_color,
-					                      @nodes[@cur_node], @text_y + @font.height, cursor_color, 0
+					                      @nodes[@cur_node], @text_y + @font.height, cursor_color, z_index
 				end
 			end
 		end

data/lib/minigl/game_object.rb

@@ -83,18 +83,20 @@ module AGL
 		#         will be darkened, for example.
 		# [angle] A rotation, in degrees, to be applied to the image, relative to
 		#         its center.
-		def draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil
+		# [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 draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil, z_index = 0
 			color = (alpha << 24) | color
 			if map
 				if angle
-					@img[@img_index].draw_rot @x.round - map.cam.x, @y.round - map.cam.y, 0, angle, 0.5, 0.5, scale_x, scale_y, color
+					@img[@img_index].draw_rot @x.round - map.cam.x, @y.round - map.cam.y, z_index, angle, 0.5, 0.5, scale_x, scale_y, color
 				else
-					@img[@img_index].draw @x.round - map.cam.x, @y.round - map.cam.y, 0, scale_x, scale_y, color
+					@img[@img_index].draw @x.round - map.cam.x, @y.round - map.cam.y, z_index, scale_x, scale_y, color
 				end
 			elsif angle
-				@img[@img_index].draw_rot @x.round, @y.round, 0, angle, 0.5, 0.5, scale_x, scale_y, color
+				@img[@img_index].draw_rot @x.round, @y.round, z_index, angle, 0.5, 0.5, scale_x, scale_y, color
 			else
-				@img[@img_index].draw @x.round, @y.round, 0, scale_x, scale_y, color
+				@img[@img_index].draw @x.round, @y.round, z_index, scale_x, scale_y, color
 			end
 		end
 	end
@@ -124,7 +126,9 @@ module AGL
 		#               image is not a spritesheet.
 		# [sprite_rows] The number of rows in the spritesheet. Use +nil+ if the
 		#               image is not a spritesheet.
-		def initialize x, y, w, h, img, img_gap = nil, sprite_cols = nil, sprite_rows = nil
+		# [mass] The mass of the object. Details on how it is used can be found
+		#        in the Movement module.
+		def initialize x, y, w, h, img, img_gap = nil, sprite_cols = nil, sprite_rows = nil, mass = 1.0
 			super x, y, img, sprite_cols, sprite_rows
 			@w = w; @h = h
 			@img_gap =
@@ -133,6 +137,7 @@ module AGL
 				else
 					img_gap
 				end
+			@mass = mass
 			@speed = Vector.new 0, 0
 			@min_speed = Vector.new 0.01, 0.01
 			@max_speed = Vector.new 15, 15
@@ -172,20 +177,22 @@ module AGL
 		#         will be darkened, for example.
 		# [angle] A rotation, in degrees, to be applied to the image, relative to
 		#         its center.
-		def draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil
+		# [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 draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil, z_index = 0
 			color = (alpha << 24) | color
 			if map
 				if angle
 					@img[@img_index].draw_rot @x.round + @img_gap.x - map.cam.x,
 					                          @y.round + @img_gap.y - map.cam.y,
-					                          0, angle, 0.5, 0.5, scale_x, scale_y, color
+					                          z_index, angle, 0.5, 0.5, scale_x, scale_y, color
 				else
-					@img[@img_index].draw @x.round + @img_gap.x - map.cam.x, @y.round + @img_gap.y - map.cam.y, 0, scale_x, scale_y, color
+					@img[@img_index].draw @x.round + @img_gap.x - map.cam.x, @y.round + @img_gap.y - map.cam.y, z_index, scale_x, scale_y, color
 				end
 			elsif angle
-				@img[@img_index].draw_rot @x.round + @img_gap.x, @y.round + @img_gap.y, 0, angle, 0.5, 0.5, scale_x, scale_y, color
+				@img[@img_index].draw_rot @x.round + @img_gap.x, @y.round + @img_gap.y, z_index, angle, 0.5, 0.5, scale_x, scale_y, color
 			else
-				@img[@img_index].draw @x.round + @img_gap.x, @y.round + @img_gap.y, 0, scale_x, scale_y, color
+				@img[@img_index].draw @x.round + @img_gap.x, @y.round + @img_gap.y, z_index, scale_x, scale_y, color
 			end
 		end
 	end
@@ -245,7 +252,7 @@ module AGL
 			end
 		end
 		
-		def draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil
+		def draw map = nil, scale_x = 1, scale_y = 1, alpha = 0xff, color = 0xffffff, angle = nil, z_index = 0
 			super unless @dead
 		end
 	end

data/lib/minigl/movement.rb

@@ -48,6 +48,24 @@ module AGL
 	# the y axis. You must provide instances of this class (or derived classes)
 	# to the +ramps+ array parameter of the +move+ method.
 	class Ramp
+		# The x-coordinate of the top left corner of a rectangle that completely
+		# (and precisely) encloses the ramp (thought of as a right triangle).
+		attr_reader :x
+		
+		# The y-coordinate of the top left corner of the rectangle described in
+		# the +x+ attribute.
+		attr_reader :y
+		
+		# The width of the ramp.
+		attr_reader :w
+		
+		# The height of the ramp.
+		attr_reader :h
+		
+		# Whether the height of the ramp increases from left to right (decreases
+		# from left to right when +false+).
+		attr_reader :left
+		
 		# Creates a new ramp.
 		# 
 		# Parameters:
@@ -133,6 +151,12 @@ module AGL
 	# rectangular bounding boxes), including a method to behave as an elevator,
 	# affecting other objects' positions as it moves.
 	module Movement
+		# The mass of the object, in arbitrary units. The default value for
+		# GameObject instances, for example, is 1. The larger the mass (i.e., the
+		# heavier the object), the more intense the forces applied to the object
+		# have to be in order to move it.
+		attr_reader :mass
+		
 		# A Vector with the current speed of the object (x: horizontal component,
 		# y: vertical component).
 		attr_reader :speed
@@ -193,12 +217,12 @@ module AGL
 			forces.x += Game.gravity.x; forces.y += Game.gravity.y
 			forces.x += @stored_forces.x; forces.y += @stored_forces.y
 			@stored_forces.x = @stored_forces.y = 0
-		
+			
 			# check_contact obst, ramps
 			forces.x = 0 if (forces.x < 0 and @left) or (forces.x > 0 and @right)
 			forces.y = 0 if (forces.y < 0 and @top) or (forces.y > 0 and @bottom)
-		
-			@speed.x += forces.x; @speed.y += forces.y
+			
+			@speed.x += forces.x / @mass; @speed.y += forces.y / @mass
 			@speed.x = 0 if @speed.x.abs < @min_speed.x
 			@speed.y = 0 if @speed.y.abs < @min_speed.y
 			@speed.x = (@speed.x <=> 0) * @max_speed.x if @speed.x.abs > @max_speed.x

data/lib/minigl/text.rb

@@ -29,7 +29,9 @@ module AGL
 		# [color] The color of the text, in hexadecimal RRGGBB format.
 		# [alpha] The opacity of the text. Valid values vary from 0 (fully
 		#         transparent) to 255 (fully opaque).
-		def write_line text, x, y, mode = :left, color = 0, alpha = 0xff
+		# [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_line text, x, y, mode = :left, color = 0, alpha = 0xff, z_index = 0
 			color = (alpha << 24) | color
 			rel =
 				case mode
@@ -38,7 +40,7 @@ module AGL
 				when :right then 1
 				else 0
 				end
-			@font.draw_rel text, x, y, 0, rel, 0, 1, 1, color
+			@font.draw_rel text, x, y, z_index, rel, 0, 1, 1, color
 		end
 		
 		# Draws text, breaking lines when needed and when explicitly caused by the
@@ -58,11 +60,13 @@ module AGL
 		# [color] The color of the text, in hexadecimal RRGGBB format.
 		# [alpha] The opacity of the text. Valid values vary from 0 (fully
 		#         transparent) to 255 (fully opaque).
-		def write_breaking text, x, y, width, mode = :left, color = 0, alpha = 0xff
+		# [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
 			color = (alpha << 24) | color
 			text.split("\n").each do |p|
 				if mode == :justified
-					y = write_paragraph_justified p, x, y, width, color
+					y = write_paragraph_justified p, x, y, width, color, z_index
 				else
 					rel =
 						case mode
@@ -71,20 +75,20 @@ module AGL
 						when :right then 1
 						else 0
 						end
-					y = write_paragraph p, x, y, width, rel, color
+					y = write_paragraph p, x, y, width, rel, color, z_index
 				end
 			end
 		end
 	
 	private
 		
-		def write_paragraph text, x, y, width, rel, color
+		def write_paragraph text, x, y, width, rel, color, z_index
 			line = ""
 			line_width = 0
 			text.split(' ').each do |word|
 				w = @font.text_width word
 				if line_width + w > width
-					@font.draw_rel line.chop, x, y, 0, rel, 0, 1, 1, color
+					@font.draw_rel line.chop, x, y, z_index, rel, 0, 1, 1, color
 					line = ""
 					line_width = 0
 					y += @font.height + @line_spacing
@@ -92,11 +96,11 @@ module AGL
 				line += "#{word} "
 				line_width += @font.text_width "#{word} "
 			end
-			@font.draw_rel line.chop, x, y, 0, rel, 0, 1, 1, color if not line.empty?
+			@font.draw_rel line.chop, x, y, z_index, rel, 0, 1, 1, color if not line.empty?
 			y + @font.height + @line_spacing
 		end
 	
-		def write_paragraph_justified text, x, y, width, color
+		def write_paragraph_justified text, x, y, width, color, z_index
 			space_width = @font.text_width " "
 			spaces = [[]]
 			line_index = 0
@@ -127,7 +131,7 @@ module AGL
 			spaces.each do |line|
 				new_x = x
 				line.each do |s|
-					@font.draw words[index], new_x, y, 0, 1, 1, color
+					@font.draw words[index], new_x, y, z_index, 1, 1, color
 					new_x += @font.text_width(words[index]) + s
 					index += 1
 				end

data/test/game.rb

@@ -13,7 +13,7 @@ class MyGame < Gosu::Window
     @writer = TextHelper.new @font, 5
     @btn = Button.new(10, 560, @font, "Test", :btn, 0x008000, 0x808080, 0, 0, 0, 0, 0, "friends") { |x| puts "hello #{x}" }
     @btn.enabled = false
-    @chk = ToggleButton.new(210, 560, @font, "Click me", :check, false, 0xffffff, 0x808080, false, 36, 5, 0, 0, "friends") { |c, x|
+    @chk = ToggleButton.new(740, 300, @font, "Click me", :check, false, 0xffffff, 0x808080, false, 36, 5, 0, 0, "friends") { |c, x|
              puts "hello #{x}, checked: #{c}"
            }
     @txt = TextField.new(10, 520, @font, :text, nil, nil, 15, 5, 16, false, "", nil, 0, 0, 0x0000ff, "test") { |t, x| puts "field #{x}, text: #{t}" }
@@ -49,12 +49,12 @@ class MyGame < Gosu::Window
   end
 
   def draw
-    @obj1.draw nil, 1, 1, 0x80, 0x33ff33, 30
+    @obj1.draw nil, 1, 1, 255, 0x33ff33, 30, 1
     @obj2.draw nil, 0.6, 1.4, 0x99
     @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, 0xffffffff
+                           780, 300, 300, :right, 0xff0000, 255, 1
     
     @btn.draw 0xcc
     @chk.draw

data/test/movement_tests.rb

@@ -6,6 +6,7 @@ class MovingObject
 	include Movement
 	def initialize x, y, w, h
 		@x = x; @y = y; @w = w; @h = h
+		@mass = 1.0
 		@speed = Vector.new 0, 0
 		@min_speed = Vector.new 0.01, 0.01
 		@max_speed = Vector.new 1000, 1000

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu