rubydraw 0.1.9 → 0.2.0

data/README

@@ -1,24 +1,13 @@
-Rubydraw is a high level game/graphics library, like Gosu or Rubygame, and is written in Ruby.
-Its only dependency is ruby-sdl-ffi, which it uses to access SDL functions. Also, thanks,
-Rubygame, for documenting your code (which, completely by coninsidence, also uses ruby-sdl-ffi),
-otherwise I wouldn't have the slightest idea on how to use the base library's undocumented code!
-You have been very helpful. :)
+Rubydraw is a high level game/graphics library, like Gosu or Rubygame, and is written in Ruby. Its only dependency is ruby-sdl-ffi, which it uses to access SDL functions. Also, thanks, Rubygame, for documenting your code (which apparently also uses ruby-sdl-ffi), otherwise I wouldn't have the slightest idea on how to use the base library's undocumented code! You have been very helpful. :)
 –––––
-NOTE: I can't get +ruby-sdl-ffi+ (the library Rubydraw uses to access SDL) to work with +Ruby
-1.9.2+, so I don't know if it even does. If it does work, and/or you know how to make it work,
-I would appreciate it if you notify me. So basically, I can't test anything with +1.9.2+. Sorry
-for the inconvenience!
+NOTE: I can't get +ruby-sdl-ffi+ (the library Rubydraw uses to access SDL) to work with +Ruby 1.9.2+, so I don't know if it even does. If it does work, and/or you know how to make it work, I would appreciate it if you notify me. So basically, I can't test anything with +1.9.2+. Sorry for the inconvenience!
 
 HOW TO INSTALL
-To install this library without RubyGems, navigate to this directory in the command
-line tool and give "rubydraw/build_and_install" permissions to run. Then simply run it. Hooray, it
-should be working now! Test it in irb with "require 'rubydraw'".
+First of all, Rubydraw of course requires you to install SDL. This is mostly a breeze, and a good guide for all platforms can be found here: https://github.com/rubygame/rubygame/wiki/Install (but you don't need to install Rubygame). Then, to install this library without using RubyGems, navigate to this directory in the command line tool and give "rubydraw/build_and_install" permissions to run. Then simply run it. Hooray, it should be working now! Test it by requiring 'rubydraw' in the irb.
 
 HOW TO USE
-There isn't a proper guide yet, so just read the comments in the other files. Or you can fire up the
-gem server and read the RDoc.
+There isn't a proper guide yet, so just read the comments in the other files. Or you can fire up the gem server and read the RDoc.
 
-Thanks for checking this little project. I hope it doesn't give you headaches.
-Have fun!
+Thanks for checking this little project. I hope it doesn't give you headaches. Have fun!
 
 NEW: Now you can install it from the RubyGems website! Hooray! :D

data/examples/image_ex.rb

@@ -12,6 +12,12 @@ class MyWindow < Rubydraw::Window
     whenever Rubydraw::Events::MouseMove do |event|
       @mouse_position = event.position
     end
+    whenever Rubydraw::Events::FocusGain do
+      @focused = true
+    end
+    whenever Rubydraw::Events::FocusLoss do
+      @focused = false
+    end
   end
 
   def mouse_moved(event)
@@ -20,7 +26,7 @@ class MyWindow < Rubydraw::Window
   end
 
   def tick
-    @image.draw(self, @mouse_position) #if @focused
+    @image.draw(self, @mouse_position) if @focused
   end
 end
 

data/examples/window_ex.rb

@@ -5,10 +5,7 @@ class MyWindow < Rubydraw::Window
   def initialize(width, height)
     super(width, height)
     puts "New window created with width: #{@width} and height #{@height}"
-  end
-  def handle_event(event)
-    case event
-    when Rubydraw::Event::Quit
+    whenever Rubydraw::Events::QuitRequest do
       close
     end
   end
@@ -19,7 +16,4 @@ w = gets.to_i
 print "Window width: "
 h = gets.to_i
 
-window = MyWindow.new(w, h).show
-
-# Wait for a while to let the user enjoy the window
-sleep 10
+window = MyWindow.new(w, h).show

data/lib/ext/aliases.rb

@@ -0,0 +1,4 @@
+# Everything in this file defines constants that "point" to some Rubydraw class.
+# This is why you can write "Point[x, y]" instead of "Rubydraw::Point[x, y]"
+Point = Rubydraw::Point
+Rectangle = Rubydraw::Rectangle

data/lib/ext/object.rb

@@ -0,0 +1,34 @@
+class Object
+    # Execute the given block on the appearance of an instance of +event+ and pass that
+    # instance to the block.
+    #
+    # Example:
+    #    class MyWindow < Rubydraw::Window
+    #      def initialize
+    #        super(300, 300)
+    #        whenever(Rubydraw::Events::QuitRequest) do
+    #          puts "Goodbye!"
+    #          close
+    #        end
+    #        whenever(Rubydraw::Events::MouseMove) do |event|
+    #          new_pos = event.position
+    #          puts "Mouse moved to #{new_pos.x}, #{new_pos.y}.}"
+    #        end
+    #      end
+    #    end
+    def whenever(event, window=self, &block)
+      # A very simple rule: +window+ must be a window. Therefore, since +window+ is self
+      # by default, instances of Rubydraw::Window calling this method don't have to set
+      # that parameter.
+      unless window.is_a?(Rubydraw::Window)
+        raise ArgumentError, "window must be a Rubydraw::Window"
+      end
+      event_block = window.registered_actions[event]
+      # If nobody has registered a block for this event, prepare the way.
+      if event_block.nil?
+        window.registered_actions[event] = []
+      end
+      # Now add the block.
+      window.registered_actions[event] << block
+    end
+end

data/lib/rubydraw/event_queue.rb

@@ -4,12 +4,47 @@ module Rubydraw
   # when a Rubydraw::Window is initialized. Every tick, the window asks its
   # event queue (created in Rubydraw::Window#initialize) for the new events
   class EventQueue
+    def initialize
+      @keys_being_repeated = []
+    end
+    def key_repeat
+      Rubydraw.key_repeat
+    end
     # Get all the new events
     def get_events
+      events = []
+      until ((event = SDL.PollEvent) == nil)
+        new_event = Events.match(event)
+        if new_event.is_a?(Events::KeyReleased)
+          @keys_being_repeated.delete(new_event.key)
+        end
+        if new_event.is_a?(Events::KeyPressed) and not @keys_being_repeated.include?(new_event.key)
+          @keys_being_repeated << new_event.key
+        end
+        events << new_event
+      end
+      @keys_being_repeated.each {|num| events << Events::KeyPressed.new(num)}
+      events
+    end
+
+    def exp_get_events
       events = []
       until((event = SDL::PollEvent()).nil?)
-        events << Events.match(event)
+        new_event = Events.match(event)
+        events << new_event
+        key = new_event.key if new_event.is_a?(Events::KeyboardEvent)
+        if new_event.is_a?(Events::KeyReleased) and @keys_being_repeated.include?(key)
+          @keys_being_repeated.delete(key)
+        end
+        # Synthesize each key that is being held.
+        @keys_being_repeated.each {|num| events << Events::KeyPressed.new(num)}
+        # Start adding keys that are held, and remove keys that are no longer
+        # being held (whenever a Events::KeyReleased is created).
+        if new_event.is_a?(Events::KeyPressed)
+          @keys_being_repeated << key
+        end
       end
+      puts @keys_being_repeated.size
       events
     end
   end

data/lib/rubydraw/image.rb

@@ -19,16 +19,17 @@ module Rubydraw
       end
     end
 
-    # Blit (copy) into the window at +position+ (see point.rb).
+    # Blit (copy) into the window at +position+ (see Rubydraw::Point).
     # No graphical effects are applied.
     #
     # Notice that you don't blit surfaces to other surfaces when using
     # Rubygame, but instead you draw things.
     def draw(window, position)
-      #source_rect = Rectangle[Point[0, 0], width, height]
-      #blit_rect = Rectangle[position, window.width, window.height]
-      source_rect = Rectangle[width, height, Point[0, 0]]
-      blit_rect = Rectangle[window.width, window.height, position]
+      unless position.respond_to?(:x) and position.respond_to?(:y)
+        raise ArgumentError, "Expected a Point, got #{position}"
+      end
+      source_rect = Rectangle[Point[0, 0], Point[width, height]]
+      blit_rect = Rectangle[position, Point[window.width, window.height]]
       SDL::BlitSurface(@sdl_image, source_rect.to_sdl, window.sdl_surface, blit_rect.to_sdl)
       self
     end

data/lib/rubydraw/keys.rb

@@ -17,7 +17,7 @@ module Rubydraw
   #             @x -= 1
   #         end
   #   end
-  module Keys
+  module Key
     UpArrow         = SDL::K_UP
     DownArrow       = SDL::K_DOWN
     RightArrow      = SDL::K_RIGHT

data/lib/rubydraw/point.rb

@@ -13,24 +13,48 @@ module Rubydraw
 
     # Create a new point with the given +x+ and +y+ positions.
     def initialize(x, y)
-      unless x.is_a?(Numeric) and y.is_a?(Numeric)
-        raise RuntimeError "New Point x and y must be a number."
+      unless x.respond_to?(:+)
+        "Expected an integer for x, got #{x}"
+      end
+      unless y.respond_to?(:+)
+        "Expected an integer for y, got #{y}"
       end
       @x, @y = x, y
     end
 
     # Returns if this self falls within the given rectangle.
-    def inside?(min, max)
+    def inside?(rect)
+      min = rect.top_left
+      max = rect.bottom_right
       (x.between?(min.x, max.x)) and (y.between?(min.y, max.y))
     end
 
-    # Add this point's x and y positions to other's x and y positions.
+    # Add this point's x and y positions to +other+'s x and y positions.
     #
     # Example:
-    #   # This produces #<Rubydraw::Point:0x1010f1958 @y=10, @x=60>
-    #   Rubydraw::Point[10, 20] + Rubydraw::Point[50, -10]
+    #   Point[10, 20] + Point[50, -10]
+    #   => #<Rubydraw::Point:0x1010f1958 @y=10, @x=60>
     def +(other)
       Point[self.x + other.x, self.y + other.y]
     end
+
+    # Subtract +other+'s x and y positions from this point's x and y.
+    def -(other)
+      Point[self.x - other.x, self.y - other.y]
+    end
+
+    # Two points are equal if both their x and y positions are the same.
+    def ==(other)
+      result = if other.is_a?(Point)
+        @x == other.x and @y == other.y
+      else
+        false
+      end
+    end
+
+    # Returns a human readable string containing info about this point.
+    def to_s
+      "#{@x}, #{y}"
+    end
   end
 end

data/lib/rubydraw/rectangle.rb

@@ -3,16 +3,24 @@ module Rubydraw
   # falls inside it. One good use for this class would be a button (will be implemented
   # in a future version, probably soon)
   class Rectangle
-    attr_reader(:position, :width, :height)
+    attr_reader(:dimensions, :position)
 
     # Shorthand new method
-    def self.[](width, height, position)
-      self.new(width, height, position)
+    def self.[](position, dimensions)
+      self.new(position, dimensions)
     end
 
     # Create a new rectangle with the given dimensions and position.
-    def initialize(width, height, position)
-      @width, @height, @position = width, height, position
+    def initialize(position, dimensions)
+      #raise ArgumentError, "Rectangle dimensions must be a Point" unless dimensions.is_a?(Rubydraw::Point)
+      #raise ArgumentError, "Rectangle position must be a Point" unless position.is_a?(Rubydraw::Point)
+      unless position.respond_to?(:x) and position.respond_to?(:y)
+        raise ArgumentError, "Expected a Point, got #{position}"
+      end
+      unless dimensions.respond_to?(:x) and dimensions.respond_to?(:y)
+        raise ArgumentError, "Expected a Point, got #{position}"
+      end
+      @position, @dimensions = position, dimensions
     end
 
     # Returns the x position for the rectangle
@@ -28,19 +36,50 @@ module Rubydraw
     # Returns the positon of the top left corner
     alias top_left position
 
+    # Returns a point at the bottom left corner
+    def bottom_left
+      Point[x, y + height]
+    end
+
+    # Returns the point at the top right corner
+    def top_right
+      Point[x + width, y]
+    end
+
     # Returns the position at the bottom right
     def bottom_right
-      Point[x + @width, y + @height]
+      @position + @dimensions
     end
 
     # Returns if the given point is inside this rectangle. See Rubydraw::Point#inside?
     def contains?(point)
-      point.inside?(top_left, bottom_right)
+      point.inside?(self)
     end
 
     # Returns an SDL::Rectangle equal to this one.
     def to_sdl
       SDL::Rect.new([x, y, width, height])
     end
+
+    # Returns this rectangle's width.
+    def width
+      @dimensions.x
+    end
+
+    # Returns this rectangle's height.
+    def height
+      @dimensions.y
+    end
+
+    # Returns all four corners in this Rectangle.
+    def points
+      [top_left, top_right, bottom_left, bottom_right]
+    end
+
+    # Returns a human-readable string, specifying this rectangle.
+    def to_s
+      d = @dimensions
+      ":Rectangle: (position: #{@position.to_s}) (dimensions: #{d.x}x#{d.y}):"
+    end
   end
 end

data/lib/rubydraw/text.rb

@@ -3,11 +3,21 @@ module Rubydraw
   # with the text to display. They can be drawn at a position on the
   # screen.
   class Text
-    attr_accessor(:font, :contents, :size, :color)
+    attr_accessor(:contents, :font, :color, :size)
     # Create a new drawable Text object with the given font and contents.
-    def initialize(font, contents, color = Rubydraw::Color::White, size = 25)
-      @font, @contents, @size, @color = font, contents, size, color
-      @drawable = SDL::TTF.OpenFont(font, size)
+    def initialize(contents, color, font_name="Times New Roman", size = 25)
+      @font, @contents, @size, @color = font_name, contents, size, color
+      if File.exist?(font_name)
+        font_path = font_name
+      else
+        # The font doesn't exist in the program's directory.
+        # Check in Rubydraw's font directory (rubydraw-x.x.x/lib/rubydraw/fonts)
+        font_path = "#{File.dirname(__FILE__)}/../fonts/#{font_name}.ttf"
+      end
+      unless File.exists?(font_path)
+        raise "Font file '#{font_name}' does not exist; attemped to load from '#{font_path}'"
+      end
+      @drawable = SDL::TTF.OpenFont(font_path, size)
       raise(SDLError, "Failed to initialize font: #{SDL.GetError}") if @drawable.pointer.null?
     end
 
@@ -15,8 +25,8 @@ module Rubydraw
     def draw(window, position)
       sdl_color = @color.to_sdl
       sdl_surface = SDL::TTF.RenderText_Blended(@drawable, @contents, sdl_color)
-      source_rect = Rectangle[sdl_surface.w, sdl_surface.h, Point[0, 0]]
-      blit_rect = Rectangle[window.width, window.height, position]
+      source_rect = Rectangle[Point[0, 0], Point[sdl_surface.w, sdl_surface.h]]
+      blit_rect = Rectangle[position, Point[window.width, window.height]]
       SDL::BlitSurface(sdl_surface, source_rect.to_sdl, window.sdl_surface, blit_rect.to_sdl)
     end
   end

data/lib/rubydraw/window.rb

@@ -72,9 +72,14 @@ module Rubydraw
     def handle_events
       events = @event_queue.get_events
 
+      #events.each {|event|
+      #  block = @registered_actions[event.class]
+      #  block.call(event) unless block.nil?}
       events.each {|event|
-        block = @registered_actions[event.class]
-        block.call(event) unless block.nil?}
+        blocks = @registered_actions[event.class]
+        unless blocks.nil?
+          blocks.each {|b| b.call(event) unless b.nil?}
+        end}
     end
 
     # This causes the main loop to exit. Use Rubydraw::Window#close to close the
@@ -102,25 +107,8 @@ module Rubydraw
     def tick
     end
 
-    # Execute the given block on the appearance of an instance of +event+ and pass that
-    # instance to the block.
-    #
-    # Example:
-    #    class MyWindow < Rubydraw::Window
-    #      def initialize
-    #        super(300, 300)
-    #        whenever(Rubydraw::Events::QuitRequest) do
-    #          puts "Goodbye!"
-    #          close
-    #        end
-    #        whenever(Rubydraw::Events::MouseMove) do |event|
-    #          new_pos = event.position
-    #          puts "Mouse moved to #{new_pos.x}, #{new_pos.y}.}"
-    #        end
-    #      end
-    #    end
-    def whenever(event, &block)
-      @registered_actions[event] = block
+    def registered_actions
+      @registered_actions
     end
   end
 end

data/lib/rubydraw.rb

@@ -1,8 +1,9 @@
 # The only dependency
 require 'ruby-sdl-ffi'
 
-# The extention must be loaded first.
+# The extentions must be loaded first, except for +aliases.rb+
 require 'ext/string'
+require 'ext/object'
 
 # Require all the rubydraw files
 files = %w[
@@ -17,7 +18,11 @@ files = %w[
   color
   sdl_error
   rectangle]
-files.each {|f| require("rubydraw/" + f)}
+files.each { |f| require("rubydraw/" + f) }
+
+# This must be loaded last, because it sets up constants that "point" to Rubydraw classes, hence
+# the name "aliases".
+require 'ext/aliases'
 
 # Rubydraw is a high level game/graphics library, like Gosu or Rubygame, and is written completely
 # in Ruby. Its only dependency is ruby-sdl-ffi, which it uses to access SDL functions. Also, thanks,
@@ -30,6 +35,9 @@ files.each {|f| require("rubydraw/" + f)}
 # I would appreciate it if you notify me. So basically, I can't test anything with +1.9.2+. Sorry
 # for the inconvenience!
 module Rubydraw
+  # Basically just an alias to Rubydraw::Rectangle.
+  Rect = Rectangle
+
   # Initialize SDL.
   def self.initialize_sdl
     if SDL::Init(SDL::INIT_EVERYTHING) != 0
@@ -40,6 +48,38 @@ module Rubydraw
       raise SDLError "Failed to initialize SDL TTF: #{SDL.GetError}"
     end
   end
+
+  # Enable/disable key repeating. After this method is called, instances of Rubydraw::Events::KeyPressed
+  # wil be continually created, until the key is released.
+  #
+  # Couldn't get SDL.EnableKeyRepeat to work, so I implemented my own for the time being. This _should_
+  # be temporary, but no guarentees...
+  def self.set_key_repeat(new)
+    unless new.is_a?(TrueClass) or new.is_a?(FalseClass)
+      raise ArgumentError, "'new' must be boolean"
+    end
+    @@key_repeat = new
+  end
+
+  # See Rubydraw.set_key_repeat.
+  def self.enable_key_repeat
+    set_key_repeat(true)
+  end
+
+  # See Rubydraw.set_key_repeat.
+  def self.disable_key_repeat
+    set_key_repeat(false)
+  end
+
+  # Return if +key_repeat+ is enabled or not.
+  def self.key_repeat
+    @@key_repeat
+  end
 end
 
-Rubydraw::initialize_sdl
+Rubydraw.enable_key_repeat
+
+Rubydraw.initialize_sdl
+
+# Make sure to quit SDL systems when the program terminates.
+at_exit {SDL.Quit}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubydraw
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - J. Wostenberg
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-19 00:00:00 -07:00
+date: 2011-11-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,9 +36,10 @@ dependencies:
 description: |-
   
       Rubydraw is a high level drawing/game library,
-      like Gosu or Rubygame. Its only dependency is
-      ruby-sdl-ffi, which it uses to access SDL
-      functions.
+      like Gosu or Rubygame. Its only dependencies are
+      ruby-sdl-ffi--which it uses to access SDL
+      functions--and SDL itself (See README on how to
+      install the latter).
 email: 
 executables: []
 
@@ -49,7 +50,6 @@ extra_rdoc_files: []
 files: 
 - README
 - lib/rubydraw.rb
-- lib/ext/string.rb
 - lib/rubydraw/window.rb
 - lib/rubydraw/image.rb
 - lib/rubydraw/sound.rb
@@ -67,6 +67,18 @@ files:
 - examples/media/bug.png
 - examples/media/hooray.ogg
 - examples/media/noise.ogg
+- lib/ext/string.rb
+- lib/ext/object.rb
+- lib/ext/aliases.rb
+- lib/fonts/Georgia.ttf
+- lib/fonts/Georgia Bold.ttf
+- lib/fonts/Georgia Italic.ttf
+- lib/fonts/Georgia Bold Italic.ttf
+- lib/fonts/Sans Serif.ttf
+- lib/fonts/Times New Roman.ttf
+- lib/fonts/Times New Roman Bold.ttf
+- lib/fonts/Times New Roman Italic.ttf
+- lib/fonts/Times New Roman Bold Italic.ttf
 has_rdoc: true
 homepage: https://github.com/awostenberg/rubydraw
 licenses: []
@@ -101,6 +113,6 @@ rubyforge_project:
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Rubydraw is a high level drawing/graphics library, like Gosu or Rubygame
+summary: Rubydraw is a high level drawing/graphics library, like Gosu or Rubygame.
 test_files: []