ruby2d 0.5.1 → 0.6.0

data/lib/ruby2d/dsl.rb

@@ -1,36 +1,39 @@
-# dsl.rb
+# Ruby2D::DSL
 
 module Ruby2D::DSL
+
+  Ruby2D::Window.new
+
   def get(sym)
-    Application.get(sym)
+    Window.get(sym)
   end
 
   def set(opts)
-    Application.set(opts)
+    Window.set(opts)
   end
 
   def on(event, &proc)
-    Application.on(event, &proc)
+    Window.on(event, &proc)
   end
 
   def off(event_descriptor)
-    Application.off(event_descriptor)
+    Window.off(event_descriptor)
   end
 
   def update(&proc)
-    Application.update(&proc)
+    Window.update(&proc)
   end
 
   def clear
-    Application.clear
+    Window.clear
   end
 
   def show
-    Application.show
+    Window.show
   end
 
   def close
-    Application.close
+    Window.close
   end
 
 end

data/lib/ruby2d/exceptions.rb

@@ -1,4 +1,4 @@
-# exceptions.rb
+# Ruby2D::Error
 
 module Ruby2D
   class Error < StandardError

data/lib/ruby2d/image.rb

@@ -1,11 +1,11 @@
-# image.rb
+# Ruby2D::Image
 
 module Ruby2D
   class Image
     include Renderable
 
-    attr_accessor :x, :y, :width, :height, :data
     attr_reader :path, :color
+    attr_accessor :x, :y, :width, :height, :rotate, :data
 
     def initialize(opts = {})
       @path = opts[:path]
@@ -19,9 +19,9 @@ module Ruby2D
       @x = opts[:x] || 0
       @y = opts[:y] || 0
       @z = opts[:z] || 0
-      @width  = opts[:width]  || nil
+      @width = opts[:width] || nil
       @height = opts[:height] || nil
-
+      @rotate = opts[:rotate] || 0
       self.color = opts[:color] || 'white'
 
       ext_init(@path)
@@ -35,5 +35,6 @@ module Ruby2D
     def contains?(x, y)
       @x < x and @x + @width > x and @y < y and @y + @height > y
     end
+
   end
 end

data/lib/ruby2d/line.rb

@@ -1,8 +1,9 @@
-# line.rb
+# Ruby2D::Line
 
 module Ruby2D
   class Line
     include Renderable
+
     attr_accessor :x1, :x2, :y1, :y2, :color, :width
 
     def initialize(opts = {})
@@ -13,7 +14,6 @@ module Ruby2D
       @width = opts[:width] || 2
       @z = opts[:z] || 0
       self.color = opts[:color] || 'white'
-
       add
     end
 
@@ -22,13 +22,15 @@ module Ruby2D
       update_color(@color)
     end
 
+    # Return the length of the line
     def length
       points_distance(@x1, @y1, @x2, @y2)
     end
 
-    # Line contains a point if the point is closer than the length of line from both ends
-    # and if the distance from point to line is smaller than half of the width.
-    # Check https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line for reference
+    # Line contains a point if the point is closer than the length of line from
+    # both ends and if the distance from point to line is smaller than half of
+    # the width. For reference:
+    #   https://en.wikipedia.org/wiki/Distance_from_a_point_to_a_line
     def contains?(x, y)
       points_distance(x1, y1, x, y) < length and
       points_distance(x2, y2, x, y) < length and
@@ -37,6 +39,7 @@ module Ruby2D
 
     private
 
+    # Calculate the distance between two points
     def points_distance(x1, y1, x2, y2)
       Math.sqrt((x1 - x2) ** 2 + (y1 - y2) ** 2)
     end
@@ -58,5 +61,6 @@ module Ruby2D
         @c4 = c
       end
     end
+
   end
 end

data/lib/ruby2d/music.rb

@@ -1,10 +1,10 @@
-# music.rb
+# Ruby2D::Music
 
 module Ruby2D
   class Music
 
-    attr_accessor :data, :loop
     attr_reader :path
+    attr_accessor :loop, :data
 
     def initialize(path)
 
@@ -19,24 +19,30 @@ module Ruby2D
       ext_init(path)
     end
 
+    # Play the music
     def play
       ext_play
     end
 
+    # Pause the music
     def pause
       ext_pause
     end
 
+    # Resume paused music
     def resume
       ext_resume
     end
 
+    # Stop playing the music, start at beginning
     def stop
       ext_stop
     end
 
+    # Fade out music over provided milliseconds
     def fadeout(ms)
       ext_fadeout(ms)
     end
+
   end
 end

data/lib/ruby2d/quad.rb

@@ -1,8 +1,11 @@
-# quad.rb
+# Ruby2D::Quad
 
 module Ruby2D
   class Quad
     include Renderable
+
+    attr_reader :color
+
     # Coordinates in clockwise order, starting at top left:
     # x1,y1 == top left
     # x2,y2 == top right
@@ -13,8 +16,6 @@ module Ruby2D
                   :x3, :y3, :c3,
                   :x4, :y4, :c4
 
-    attr_reader :color
-
     def initialize(opts = {})
       @x1 = opts[:x1] || 0
       @y1 = opts[:y1] || 0
@@ -24,9 +25,7 @@ module Ruby2D
       @y3 = opts[:y3] || 100
       @x4 = opts[:x4] || 0
       @y4 = opts[:y4] || 100
-
-      @z = opts[:z] || 0
-
+      @z  = opts[:z]  || 0
       self.color = opts[:color] || 'white'
       add
     end
@@ -73,5 +72,6 @@ module Ruby2D
         @c4 = c
       end
     end
+
   end
 end

data/lib/ruby2d/rectangle.rb

@@ -1,4 +1,4 @@
-# rectangle.rb
+# Ruby2D::Rectangle
 
 module Ruby2D
   class Rectangle < Quad
@@ -6,15 +6,13 @@ module Ruby2D
     attr_reader :x, :y, :width, :height
 
     def initialize(opts = {})
-      @x      = opts[:x]      || 0
-      @y      = opts[:y]      || 0
-      @z      = opts[:z]      || 0
-      @width  = opts[:width]  || 200
+      @x = opts[:x] || 0
+      @y = opts[:y] || 0
+      @z = opts[:z] || 0
+      @width = opts[:width] || 200
       @height = opts[:height] || 100
-
-      update_coords(@x, @y, @width, @height)
-
       self.color = opts[:color] || 'white'
+      update_coords(@x, @y, @width, @height)
       add
     end
 

data/lib/ruby2d/renderable.rb

@@ -1,35 +1,51 @@
+# Ruby2D::Renderable
+
 module Ruby2D
   module Renderable
+
     attr_reader :z
 
+    # Set the z position (depth) of the object
     def z=(z)
       remove
       @z = z
       add
     end
 
+    # Add the object to the window
     def add
       if Module.const_defined? :DSL
-        Application.add(self)
+        Window.add(self)
       end
     end
 
+    # Remove the object from the window
     def remove
       if Module.const_defined? :DSL
-        Application.remove(self)
+        Window.remove(self)
       end
     end
 
-    def opacity
-      self.color.opacity
-    end
+    # Allow shortcuts for setting color values
+    def r; self.color.r end
+    def g; self.color.g end
+    def b; self.color.b end
+    def a; self.color.a end
+    def r=(c); self.color.r = c end
+    def g=(c); self.color.g = c end
+    def b=(c); self.color.b = c end
+    def a=(c); self.color.a = c end
+    def opacity; self.color.opacity end
+    def opacity=(val); self.color.opacity = val end
 
-    def opacity=(val)
-      self.color.opacity = val
-    end
+    # Allow British English spelling of color
+    def colour; self.color end
+    def colour=(c); self.color = c end
 
+    # Add a contains method stub
     def contains?(x, y)
-      raise "Not implemented yet"
+      raise Error, "\`#contains?\` not implemented for this class yet"
     end
+
   end
 end

data/lib/ruby2d/sound.rb

@@ -1,10 +1,10 @@
-# sound.rb
+# Ruby2D::Sound
 
 module Ruby2D
   class Sound
 
-    attr_accessor :data
     attr_reader :path
+    attr_accessor :data
 
     def initialize(path)
 
@@ -18,6 +18,7 @@ module Ruby2D
       ext_init(path)
     end
 
+    # Play the sound
     def play
       ext_play
     end

data/lib/ruby2d/sprite.rb

@@ -1,101 +1,240 @@
-# sprite.rb
+# Ruby2D::Sprite
 
 module Ruby2D
   class Sprite
+    include Renderable
 
-    attr_accessor :x, :y, :clip_x, :clip_y, :clip_w, :clip_h, :data
-    attr_reader :z
+    attr_reader   :x, :y, :width, :height
+    attr_accessor :rotate, :loop, :clip_x, :clip_y, :clip_width, :clip_height, :data
 
-    def initialize(x, y, path, z=0)
+    def initialize(path, opts = {})
 
+      # Check if sprite file exists, unless running on the web
       unless RUBY_ENGINE == 'opal'
         unless File.exists? path
           raise Error, "Cannot find sprite image file `#{path}`"
         end
       end
 
-      @x, @y, @path = x, y, path
-      @clip_x, @clip_y, @clip_w, @clip_h = 0, 0, 0, 0
-      @default = nil
-      @animations = {}
-      @current_animation = nil
-      @current_frame = 0
-      @current_frame_time = 0
-      @z = z
-
-      ext_init(path)
-      if Module.const_defined? :DSL
-        Application.add(self)
+      # Sprite image file path
+      @path = path
+
+      # Coordinates, size, and rotation of the sprite
+      @x = opts[:x] || 0
+      @y = opts[:y] || 0
+      @z = opts[:z] || 0
+      @width  = opts[:width]  || nil
+      @height = opts[:height] || nil
+      @rotate = opts[:rotate] || 0
+
+      # Flipping status, coordinates, and size, used internally
+      @flip = nil
+      @flip_x = @x
+      @flip_y = @y
+      @flip_width  = @width
+      @flip_height = @height
+
+      # Animation attributes
+      @start_time = 0.0
+      @loop = opts[:loop] || false
+      @frame_time = opts[:time] || 300
+      @animations = opts[:animations] || {}
+      @playing = false
+      @current_frame = opts[:default] || 0
+      @last_frame = 0
+      @done_proc = nil
+
+      # The sprite image size set by the native extension `ext_init()`
+      @img_width = nil; @img_height = nil
+
+      # Initialize the sprite
+      ext_init(@path)
+
+      # The clipping rectangle
+      @clip_x = opts[:clip_x] || 0
+      @clip_y = opts[:clip_y] || 0
+      @clip_width  = opts[:clip_width]  || @img_width
+      @clip_height = opts[:clip_height] || @img_height
+
+      # Set the default animation
+      @animations[:default] = 0..(@img_width / @clip_width) - 1
+
+      # Set the sprite defaults
+      @defaults = {
+        animation:   @animations.first[0],
+        frame:       @current_frame,
+        frame_time:  @frame_time,
+        clip_x:      @clip_x,
+        clip_y:      @clip_y,
+        clip_width:  @clip_width,
+        clip_height: @clip_height,
+        loop:        @loop
+      }
+
+      # Add the sprite to the window
+      add
+    end
+
+    # Set the x coordinate
+    def x=(x)
+      @x = @flip_x = x
+      if @flip == :flip_h || @flip == :flip_hv
+        @flip_x = x + @width
       end
     end
 
-    def start(x, y, w, h)
-      @default = [x, y, w, h]
-      clip(x, y, w, h)
+    # Set the y coordinate
+    def y=(y)
+      @y = @flip_y = y
+      if @flip == :flip_v || @flip == :flip_hv
+        @flip_y = y + @height
+      end
     end
 
-    def add(animations)
-      @animations.merge!(animations)
+    # Set the width
+    def width=(width)
+      @width = @flip_width = width
+      if @flip == :flip_h || @flip == :flip_hv
+        @flip_width = -width
+      end
     end
 
-    def animate(animation)
-      if @current_animation != animation
-        @current_frame      = 0
-        @current_frame_time = 0
-        @current_animation  = animation
+    # Set the height
+    def height=(height)
+      @height = @flip_height = height
+      if @flip == :flip_v || @flip == :flip_hv
+        @flip_height = -height
       end
-      animate_frames(@animations[animation])
     end
 
-    def reset
-      clip(@default[0], @default[1], @default[2], @default[3])
-      @current_animation = nil
+    # Play an animation
+    def play(animation = nil, loop = nil, flip = nil, &done_proc)
+      if !@playing || (animation != @playing_animation && animation != nil) || flip != @flip
+
+        @playing = true
+        @playing_animation = animation || :default
+        frames = @animations[@playing_animation]
+        flip_sprite(flip)
+        @done_proc = done_proc
+
+        case frames
+        # When animation is a range, play through frames horizontally
+        when Range
+          @first_frame   = frames.first || @defaults[:frame]
+          @current_frame = frames.first || @defaults[:frame]
+          @last_frame    = frames.last
+        # When array...
+        when Array
+          @first_frame   = 0
+          @current_frame = 0
+          @last_frame = frames.length - 1
+        end
+
+        # Set looping
+        @loop = loop == :loop || @defaults[:loop] ? true : false
+
+        set_frame
+        restart_time
+      end
     end
 
-    # TODO: Sprite already has an `add` method, have to reconsile
-    # def add
-    #   if Module.const_defined? :DSL
-    #     Application.add(self)
-    #   end
-    # end
+    # Stop the current animation and set to the default frame
+    def stop(animation = nil)
+      if !animation || animation == @playing_animation
+        @playing = false
+        @playing_animation = @defaults[:animation]
+        @current_frame = @defaults[:frame]
+        set_frame
+      end
+    end
 
-    def remove
-      if Module.const_defined? :DSL
-        Application.remove(self)
+    # Flip the sprite
+    def flip_sprite(flip)
+
+      # A width and height must be set for the sprite for this to work
+      unless @width && @height then return end
+
+      @flip = flip
+
+      # Reset flip values
+      @flip_x      = @x
+      @flip_y      = @y
+      @flip_width  = @width
+      @flip_height = @height
+
+      case flip
+      when :flip_h   # horizontal
+        @flip_x      = @x + @width
+        @flip_width  = -@width
+      when :flip_v   # vertical
+        @flip_y      = @y + @height
+        @flip_height = -@height
+      when :flip_hv  # horizontal and vertical
+        @flip_x      = @x + @width
+        @flip_width  = -@width
+        @flip_y      = @y + @height
+        @flip_height = -@height
       end
     end
 
-    def width
-      @current_animation ? @animations[@current_animation][@current_frame][2] : @default[2]
+    # Reset frame to defaults
+    def reset_clipping_rect
+      @clip_x      = @defaults[:clip_x]
+      @clip_y      = @defaults[:clip_y]
+      @clip_width  = @defaults[:clip_width]
+      @clip_height = @defaults[:clip_height]
     end
 
-    def height
-      @current_animation ? @animations[@current_animation][@current_frame][3] : @default[3]
+    # Set the position of the clipping retangle based on the current frame
+    def set_frame
+      frames = @animations[@playing_animation]
+      case frames
+      when Range
+        reset_clipping_rect
+        @clip_x = @current_frame * @clip_width
+      when Array
+        f = frames[@current_frame]
+        @clip_x      = f[:x]      || @defaults[:clip_x]
+        @clip_y      = f[:y]      || @defaults[:clip_y]
+        @clip_width  = f[:width]  || @defaults[:clip_width]
+        @clip_height = f[:height] || @defaults[:clip_height]
+        @frame_time  = f[:time]   || @defaults[:frame_time]
+      end
     end
 
-    private
+    # Calculate the time in ms
+    def elapsed_time
+      (Time.now.to_f - @start_time) * 1000
+    end
 
-    def clip(x, y, w, h)
-      @clip_x, @clip_y, @clip_w, @clip_h = x, y, w, h
+    # Restart the timer
+    def restart_time
+      @start_time = Time.now.to_f
     end
 
-    def animate_frames(frames)
-      if @current_frame_time < frames[@current_frame][4]
-        clip_with_current_frame(frames)
-        @current_frame_time += 1
-      else
-        @current_frame += 1
-        if @current_frame == frames.length
-          @current_frame = 0
+    # Update the sprite animation, called by `Sprite#ext_render`
+    def update
+      if @playing
+
+        # Advance the frame
+        unless elapsed_time <= (@frame_time || @defaults[:frame_time])
+          @current_frame += 1
+          restart_time
         end
-        clip_with_current_frame(frames)
-        @current_frame_time = 0
-      end
-    end
 
-    def clip_with_current_frame(frames)
-      clip(frames[@current_frame][0], frames[@current_frame][1],
-           frames[@current_frame][2], frames[@current_frame][3])
+        # Reset to the starting frame if all frames played
+        if @current_frame > @last_frame
+          @current_frame = @first_frame
+          unless @loop
+            # Stop animation and play block, if provided
+            stop
+            if @done_proc then @done_proc.call end
+            @done_proc = nil
+          end
+        end
+
+        set_frame
+      end
     end
 
   end