salamander 0.0.4 → 0.0.5

data/lib/salamander.rb

@@ -5,6 +5,9 @@ module Salamander
   require 'salamander/actor'
   require 'salamander/drawing'
   
+  # Initialize SDL and create a window
+  #
+  # Do not call more than once
   def self.setup (width, height)
     SDL.Init(SDL::INIT_VIDEO)
     at_exit { SDL.Quit }

data/lib/salamander/actor.rb

@@ -1,5 +1,8 @@
 module Salamander
   class Actor
+    # Executes code within the context of an Actor.
+    #
+    # If given a filename, reads the contents and evaluates it.
     def self.draw (screen, filename=nil, &blk)
       actor = new(screen)
       if filename
@@ -19,40 +22,49 @@ module Salamander
     end
     
     
+    # Get the current position as an array.
     def position
       [@x, @y]
     end
     
+    # Move a given distance in the current direction.
     def move (distance)
       x = distance * Math.cos(angle) + @x
       y = distance * Math.sin(angle) + @y
       move_to(x, y)
     end
     
+    # Move to a specific point
     def move_to (x, y)
       @x, @y = x, y
     end
     
     
+    # The current angle, in radians.
     def angle
       @angle
     end
     
+    # Turn towards a new direction.
+    #
+    # 'theta' may be :right, :left, :around, or a number of radians. Positive amounts of radians turn right, while negative amounts go to the left.
     def turn (theta)
       theta = DIRECTIONS[theta] if theta.is_a? Symbol
       face(theta + angle)
     end
     
+    # Face a specific direction
+    #
+    # 'theta' may be :north, :northeast, :east, etc. or a number of radians. 0 radians points east, and increasing amounts go clockwise.
     def face (theta)
       theta = COMPASS[theta] if theta.is_a? Symbol
       @angle = theta % (2 * Math::PI)
     end
     
-    
-    def rgba
-      @color
-    end
-    
+    # Gets or sets the current drawing color in numeric RGBA format.
+    #
+    # If 'color' is nil, gets the current color.
+    # Otherwise, 'color' must be in "#RRGGBB" notation.
     def color (color=nil)
       if not color then
         @color
@@ -68,6 +80,7 @@ module Salamander
     end
     
     
+    # The SDL surface being drawn to
     def surface
       @surface
     end

data/lib/salamander/drawing/line.rb

@@ -1,12 +1,14 @@
 module Salamander::Drawing
   module Line
-    def draw_to (x2, y2)
+    # Draws a line from the current position to (x2, y2) in the current drawing color.
+    def line_to (x2, y2)
       x1, y1 = position
       move_to(x2, y2)
       SDL::Gfx.aalineColor(surface, x1.round, y1.round, x2.round, y2.round, color)
     end
     
-    def draw (distance)
+    # Draws a line 'distance' pixels long from the current position in the current drawing color.
+    def line (distance)
       x1, y1 = position
       move distance
       x2, y2 = position

data/lib/salamander/drawing/shapes.rb

@@ -2,17 +2,21 @@ module Salamander::Drawing
   module Shapes
     include Line
     
+    # Draws a star-like shape with number 'points' of points.
+    #
+    # 'points' must be odd.
     def star (points, length)
       raise "The star must have an odd number of points" if points % 2 == 0
       points.times do
-        draw length
+        line length
         turn (720.0/points).degrees
       end
     end
     
+    # Draws a regular polygon with 'sides' sides, each of length 'length'
     def polygon (sides, length)
       sides.times do
-        draw length
+        line length
         turn (360.0/sides).degrees
       end
     end

data/lib/salamander/support/radians.rb

@@ -1,11 +1,10 @@
 class Numeric
-  # Input assumed to be radians
+  # Does nothing - input is assumed to be radians already
   def radians
     self
   end
   
-  # Input assumed to be degrees
-  # Convert to radians
+  # Converts from degrees to radians.
   def degrees
     self / 180.0 * Math::PI
   end

data/lib/salamander/version.rb

@@ -1,3 +1,3 @@
 module Salamander
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jonathan Castello