ruby2d 0.5.1 → 0.6.0

data/lib/ruby2d/square.rb

@@ -1,4 +1,4 @@
-# square.rb
+# Ruby2D::Square
 
 module Ruby2D
   class Square < Rectangle
@@ -10,18 +10,18 @@ module Ruby2D
       @y = opts[:y] || 0
       @z = opts[:z] || 0
       @width = @height = @size = opts[:size] || 100
-
       self.color = opts[:color] || 'white'
-
       update_coords(@x, @y, @size, @size)
-
       add
     end
 
+    # Set the size of the square
     def size=(s)
       self.width = self.height = @size = s
     end
 
+    # Make the inherited width and height attribute accessors private
     private :width=, :height=
+
   end
 end

data/lib/ruby2d/text.rb

@@ -1,19 +1,19 @@
-# text.rb
+# Ruby2D::Text
 
 module Ruby2D
   class Text
     include Renderable
 
-    attr_accessor :x, :y, :data
     attr_reader :text, :size, :width, :height, :font, :color
+    attr_accessor :x, :y, :rotate, :data
 
     def initialize(opts = {})
       @x = opts[:x] || 0
       @y = opts[:y] || 0
       @z = opts[:z] || 0
-      @text = (opts[:text] || "Hello World!").to_s
+      @text = (opts[:text] || "Hello Ruby!").to_s
       @size = opts[:size] || 20
-
+      @rotate = opts[:rotate] || 0
       @font = opts[:font]
 
       unless RUBY_ENGINE == 'opal'

data/lib/ruby2d/triangle.rb

@@ -1,13 +1,13 @@
-# triangle.rb
+# Ruby2D::Triangle
 
 module Ruby2D
   class Triangle
     include Renderable
 
+    attr_reader :color
     attr_accessor :x1, :y1, :c1,
                   :x2, :y2, :c2,
                   :x3, :y3, :c3
-    attr_reader :color, :type_id
 
     def initialize(opts= {})
       @x1 = opts[:x1] || 50
@@ -16,8 +16,7 @@ module Ruby2D
       @y2 = opts[:y2] || 100
       @x3 = opts[:x3] || 0
       @y3 = opts[:y3] || 100
-      @z = opts[:z] || 0
-
+      @z  = opts[:z]  || 0
       self.color = opts[:color] || 'white'
       add
     end
@@ -61,5 +60,6 @@ module Ruby2D
         @c3 = c
       end
     end
+
   end
 end

data/lib/ruby2d/version.rb

@@ -1,5 +1,5 @@
-# version.rb
+# Ruby2D::VERSION
 
 module Ruby2D
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/lib/ruby2d/window.rb

@@ -1,37 +1,70 @@
-# window.rb
+# Ruby2D::Window
+# Represents a window on screen, responsible for storing renderable graphics,
+# event handlers, the update loop, showing and closing the window.
 
 module Ruby2D
   class Window
 
-    attr_reader :objects
-    attr_accessor :mouse_x, :mouse_y, :frames, :fps
-
+    # Event structures
     EventDescriptor = Struct.new(:type, :id)
     MouseEvent = Struct.new(:type, :button, :direction, :x, :y, :delta_x, :delta_y)
     KeyEvent   = Struct.new(:type, :key)
-    ControllerEvent = Struct.new(:which, :type, :axis, :value, :button)
+    ControllerEvent       = Struct.new(:which, :type, :axis, :value, :button)
     ControllerAxisEvent   = Struct.new(:which, :axis, :value)
     ControllerButtonEvent = Struct.new(:which, :button)
 
     def initialize(args = {})
-      @title      = args[:title]  || "Ruby 2D"
+
+      # This window instance, stored so it can be called by the class methods
+      @@window = self
+
+      # Title of the window
+      @title = args[:title]  || "Ruby 2D"
+
+      # Window background color
       @background = Color.new([0.0, 0.0, 0.0, 1.0])
-      @width      = args[:width]  || 640
-      @height     = args[:height] || 480
-      @viewport_width, @viewport_height = nil, nil
-      @display_width, @display_height = nil, nil
-      @resizable  = false
+
+      # Window icon
+      @icon = nil
+
+      # Window size and characteristics
+      @width  = args[:width]  || 640
+      @height = args[:height] || 480
+      @resizable = false
       @borderless = false
       @fullscreen = false
-      @highdpi    = false
-      @frames     = 0
-      @fps_cap    = args[:fps]    || 60
-      @fps        = @fps_cap
-      @vsync      = args[:vsync]  || true
+      @highdpi = false
+
+      # Size of the window's viewport (the drawable area)
+      @viewport_width, @viewport_height = nil, nil
+
+      # Size of the computer's display
+      @display_width, @display_height = nil, nil
+
+      # Total number of frames that have been rendered
+      @frames = 0
+
+      # Frames per second upper limit, and the actual FPS
+      @fps_cap = args[:fps_cap] || 60
+      @fps = @fps_cap
+
+      # Vertical synchronization, set to prevent screen tearing (recommended)
+      @vsync = args[:vsync] || true
+
+      # Mouse X and Y position in the window
       @mouse_x, @mouse_y = 0, 0
-      @objects    = []
-      @event_key  = 0
-      @events     = {
+
+      # Controller axis and button mappings file
+      @controller_mappings = File.expand_path('~') + "/.ruby2d/controllers.txt"
+
+      # Renderable objects currently in the window, like a linear scene graph
+      @objects = []
+
+      # Unique ID for the input event being registered
+      @event_key = 0
+
+      # Registered input events
+      @events = {
         key: {},
         key_down: {},
         key_held: {},
@@ -46,15 +79,80 @@ module Ruby2D
         controller_button_down: {},
         controller_button_up: {}
       }
+
+      # The window update block
       @update_proc = Proc.new {}
+
+      # Whether diagnostic messages should be printed
       @diagnostics = false
-      @controller_mappings_path = File.join(Dir.home, ".ruby2d", "controllers.txt")
     end
 
-    def new_event_key
-      @event_key = @event_key.next
+    # Class methods for convenient access to properties
+    class << self
+      def current;         get(:window)          end
+      def title;           get(:title)           end
+      def background;      get(:background)      end
+      def width;           get(:width)           end
+      def height;          get(:height)          end
+      def viewport_width;  get(:viewport_width)  end
+      def viewport_height; get(:viewport_height) end
+      def display_width;   get(:display_width)   end
+      def display_height;  get(:display_height)  end
+      def resizable;       get(:resizable)       end
+      def borderless;      get(:borderless)      end
+      def fullscreen;      get(:fullscreen)      end
+      def highdpi;         get(:highdpi)         end
+      def frames;          get(:frames)          end
+      def fps;             get(:fps)             end
+      def fps_cap;         get(:fps_cap)         end
+      def mouse_x;         get(:mouse_x)         end
+      def mouse_y;         get(:mouse_y)         end
+      def diagnostics;     get(:diagnostics)     end
+
+      def get(sym)
+        @@window.get(sym)
+      end
+
+      def set(opts)
+        @@window.set(opts)
+      end
+
+      def on(event, &proc)
+        @@window.on(event, &proc)
+      end
+
+      def off(event_descriptor)
+        @@window.off(event_descriptor)
+      end
+
+      def add(o)
+        @@window.add(o)
+      end
+
+      def remove(o)
+        @@window.remove(o)
+      end
+
+      def clear
+        @@window.clear
+      end
+
+      def update(&proc)
+        @@window.update(&proc)
+      end
+
+      def show
+        @@window.show
+      end
+
+      def close
+        @@window.close
+      end
     end
 
+    # Public instance methods
+
+    # Retrieve an attribute of the window
     def get(sym)
       case sym
       when :window;          self
@@ -77,20 +175,24 @@ module Ruby2D
       when :highdpi;         @highdpi
       when :frames;          @frames
       when :fps;             @fps
+      when :fps_cap;         @fps_cap
       when :mouse_x;         @mouse_x
       when :mouse_y;         @mouse_y
       when :diagnostics;     @diagnostics
       end
     end
 
+    # Set a window attribute
     def set(opts)
       # Store new window attributes, or ignore if nil
       @title           = opts[:title]           || @title
       if Color.is_valid? opts[:background]
         @background    = Color.new(opts[:background])
       end
+      @icon            = opts[:icon]            || @icon
       @width           = opts[:width]           || @width
       @height          = opts[:height]          || @height
+      @fps_cap         = opts[:fps_cap]         || @fps_cap
       @viewport_width  = opts[:viewport_width]  || @viewport_width
       @viewport_height = opts[:viewport_height] || @viewport_height
       @resizable       = opts[:resizable]       || @resizable
@@ -100,6 +202,7 @@ module Ruby2D
       @diagnostics     = opts[:diagnostics]     || @diagnostics
     end
 
+    # Add an object to the window
     def add(o)
       case o
       when nil
@@ -111,6 +214,7 @@ module Ruby2D
       end
     end
 
+    # Remove an object from the window
     def remove(o)
       if o == nil
         raise Error, "Cannot remove '#{o.class}' from window!"
@@ -124,15 +228,23 @@ module Ruby2D
       end
     end
 
+    # Clear all objects from the window
     def clear
       @objects.clear
     end
 
+    # Set an update callback
     def update(&proc)
       @update_proc = proc
       true
     end
 
+    # Generate a new event key (ID)
+    def new_event_key
+      @event_key = @event_key.next
+    end
+
+    # Set an event handler
     def on(event, &proc)
       unless @events.has_key? event
         raise Error, "`#{event}` is not a valid event type"
@@ -142,13 +254,13 @@ module Ruby2D
       EventDescriptor.new(event, event_id)
     end
 
+    # Remove an event handler
     def off(event_descriptor)
       @events[event_descriptor.type].delete(event_descriptor.id)
     end
 
+    # Key callback method, called by the native and web extentions
     def key_callback(type, key)
-      # puts "===", "type: #{type}", "key: #{key}"
-
       key = key.downcase
 
       # All key events
@@ -175,6 +287,7 @@ module Ruby2D
       end
     end
 
+    # Mouse callback method, called by the native and web extentions
     def mouse_callback(type, button, direction, x, y, delta_x, delta_y)
       # All mouse events
       @events[:mouse].each do |id, e|
@@ -205,6 +318,16 @@ module Ruby2D
       end
     end
 
+    # Add controller mappings from file
+    def add_controller_mappings
+      unless RUBY_ENGINE == 'opal'
+        if File.exists? @controller_mappings
+          ext_add_controller_mappings(@controller_mappings)
+        end
+      end
+    end
+
+    # Controller callback method, called by the native and web extentions
     def controller_callback(which, type, axis, value, button)
       # All controller events
       @events[:controller].each do |id, e|
@@ -230,20 +353,26 @@ module Ruby2D
       end
     end
 
+    # Update callback method, called by the native and web extentions
     def update_callback
       @update_proc.call
     end
 
+    # Show the window
     def show
       ext_show
     end
 
+    # Close the window
     def close
       ext_close
     end
 
+    # Private instance methods
+
     private
 
+    # An an object to the window, used by the public `add` method
     def add_object(o)
       if !@objects.include?(o)
         index = @objects.index do |object|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby2d
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Tom Black
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 description: Make cross-platform 2D applications in Ruby
 email: tom@blacktm.com
 executables:
@@ -86,8 +86,6 @@ files:
 - assets/ios/MyApp.xcodeproj/project.pbxproj
 - assets/ios/MyApp.xcodeproj/project.xcworkspace/contents.xcworkspacedata
 - assets/ios/MyApp.xcodeproj/project.xcworkspace/xcshareddata/MyApp.xcscmblueprint
-- assets/ios/MyApp.xcodeproj/project.xcworkspace/xcuserdata/Tom.xcuserdatad/UserInterfaceState.xcuserstate
-- assets/ios/MyApp.xcodeproj/xcuserdata/Tom.xcuserdatad/xcschemes/xcschememanagement.plist
 - assets/ios/main.c
 - assets/opal.js
 - assets/simple2d.js
@@ -153,7 +151,7 @@ files:
 - ext/ruby2d/ruby2d-opal.rb
 - ext/ruby2d/ruby2d.c
 - lib/ruby2d.rb
-- lib/ruby2d/application.rb
+- lib/ruby2d/circle.rb
 - lib/ruby2d/color.rb
 - lib/ruby2d/dsl.rb
 - lib/ruby2d/exceptions.rb
@@ -190,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby 2D