polaris 0.0.1 → 0.0.2

data/README.txt

@@ -0,0 +1,21 @@
+= polaris
+
+* http://github.com/shawn42/polaris
+
+== DESCRIPTION:
+
+  A* pathfinding in Ruby. Pulled out of Gamebox.
+
+
+== REQUIREMENTS:
+* algorithms gem 
+
+== INSTALL:
+
+* gem install poloaris
+
+== LICENSE:
+
+(MIT)
+
+Copyright (c) 2010 Shawn Anderson

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "polaris"
+    gem.rubyforge_project = "polaris"
+    gem.summary = %Q{A* pathfinding in ruby.}
+    gem.description = %Q{A* pathfinding in Ruby, using C datastructures to speed things up.}
+    gem.email = "shawn42@gmail.com"
+    gem.homepage = "http://github.com/shawn42/polaris"
+    gem.authors = ["Shawn Anderson"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "jeweler"
+    gem.add_dependency 'algorithms'
+    gem.test_files = FileList['{spec,test}/**/*.rb']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+desc "Run all rspecs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+task :default => :spec
+
+# vim: syntax=Ruby

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/line_of_site.rb

@@ -0,0 +1,61 @@
+# LineOfSite is a class for finding neighbors in a map that are visible
+class LineOfSite
+  def initialize(map)
+    @map = map
+  end
+  
+  def losline(x, y, x2, y2)
+    brensenham_line(x, y, x2, y2).each do |i|
+      iterx, itery = *i
+      occ = @map.occupant(loc2(iterx,itery))
+      return unless occ
+      occ.lit = true
+      occ.seen = true
+      
+      return if occ.solid?      
+    end
+  end            
+  
+  # Brensenham line algorithm
+  def brensenham_line(x,y,x2,y2)
+    steep = false
+    coords = []
+    dx = (x2 - x).abs
+    if (x2 - x) > 0
+      sx = 1
+    else 
+      sx = -1
+    end
+    dy = (y2 - y).abs
+    if (y2 - y) > 0
+      sy = 1
+    else
+      sy = -1
+    end
+    if dy > dx
+      steep = true
+      x,y = y,x
+      dx,dy = dy,dx
+      sx,sy = sy,sx
+    end
+    d = (2 * dy) - dx
+
+    dx.times do
+      if steep 
+        coords << [y,x]
+      else
+        coords << [x,y]
+      end
+      while d >= 0
+        y = y + sy
+        d = d - (2 * dx)
+      end
+      x = x + sx
+      d = d + (2 * dy)
+    end
+    coords << [x2,y2]
+    
+    coords             
+  end  
+
+end

data/lib/polaris.rb

@@ -0,0 +1,109 @@
+require 'algorithms'
+include Containers
+
+# Polaris is a star that guides, aka "The North Star".  It implements the A* algorithm.
+class Polaris
+  attr_reader :nodes_considered
+  
+  def initialize(map)
+    @map = map
+    @nodes_considered = 0
+  end
+  
+  # Returns the path without the from location. 
+  # Returns nil if max_depth is hit or if no path exists.
+  def guide(from, to, unit_type=nil, max_depth=400)
+    return nil if @map.blocked?(from, unit_type) || @map.blocked?(to, unit_type)
+    from_element = PathElement.new(from)
+    from_element.dist_from = @map.distance(from,to)
+    open = PriorityQueue.new { |x, y| (x <=> y) == -1 }
+    open.push from_element, from_element.rating
+    closed = SplayTreeMap.new
+    step = 0
+    
+    until open.empty? || step > max_depth
+      step += 1
+      
+      current_element = open.pop
+      @nodes_considered += 1
+      
+      loc = current_element.location
+      if @map.cost(loc,to) == 0
+        path = []
+        until current_element.parent.nil?
+          path.unshift current_element
+          current_element = current_element.parent
+        end
+
+        return path
+      else
+        closed.push current_element.location, current_element
+        @map.neighbors(loc).each do |next_door|
+          el = PathElement.new(next_door,current_element)
+          next if closed.has_key? next_door
+          
+          if @map.blocked? next_door, unit_type
+            closed.push el.location, el
+          else
+            current_rating = current_element.cost_to + @map.cost(loc, next_door)
+            
+            # add to open
+            el.cost_to = current_rating
+            el.dist_from = @map.distance(next_door,to)
+            
+            open.push el, el.rating
+          end
+        end
+      end
+    end
+    nil
+  end
+end
+
+class PathElement
+  include Comparable
+  
+  attr_accessor :location, :parent
+  attr_reader :cost_to, :dist_from, :rating
+  def initialize(location=nil,parent=nil)
+    @location = location
+    @parent = parent
+    @cost_to = 0
+    @dist_from = 0
+    @rating = 99_999
+  end
+  
+  def cost_to=(new_cost)
+    @cost_to = new_cost
+    reset_rating
+  end
+  
+  def dist_from=(new_dist_from)
+    @dist_from = new_dist_from
+    reset_rating
+  end
+  
+  def reset_rating
+    @rating = @cost_to + @dist_from
+  end
+  
+  def to_s
+    "#{@location} at cost of #{@cost_to} and rating of #{@rating}"
+  end
+  
+  def <=>(b)
+    a = self
+    if a.rating < b.rating
+      return -1
+    elsif a.rating > b.rating
+      return 1
+    else
+      0
+    end
+  end
+  
+  def ==(other)
+    return false if other.nil?
+    @location == other.location
+  end
+end

data/lib/two_d_grid_location.rb

@@ -0,0 +1,21 @@
+# TwoDGridLocation exibits an x,y,cost location
+class TwoDGridLocation
+  attr_accessor :x,:y
+  def initialize(x,y);@x=x;@y=y;end
+  def ==(other)
+    @x == other.x and @y == other.y
+  end
+  
+  def <=>(b)
+    ret = 1
+    if @x == b.x && @y == b.y  
+      ret = 0
+    end
+    ret = -1 if @x <= b.x && @y < b.y
+    return ret
+  end
+  
+  def to_s
+    "#{@x},#{@y}"
+  end
+end

data/lib/two_d_grid_map.rb

@@ -0,0 +1,81 @@
+require 'two_d_grid_location'
+
+# TwoDGridMap exibits the contract that the map requires. 
+# Works on an X,Y grid that uses Ftors for 2D vectors
+class TwoDGridMap
+  attr_accessor :w, :h
+  TRAVEL_COST_DIAG = 14
+  TRAVEL_COST_STRAIGHT = 10
+  
+  def initialize(w,h)
+    @w = w
+    @h = h
+    @grid = {}
+  end
+  
+  def size
+    [@w,@h]
+  end
+  
+  # place thing at location. If thing is nil, location will be placed in the map
+  def place(location, thing=nil)
+    thing ||= location
+    @grid[location.x] ||= {}
+    @grid[location.x][location.y] = thing
+  end
+  
+  def occupant(location)
+    @grid[location.x][location.y] if @grid[location.x]
+  end
+  
+  def clear(location)
+    @grid[location.x] ||= {}
+    @grid[location.x][location.y] = nil
+  end
+  
+  # is the location available for the specified type
+  def blocked?(location, type=nil)
+    return true if type == :blocked
+    return true if location.x >= @w || location.y >= @h || location.x < 0 || location.y < 0
+    if @grid[location.x] and @grid[location.x][location.y]
+      return true
+    else
+      return false
+    end
+  end
+  
+  # returns a list of neighbors and their distance
+  def neighbors(location)
+    x = location.x
+    y = location.y
+    [
+      TwoDGridLocation.new(x-1, y-1),
+      TwoDGridLocation.new(x-1, y+1),
+      TwoDGridLocation.new(x+1, y-1),
+      TwoDGridLocation.new(x+1, y+1),
+      TwoDGridLocation.new(x-1, y),
+      TwoDGridLocation.new(x+1, y),
+      TwoDGridLocation.new(x, y-1),
+      TwoDGridLocation.new(x, y+1)
+    ]
+  end
+  
+  def distance(from,to)
+    h_diagonal = [(from.x-to.x).abs, (from.y-to.y).abs].min
+    h_straight = ((from.x-to.x).abs + (from.y-to.y).abs)
+    return TRAVEL_COST_DIAG * h_diagonal + TRAVEL_COST_STRAIGHT * (h_straight - 2*h_diagonal)
+  end
+  
+  # return the cost to go from => to (assuming from and to are neighbors)
+  def cost(from, to)
+    if from.x == to.x or from.y == to.y
+      if from.x == to.x and from.y == to.y
+        0
+      else
+        TRAVEL_COST_STRAIGHT
+      end
+    else
+      TRAVEL_COST_DIAG
+    end
+  end
+end

data/polaris.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{polaris}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shawn Anderson"]
+  s.date = %q{2010-02-27}
+  s.description = %q{A* pathfinding in Ruby, using C datastructures to speed things up.}
+  s.email = %q{shawn42@gmail.com}
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    "README.txt",
+     "Rakefile",
+     "VERSION",
+     "lib/line_of_site.rb",
+     "lib/polaris.rb",
+     "lib/two_d_grid_location.rb",
+     "lib/two_d_grid_map.rb",
+     "polaris.gemspec",
+     "spec/helper.rb",
+     "spec/line_of_site_spec.rb",
+     "spec/polaris_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/shawn42/polaris}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{polaris}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A* pathfinding in ruby.}
+  s.test_files = [
+    "spec/helper.rb",
+     "spec/line_of_site_spec.rb",
+     "spec/polaris_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<algorithms>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<algorithms>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<algorithms>, [">= 0"])
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Shawn Anderson
@@ -59,10 +59,20 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
-files: []
-
+extra_rdoc_files: 
+- README.txt
+files: 
+- README.txt
+- Rakefile
+- VERSION
+- lib/line_of_site.rb
+- lib/polaris.rb
+- lib/two_d_grid_location.rb
+- lib/two_d_grid_map.rb
+- polaris.gemspec
+- spec/helper.rb
+- spec/line_of_site_spec.rb
+- spec/polaris_spec.rb
 has_rdoc: true
 homepage: http://github.com/shawn42/polaris
 licenses: []