ray 0.1.1 → 0.2.0

data/lib/ray/helper.rb

@@ -143,6 +143,11 @@ module Ray
       Ray::Text.new(content, opts)
     end
 
+    # (see Ray::Effect::Generator#initialize)
+    def effect_generator(version = 110, &block)
+      Ray::Effect::Generator.new(version, &block)
+    end
+
     # @param [Symbol, Key, Integer] val A symbol to find the key (its name),
     #   a Key object, or one of the KEY_* constant.
     # @return [true, false] True if the user is holding key.

data/lib/ray/image.rb

@@ -1,19 +1,20 @@
 module Ray
   class Image
     include Enumerable
-
-    def inspect
-      "#<#{self.class} size=#{size}>"
-    end
-
-    alias :w :width
-    alias :h :height
+    include Ray::PP
 
     extend Ray::ResourceSet
     add_set(/^(.*)$/) { |filename| new(filename) }
 
+    # @group Iterating over an image
+
+    # Iterates over all the pixels of an image
+    #
+    # Iteration is done over each pixel from a line from left to right,
+    # and each line from top to bottom.
+    #
     # @yield [pixel]
-    # @yieldparam [Ray::Color] pixel Color of a point
+    # @yieldparam [Ray::Color] pixel Color of the pixel
     def each
       return Enumerator.new(self, :each) unless block_given?
 
@@ -26,8 +27,12 @@ module Ray
       self
     end
 
-    # Same as each, but also yields the position of each point.
+    # Yields all the pixels and their positions
+    #
     # @yield [pixel, x, y]
+    # @yieldparam [Ray::Color] pixel Color of the pixel
+    # @yieldparam [Integer] x X position of the pixel
+    # @yieldparam [Integer] y Y position of the pixel
     def each_with_pos
       return Enumerator.new(self, :each_with_pos) unless block_given?
 
@@ -40,7 +45,12 @@ module Ray
       self
     end
 
-    # @yield [pixel] Block returning the new color of this pixel.
+    # Modifies each pixel of the image in-place
+    #
+    # @yield [pixel]
+    # @yieldparam (see #each)
+    #
+    # @yieldreturn [Ray::Color] New color of the pixel
     def map!
       return Enumerator.new(self, :map!) unless block_given?
 
@@ -53,7 +63,13 @@ module Ray
       self
     end
 
-    # @yield [pixel, x, y] Block returning the new color of this pixel
+    # Modifies each pixel of the image in-place, passing their position to the
+    # block
+    #
+    # @yield [pixel, x, y]
+    # @yieldparam (see #each_with_pos)
+    #
+    # @yieldreturn (see #mapV)
     def map_with_pos!
       return Enumerator.new(self, :map_with_pos!) unless block_given?
 
@@ -66,14 +82,39 @@ module Ray
       self
     end
 
-    # @return [Ray::Image] New image created according to a block.
+    # Creates a new image using a block
+    #
+    # @yield [pixel]
+    # @yieldparam (see #map!)
+    # @yieldreturn (see #map!)
+    #
+    # @return [Ray::Image] New image created according to a block
     def map(&block)
       dup.map!(&block)
     end
 
-    # @return [Ray::Image] New image created according to a block.
+    # Creates a new image using a block, passing the position of each point
+    # to it
+    #
+    # @yield [pixel, x, y]
+    # @yieldparam (see #map_with_pos!)
+    #
+    # @return (see #map)
     def map_with_pos(&block)
       dup.map_with_pos!(&block)
     end
+
+    # @endgroup
+
+    def inspect
+      "#<#{self.class} size=#{size}>"
+    end
+
+    def pretty_print(q)
+      pretty_print_attributes q, ["size", "smooth?"]
+    end
+
+    alias w width
+    alias h height
   end
 end

data/lib/ray/image_target.rb

@@ -1,5 +1,8 @@
 module Ray
   class ImageTarget < Target
+    # @yield [target] Yields itself if a block is given
+    # @yieldparam [Ray::ImageTarget] target The new target
+    #
     # @param [Ray::Image, nil] image The image to use
     def initialize(image = nil)
       self.image = image if image
@@ -8,5 +11,9 @@ module Ray
         yield self
       end
     end
+
+    def pretty_print(q)
+      super q, ["image"]
+    end
   end
 end

data/lib/ray/matrix.rb

@@ -86,5 +86,31 @@ module Ray
     def to_s
       "#<#{self.class} #{content.join(', ')}>"
     end
+
+    def pretty_print(q)
+      content = self.content.map { |n| ("%g" % n).to_f }
+
+      columns = Array.new(4) do |x|
+        Array.new(4) { |y| ("%g" % self[x, y]).to_f }
+      end
+
+      column_length = columns.map { |c| c.map { |n| n.to_s.length }.max }
+
+      q.group(2, '{', '}') do
+        q.breakable ''
+        content.each_slice(4).with_index do |(x, y, z, w), i|
+          q.text '('
+          q.pp x
+          q.text ', ' + ' ' * (column_length[0] - x.to_s.length)
+          q.pp y
+          q.text ', ' + ' ' * (column_length[1] - y.to_s.length)
+          q.pp z
+          q.text ', ' + ' ' * (column_length[2] - z.to_s.length)
+          q.pp w
+          q.text ')'
+          q.breakable '' unless i == 3
+        end
+      end
+    end
   end
 end

data/lib/ray/music.rb

@@ -4,6 +4,10 @@ module Ray
       open(filename) if filename
     end
 
+    def pretty_print(q)
+      super q, ["time", "duration", "looping?"]
+    end
+
     alias time= seek
 
     alias position  pos

data/lib/ray/pixel_bus.rb

@@ -0,0 +1,22 @@
+module Ray
+  class PixelBus
+    # @group Copying data
+
+    # Duplicates an image through this bus
+    #
+    # @param [Ray::Image] image Image to be copied
+    # @param [Integer] offset Offset to write the pixels to
+    #
+    # @return [Ray::Image] Copied image
+    def copy(image, offset = 0)
+      copy = Ray::Image.new image.size
+
+      pull image, :offset => offset
+      push copy,  :offset => offset
+
+      copy
+    end
+
+    # @endgroup
+  end
+end

data/lib/ray/polygon.rb

@@ -4,6 +4,8 @@ module Ray
 
     # One of the points contained in a polygon.
     class Point
+      include Ray::PP
+
       def initialize(polygon, id)
         @polygon, @id = polygon, id
       end
@@ -43,6 +45,10 @@ module Ray
 outline=#{outline}>"
       end
 
+      def pretty_print(q)
+        pretty_print_attributes q, ["pos", "color", "outline"]
+      end
+
       attr_reader :polygon, :id
     end
 
@@ -68,10 +74,21 @@ outline=#{outline}>"
       0.upto(size - 1) { |n| yield self[n] }
     end
 
+    alias points to_a
+
     # @return [Ray::Polygon::Point] idth point of the polygon (id should be less
     #   than size)
     def [](id)
       Point.new(self, id)
     end
+
+    def pretty_print(q, other_attr = [])
+      attr = [
+              "filled?", "outlined?", "outline_width",
+              "points"
+             ]
+
+      super q, attr + other_attr
+    end
   end
 end

data/lib/ray/pp.rb

@@ -0,0 +1,28 @@
+module Ray
+  # Module containing helpers to implement pretty print
+  module PP
+    # @param [PrettyPrint] q Object used for pretty printing
+    # @param [Array<String>] attributes Methods to call and to print the result
+    #   of
+    def pretty_print_attributes(q, attributes)
+      id = "%x" % (__id__ * 2)
+      id.sub!(/\Af(?=[[:xdigit:]]{2}+\z)/, '') if id.sub!(/\A\.\./, '')
+
+      klass = self.class.pretty_inspect.chomp
+
+      q.group(2, "\#<#{klass}:0x#{id}", '>') do
+        q.seplist(attributes, lambda { q.text ',' }) do |key|
+          q.breakable
+
+          q.text key.to_s
+          q.text '='
+
+          q.group(2) do
+            q.breakable ''
+            q.pp send(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ray/ray.rb

@@ -4,7 +4,7 @@ require 'iconv'
 # Change PATH so as to find DLLs on windows.
 if RUBY_PLATFORM =~ /mingw/
   ext_dir = File.expand_path("../../ext", File.dirname(__FILE__))
-  ENV["PATH"] = ENV["PATH"] + File::PATH_SEPARATOR + ext_dir
+  ENV["PATH"] = ext_dir + File::PATH_SEPARATOR + ENV["PATH"]
 end
 
 require 'ray_ext'
@@ -17,6 +17,8 @@ module Ray
   InternalEncoding = BigEndian ? "UTF-32BE" : "UTF-32LE"
 end
 
+require 'ray/pp'
+
 require 'ray/resource_set'
 
 require 'ray/vector'
@@ -28,6 +30,7 @@ require 'ray/vertex'
 require 'ray/gl/vertex'
 require 'ray/gl/int_array'
 require 'ray/buffer_renderer'
+require 'ray/pixel_bus'
 require 'ray/shader'
 
 require 'ray/image'
@@ -47,6 +50,7 @@ require 'ray/text'
 require 'ray/turtle'
 
 require 'ray/audio'
+require 'ray/audio_source'
 require 'ray/sound_buffer'
 require 'ray/sound'
 require 'ray/music'
@@ -61,6 +65,8 @@ require 'ray/helper'
 require 'ray/animation'
 require 'ray/animation_list'
 
+require 'ray/effect'
+
 require 'ray/scene_list'
 require 'ray/scene'
 

data/lib/ray/rect.rb

@@ -21,16 +21,17 @@ module Ray
 
     # @return [true, false] True if the receiver is outside the rect.
     def outside?(rect)
-      rect = rect.to_rect
-      !rect.contain?(top_left) &&
-        !rect.contain?(bottom_left) &&
-        !rect.contain?(top_right) &&
-        !rect.contain?(bottom_right)
+      !collide?(rect)
     end
 
     # @return [true, false] True if the receiver collides with the rect.
     def collide?(rect)
-      !outside?(rect)
+      rect = rect.to_rect
+
+      rect.x < x + width &&
+        x < rect.x + rect.width &&
+        rect.y < y + height &&
+        y < rect.y + rect.height
     end
 
     # @return [true, false] True if the receiver contians this point
@@ -107,10 +108,3 @@ class Array
     Ray::Rect.new(*self)
   end
 end
-
-class Hash
-  # @return [Ray::Rect] Converts a hash into a rect.
-  def to_rect
-    Ray::Rect.new(self)
-  end
-end

data/lib/ray/scene.rb

@@ -111,7 +111,7 @@ module Ray
 
     def register_events
       if @scene_register_block
-        instance_exec(@scene_arguments,  &@scene_register_block)
+        instance_exec(*@scene_arguments,  &@scene_register_block)
       else
         register
       end
@@ -155,10 +155,12 @@ module Ray
     def run_tick(check_events = true)
       collect_events if check_events
 
+      @scene_animations.update
       @scene_always_block.call if @scene_always_block
+
       listener_runner.run
 
-      @scene_animations.update
+      @scene_animations.remove_unused
 
       @scene_window.clear Ray::Color.none
       render @scene_window
@@ -202,6 +204,16 @@ module Ray
       game.pop_scene
     end
 
+    # (see Ray::Game#pop_scene_while)
+    def pop_scene_while(&block)
+      game.pop_scene_while(&block)
+    end
+
+    # (see Ray::Game#pop_scene_until)
+    def pop_scene_until(&block)
+      game.pop_scene_until(&block)
+    end
+
     # Registers a block to be excuted as often as possible.
     def always(&block)
       @scene_always_block = block
@@ -237,11 +249,18 @@ module Ray
       end
     end
 
-    def inspect
-      "#<#{self.class} game=#{self.game.inspect}>"
+    alias :pop_scene :exit!
+
+    # Sets the name of the scene
+    # @param [String] val New name of the scene
+    def name=(val)
+      @scene_name = val
     end
 
-    alias :pop_scene :exit!
+    # @see name=
+    def name
+      @scene_name
+    end
 
     def game
       @scene_game

data/lib/ray/scene_list.rb

@@ -3,6 +3,7 @@ module Ray
   # It needs a game object to find a scene from its name.
   class SceneList
     include Enumerable
+    include Ray::PP
 
     # @param [Ray::Game] game The game which will be used to find scenes.
     def initialize(game)
@@ -67,8 +68,16 @@ module Ray
       @scenes.each(&block)
     end
 
+    # @return [Array<Ray::Scene>]
+    attr_reader :scenes
+    alias to_a scenes
+
     def inspect
       "#{self.class}#{@scenes.inspect}"
     end
+
+    def pretty_print(q)
+      pretty_print_attributes q, ["scenes"]
+    end
   end
 end

data/lib/ray/shader.rb

@@ -42,8 +42,11 @@ module Ray
       self
     end
 
-    # @param [String, Symbol] attr Name of the parameter to set
-    # @param
+    # @param [String, Symbol] attr Name of the parameter to set. Can be a
+    #   variable name or a way to identify an element from a struct or an array
+    #   (e.g. array[3] or some_struct.field).
+    #
+    # @param [Object] value Value to set it to.
     def []=(attr, value)
       attr = attr.to_sym
       @locations[attr] ||= locate(attr)
@@ -78,5 +81,11 @@ module Ray
         set_numeric loc, value
       end
     end
+
+    # @param [Hash] attr Hash containing the parameter names as keys and the
+    #   values to set them to.
+    def merge(hash)
+      hash.each { |key, val| self[key] = val }
+    end
   end
 end