rubydraw 0.3.1.8 → 0.3.2.1

data/lib/ext/object.rb

@@ -1,34 +1,45 @@
 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
+  # 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 register_action(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][self] = block
+  end
+
+  alias whenever register_action
+
+  # Adds the ability to remove actions from registered_actions. Useful if, for example,
+  # one were to implement a button that only works if it is shown.
+  def unregister_action(event, window=self)
+    unless window.is_a?(Rubydraw::Window)
+      raise ArgumentError, "window must be a Rubydraw::Window"
+    end
+    window.registered_actions[event].delete(self)
+  end
 end

data/lib/rubydraw/events.rb

@@ -66,7 +66,7 @@ module Rubydraw
     class UnknownEvent < Event
       # The SDL event should be passed so that the programmer using this library can still
       # attempt to implement behavior, but it will have to match and SDL event, not a
-      # Rubydraw::Events::Event.
+      # Rubydraw Event.
       def from_sdl_event(sdl_event)
         self.new(sdl_event)
       end
@@ -215,7 +215,7 @@ module Rubydraw
     # Rubydraw::Events::FocusGain and Rubydraw::Events::FocusLose.
     class FocusEvent < Event
       def self.wants_to_match?
-        false
+        not self == FocusEvent
       end
 
       def self.matching_sdl_type
@@ -226,10 +226,6 @@ module Rubydraw
     # Created when the window gains focus, e.g. clicking on the window after previously using
     # another application.
     class FocusGain < FocusEvent
-      def self.wants_to_match?
-        true
-      end
-
       # Redefine Event#matches? because both this class and Rubydraw::Events::FocusLoss use
       # SDL::ActiveEvent.
       def self.matches?(sdl_event)
@@ -242,10 +238,6 @@ module Rubydraw
 
     # Created when the window loses focus.
     class FocusLoss < FocusEvent
-      def self.wants_to_match?
-        true
-      end
-
       # Redefine Event#matches? because both this class and Rubydraw::Events::FocuGain use
       # SDL::ActiveEvent
       def self.matches?(sdl_event)

data/lib/rubydraw/image.rb

@@ -5,21 +5,20 @@ module Rubydraw
   # read the documentation for Image#draw), call it's #draw method
   # and pass it the +x+ and +y+ coordinates.
   class Image < Surface
-    # Create a new image and load the file from a path. Or, wrap an
-    # SDL::Surface.
     def initialize(arg)
-      if arg.is_a?(String)
-        # This must mean to load from a path.
-        load_from_path(arg)
-      elsif arg.is_a?(SDL::Surface)
-        load_from_surface(arg)
+      if arg.kind_of?(SDL::Surface)
+        # This means we want to wrap an sdl surface.
+        @sdl_surface = arg
+      elsif arg.kind_of?(String)
+        # This means we want to load an image from a file.
+        initialize_from_path(arg)
       else
-        raise TypeError, "Failed to load image: Expected String or SDL::Surface but got: #{arg}"
+        # Raise an error if it is neither. I should figure out a less strict, more dynamic way to do this.
+        raise SDLError, "Argument to Rubydraw::Image.new was neither an image path nor an SDL::Surface to wrap"
       end
-      self
     end
 
-    def load_from_path(path)  #:nodoc:
+    def initialize_from_path(path)
       # Check if this image has already been initialized. If it has, raise
       # an error.
       unless @sdl_surface.nil?
@@ -35,16 +34,5 @@ module Rubydraw
         raise SDLError, "Failed to load image: #{SDL.GetError}"
       end
     end
-
-    def load_from_surface(surface) #:nodoc:
-      # Check if this image has already been initialized. If it has, raise
-      # an error.
-      unless @sdl_surface.nil?
-        raise SDLError, "Images may only be loaded once"
-      end
-      @sdl_surface = surface
-    end
-
-    private :load_from_path, :load_from_surface
   end
 end

data/lib/rubydraw/sound.rb

@@ -6,7 +6,7 @@ module Rubydraw
   # Rubydraw::Sound#new:    Creates a new sound with the given file path
   #
   # Rubydraw::Sound#play:   Plays the sound. *Note*: this method exits
-  # immediatley; it doesn't wait until the sound is finished.
+  # immediately; it doesn't wait until the sound is finished.
   class Sound
     # Used to specify the volume (from 0 to 1) when this sound is played.
     # Set at 1 by default
@@ -19,11 +19,11 @@ module Rubydraw
       full_path = File.expand_path path
       SDL::Mixer.OpenAudio(22050, SDL::AUDIO_S16SYS, 2, 1024)
       @sdl_sound = SDL::Mixer::LoadWAV(full_path)
-      # Ususally happens because the file doesn't exist.
+      # Usually happens because the file doesn't exist.
       if @sdl_sound.pointer.null?
-        raise SDLError "Failed to load sound from: #{full_path} because '#{SDL.GetError}'"
+        raise SDLError, "Failed to load sound from: #{full_path} because '#{SDL.GetError}'"
       end
-      # The default volume. Can be changed with Sound's volume arrtibute.
+      # The default volume. Can be changed with Sound's volume attribute.
       @volume = 1
       # Allocate a new SDL channel all for this sound to use.
       @channel = SDL::Mixer.AllocateChannels(SDL::Mixer.AllocateChannels(-1) + 1) - 1

data/lib/rubydraw/surface.rb

@@ -13,8 +13,17 @@ module Rubydraw
       Text.new(contents, color)
     end
 
+    def initialize(*args)
+      if args.size == 1
+        # Must mean to wrap an SDL surface.
+        @sdl_surface = args[0]
+      else
+        load_from_color(*args)
+      end
+    end
+
     # Create a new, blank surface with the given dimensions.
-    def initialize(dimensions, color=Rubydraw::Color::Black)
+    def load_from_color(dimensions, color=Rubydraw::Color::Black)
       @dimensions = dimensions
       pixel_format = SDL.GetVideoInfo.vfmt
       rmsk, gmsk, bmsk, amsk = 0xff0000, 0x00ff00, 0x0000ff, 0x000000
@@ -27,6 +36,8 @@ module Rubydraw
       self
     end
 
+    private :load_from_color
+
     # Blit (copy) into +surface at +position+ (see Rubydraw::Point).
     # No graphical effects are applied.
     def blit(surface, position)

data/lib/rubydraw/text.rb

@@ -7,7 +7,7 @@ module Rubydraw
 
     # Create a new drawable Text object with the given font and contents.
     def initialize(contents, color, font_name="Times New Roman", font_size = 25)
-      @font, @contents, @font_size, @color = font_name, contents, font_size, color
+      @contents, @font, @font_size, @color = contents, font_name, font_size, color
       if File.exist?(font_name)
         font_path = font_name
       else
@@ -24,5 +24,16 @@ module Rubydraw
       sdl_color = @color.to_sdl
       @sdl_surface = SDL::TTF.RenderText_Blended(sdl_text, @contents, sdl_color)
     end
+
+    # Redefined because if @text is an empty string, it would
+    # return nil.
+    def width
+      super or 0
+    end
+
+    # See Rubydraw::Text#width
+    def height
+      super or 0
+    end
   end
 end

data/lib/rubydraw/window.rb

@@ -58,6 +58,10 @@ module Rubydraw
       end
     end
 
+    def size
+      Point[width, height]
+    end
+
     # Call this method to start updating and drawing.
     def show
       @open = true
@@ -125,14 +129,20 @@ module Rubydraw
     end
 
     # Collect and handle new events by executing blocks in +@regestered_events+. See
-    # Rubydraw::Window#register_action on how to use it.
+    # Object#whenever on how to use it.
     def handle_events
       events = @event_queue.get_events
-      events.each { |event|
-        blocks = @registered_actions[event.class]
+      events.each {|event|
+        # +blocks+ is a hashmap; the value being the object that registered it. This
+        # property is only used in Object#unregister_action.
+        events = @registered_actions
+        blocks = events[event.class]
         unless blocks.nil?
-          blocks.each { |b| b.call(event) unless b.nil? }
-        end }
+          blocks.each {|obj, b|
+            b.call(event) unless b.nil?
+          }
+        end
+      }
     end
 
     # Causes the main loop to exit as soon as it get the chance to.

metadata

@@ -2,7 +2,7 @@
 name: rubydraw
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1.8
+  version: 0.3.2.1
 platform: ruby
 authors: 
 - J. Wostenberg
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-23 00:00:00 -07:00
+date: 2012-01-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency