minigl 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d35ec0ab57189caa5cc2edd7e61764845968db0e
-  data.tar.gz: 8d065a06a3a5bdac7a2a67ca316eefd114350971
+  metadata.gz: 334e4fb063765088eb6bc85cb3d67b68d28b1867
+  data.tar.gz: ce24cfb378fe102dd475e32ff636b542b9b9f841
 SHA512:
-  metadata.gz: a0f06503c0348c89094a8717e5075d969dc3dc4ed7b20ba052a731e1115c3d137ce8ebbfac982560b4d60353c68a03fa98fce53d6418ee1c12e92e0be20223dd
-  data.tar.gz: 88dc0365857bf9162587db91fd85181d37a51d072eac998457e5f7ef1094b6952f2fdf9a310055425b2d1cf92439b687cac240155967fac93f949b66e6fb9185
+  metadata.gz: d9d84abe68d022276574fc48baeea9c41a1188b1bc9b359dd88716384f0b9760c8ee28f0f1e7f9a911cfc25983c2d07d234bbfee63b9079987b7e442ce2ef8b4
+  data.tar.gz: 30392926054fc4e1567647dcc72f14c2479ad48bbbd66b2285b5424258b0eed0b73983f4b956eb99a62b4ea61064cc41f1f2dbb15c5230878982ee9e6400b29e

data/README.md

@@ -32,6 +32,8 @@ 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.6**
+**Version 1.3.7**
 
-  * Changed license to MIT.
+  * Minor adjustment and exposure of `prefix` attribute of `Res`.
+  * Removed debug message that was being output when starting the game.
+  * Improved the `Vector` class with operations, comparisons, etc.

data/lib/minigl/global.rb

@@ -2,9 +2,88 @@ require 'gosu'
 
 # The main module of the library, used only as a namespace.
 module AGL
-	# A Struct with two attributes, x and y (in this order), representing a point
-	# in a bidimensional space.
-	Vector = Struct.new :x, :y
+	# This class represents a point or vector in a bidimensional space.
+	class Vector
+    # The x coordinate of the vector
+    attr_accessor :x
+
+    # The y coordinate of the vector
+    attr_accessor :y
+
+    # Creates a new bidimensional vector.
+    #
+    # Parameters:
+    # [x] The x coordinate of the vector
+    # [y] The y coordinate of the vector
+    def initialize x, y
+      @x = x
+      @y = y
+    end
+
+    # Returns +true+ if both coordinates of this vector are equal to the
+    # corresponding coordinates of +other_vector+, with +precision+ decimal
+    # places of precision.
+    def == other_vector, precision = 6
+      @x.round(precision) == other_vector.x.round(precision) and
+          @y.round(precision) == other_vector.y.round(precision)
+    end
+
+    # Returns +true+ if at least one coordinate of this vector is different from
+    # the corresponding coordinate of +other_vector+, with +precision+ decimal
+    # places of precision.
+    def != other_vector, precision = 6
+      @x.round(precision) != other_vector.x.round(precision) or
+          @y.round(precision) != other_vector.y.round(precision)
+    end
+
+    # Sums this vector with +other_vector+, i.e., sums each coordinate of this
+    # vector with the corresponding coordinate of +other_vector+.
+    def + other_vector
+      Vector.new @x + other_vector.x, @y + other_vector.y
+    end
+
+    # Subtracts +other_vector+ from this vector, i.e., subtracts from each
+    # coordinate of this vector the corresponding coordinate of +other_vector+.
+    def - other_vector
+      Vector.new @x - other_vector.x, @y - other_vector.y
+    end
+
+    # Multiplies this vector by a scalar, i.e., each coordinate is multiplied by
+    # the given number.
+    def * scalar
+      Vector.new @x * scalar, @y * scalar
+    end
+
+    # Divides this vector by a scalar, i.e., each coordinate is divided by the
+    # given number.
+    def / scalar
+      Vector.new @x / scalar.to_f, @y / scalar.to_f
+    end
+
+    # Returns the euclidean distance between this vector and +other_vector+.
+    def distance other_vector
+      dx = @x - other_vector.x
+      dy = @y - other_vector.y
+      Math.sqrt(dx ** 2 + dy ** 2)
+    end
+
+    # Returns a vector corresponding to the rotation of this vector around the
+    # origin (0, 0) by +radians+ radians.
+    def rotate radians
+      sin = Math.sin radians
+      cos = Math.cos radians
+      Vector.new cos * @x - sin * @y, sin * @x + cos * @y
+    end
+
+    # Rotates this vector by +radians+ radians around the origin (0, 0).
+    def rotate! radians
+      sin = Math.sin radians
+      cos = Math.cos radians
+      prev_x = @x
+      @x = cos * @x - sin * @y
+      @y = sin * prev_x + cos * @y
+    end
+  end
 
 	# This class represents a rectangle by its x and y coordinates and width and
 	# height.
@@ -328,12 +407,16 @@ module AGL
 			@@global_songs = Hash.new
 			@@fonts = Hash.new
 			@@global_fonts = Hash.new
-			@@prefix = File.expand_path(File.dirname($0)) + '/'
-			puts @@prefix
+			@@prefix = File.expand_path(File.dirname($0)) + '/data/'
     end
 
+    # Get the current prefix for searching data files. This is the directory
+    # under which 'img', 'sound', 'song', etc. folders are located.
+    def self.prefix; @@prefix; end
+
     # Set a custom prefix for loading resources. By default, the prefix is the
-    # directory of the game script.
+    # directory of the game script. The prefix is the directory under which
+    # 'img', 'sound', 'song', etc. folders are located.
     def self.prefix= value
       value += '/' if value[-1] != '/'
       @@prefix = value
@@ -359,7 +442,7 @@ module AGL
 		def self.img id, global = false, tileable = false, ext = ".png"
 			if global; a = @@global_imgs; else; a = @@imgs; end
 			return a[id] if a[id]
-			s = @@prefix + "data/img/" + id.to_s.split('_').join('/') + ext
+			s = @@prefix + "img/" + id.to_s.split('_').join('/') + ext
 			img = Gosu::Image.new Game.window, s, tileable
 			a[id] = img
 		end
@@ -382,7 +465,7 @@ module AGL
 		def self.imgs id, sprite_cols, sprite_rows, global = false, ext = ".png"
 			if global; a = @@global_imgs; else; a = @@imgs; end
 			return a[id] if a[id]
-			s = @@prefix + "data/img/" + id.to_s.split('_').join('/') + ext
+			s = @@prefix + "img/" + id.to_s.split('_').join('/') + ext
 			imgs = Gosu::Image.load_tiles Game.window, s, -sprite_cols, -sprite_rows, false
 			a[id] = imgs
 		end
@@ -406,7 +489,7 @@ module AGL
 		def self.tileset id, tile_width = 32, tile_height = 32, global = false, ext = ".png"
 			if global; a = @@global_tilesets; else; a = @@tilesets; end
 			return a[id] if a[id]
-			s = @@prefix + "data/tileset/" + id.to_s.split('_').join('/') + ext
+			s = @@prefix + "tileset/" + id.to_s.split('_').join('/') + ext
 			tileset = Gosu::Image.load_tiles Game.window, s, tile_width, tile_height, true
 			a[id] = tileset
 		end
@@ -426,7 +509,7 @@ module AGL
 		def self.sound id, global = false, ext = ".wav"
 			if global; a = @@global_sounds; else; a = @@sounds; end
 			return a[id] if a[id]
-			s = @@prefix + "data/sound/" + id.to_s.split('_').join('/') + ext
+			s = @@prefix + "sound/" + id.to_s.split('_').join('/') + ext
 			sound = Gosu::Sample.new Game.window, s
 			a[id] = sound
 		end
@@ -446,7 +529,7 @@ module AGL
 		def self.song id, global = false, ext = ".ogg"
 			if global; a = @@global_songs; else; a = @@songs; end
 			return a[id] if a[id]
-			s = @@prefix + "data/song/" + id.to_s.split('_').join('/') + ext
+			s = @@prefix + "song/" + id.to_s.split('_').join('/') + ext
 			song = Gosu::Song.new Game.window, s
 			a[id] = song
 		end
@@ -470,7 +553,7 @@ module AGL
 			if global; a = @@global_fonts; else; a = @@fonts; end
 			id_size = "#{id}_#{size}"
 			return a[id_size] if a[id_size]
-			s = @@prefix + "data/font/" + id.to_s.split('_').join('/') + ext
+			s = @@prefix + "font/" + id.to_s.split('_').join('/') + ext
 			font = Gosu::Font.new Game.window, s, size
 			a[id_size] = font
 		end

data/lib/minigl/map.rb

@@ -5,6 +5,11 @@ module AGL
 	# a grid of equally sized tiles. It also provides viewport control, through
 	# its camera property and methods.
 	class Map
+    # :nodoc:
+    Sqrt2Div2 = Math.sqrt(2) / 2
+    # :nodoc:
+    MinusPiDiv4 = -Math::PI / 4
+
 		# A Vector where x is the tile width and y is the tile height.
 		attr_reader :tile_size
 
@@ -145,8 +150,6 @@ module AGL
 		end
 
 	private
-    Sqrt2Div2 = Math.sqrt(2) / 2
-    MinusPiDiv4 = -Math::PI / 4
 
 		def set_bounds
 			if @isometric
@@ -242,20 +245,14 @@ module AGL
       center.y *= @tile_ratio
 
       # Rotaciona o vetor posição -45°
-      position = rotate position, MinusPiDiv4
+      position.rotate! MinusPiDiv4
 
       # Retorna a referência da posição para o canto da tela
-      position.x += center.x; position.y += center.y
+      position += center
 
       # O mapa quadrado está centralizado no centro do losango, precisa retornar ao canto da tela
       position.x -= @isometric_offset_x; position.y -= @isometric_offset_y
       position
     end
-
-		def rotate v, angle
-			sin = Math.sin angle
-			cos = Math.cos angle
-			Vector.new cos * v.x - sin * v.y, sin * v.x + cos * v.y
-		end
 	end
 end

data/test/game_object_tests.rb

@@ -6,7 +6,7 @@ class SpriteTest < Test::Unit::TestCase
 	def setup
 		@window = Gosu::Window.new 800, 600, false
 		Game.initialize @window
-    Res.prefix = File.expand_path(File.dirname(__FILE__))
+    Res.prefix = File.expand_path(File.dirname(__FILE__)) + '/data'
 	end
 
 	def test_sprite_position
@@ -33,7 +33,7 @@ class GameObjectTest < Test::Unit::TestCase
 	def setup
 		@window = Gosu::Window.new 800, 600, false
 		Game.initialize @window
-    Res.prefix = File.expand_path(File.dirname(__FILE__))
+    Res.prefix = File.expand_path(File.dirname(__FILE__)) + '/data'
 	end
 
 	def test_game_object_attributes

data/test/res_tests.rb

@@ -6,7 +6,7 @@ class ResTest < Test::Unit::TestCase
 	def setup
 		@window = Gosu::Window.new 800, 600, false
 		Game.initialize @window
-    Res.prefix = File.expand_path(File.dirname(__FILE__))
+    Res.prefix = File.expand_path(File.dirname(__FILE__)) + '/data'
 	end
 
 	def test_tileset

data/test/vector_tests.rb

@@ -0,0 +1,56 @@
+require 'test/unit'
+require_relative '../lib/minigl'
+include AGL
+
+class VectorTest < Test::Unit::TestCase
+  def test_vector_comparison
+    v1 = Vector.new 1, 2
+    v2 = v1.clone
+    assert v1 == v2
+    assert !(v1 != v2)
+
+    v1 = Vector.new 1.37, 4.56
+    v2 = Vector.new 1.373, 4.562
+    assert v1.==(v2, 2)
+    assert v1.!=(v2, 3)
+  end
+
+  def test_vector_operations
+    v1 = Vector.new 1, 1
+    v2 = Vector.new 2, 3
+
+    v3 = v1 + v2
+    assert_equal 3, v3.x
+    assert_equal 4, v3.y
+
+    v3 = v1 - v2
+    assert_equal -1, v3.x
+    assert_equal -2, v3.y
+
+    v3 = v2 * 3
+    assert_equal 6, v3.x
+    assert_equal 9, v3.y
+
+    v3 = v2 / 2
+    assert_equal 1, v3.x
+    assert_equal 1.5, v3.y
+
+    v3 = Vector.new 0, Math.sqrt(2)
+    assert v1.rotate(Math::PI / 4) == v3
+
+    v1.rotate! Math::PI / 4
+    assert v1 == v3
+  end
+
+  def test_vector_distance
+    v1 = Vector.new 1, 1
+    v2 = Vector.new 2, 3
+    d = v1.distance v2
+    assert_equal Math.sqrt(5), d
+
+    v1 = Vector.new 0, 3
+    v2 = Vector.new 4, 0
+    d = v1.distance v2
+    assert_equal 5, d
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.3.7
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -59,6 +59,7 @@ files:
 - test/map_tests.rb
 - test/movement_tests.rb
 - test/res_tests.rb
+- test/vector_tests.rb
 homepage: https://github.com/victords/minigl
 licenses:
 - MIT
@@ -84,6 +85,7 @@ signing_key:
 specification_version: 4
 summary: MiniGL
 test_files:
+- test/vector_tests.rb
 - test/movement_tests.rb
 - test/map_tests.rb
 - test/game.rb