ifmapper 0.5 → 0.6

data/icons/room_w.xpm

@@ -0,0 +1,39 @@
+/* XPM */
+static char * room_left_xpm[] = {
+"32 32 4 1",
+" 	c #000000",
+".	c #404040",
+"+	c #7F7F7F",
+"@	c #FFFFFF",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@.++++++++++++++.@@@@@@@@",
+"@@@@@@@@+@@@@@@@@@@@@@@+@@@@@@@@",
+"@@@@@@@@+@@@@@@@@@@@@@@+@@@@@@@@",
+"@@@@@@@@+@@@@@@@@@@@@@@+@@@@@@@@",
+"@        @@@@@@@@@@@@@@+@@@@@@@@",
+"@        @@@@@@@@@@@@@@+@@@@@@@@",
+"@        @@@@@@@@@@@@@@+@@@@@@@@",
+"@        @@@@@@@@@@@@@@+@@@@@@@@",
+"@@@@@@@@+@@@@@@@@@@@@@@+@@@@@@@@",
+"@@@@@@@@+@@@@@@@@@@@@@@+@@@@@@@@",
+"@@@@@@@@+@@@@@@@@@@@@@@+@@@@@@@@",
+"@@@@@@@@.++++++++++++++.@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@",
+"@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"};

data/lib/IFMapper/AStar.rb

@@ -0,0 +1,243 @@
+
+
+
+#
+# A class used for path finding.
+# This is largely based on C++ code by Justin Heyes-Jones, albeit simplified
+#
+class AStar
+
+  attr :start, :goal
+  attr_reader :state
+  attr        :successors
+  attr        :open_list
+  attr        :closed_list
+
+  SEARCH_STATE_NOT_INITIALIZED = 0
+  SEARCH_STATE_SEARCHING = 1
+  SEARCH_STATE_SUCCEEDED = 2
+  SEARCH_STATE_FAILED    = 3
+
+  def open_list
+    puts "Open List:"
+    @open_list.each { |n|
+      p n
+    }
+    puts "Closed List # of nodes: #{@open_list.size}"
+  end
+
+  def closed_list
+    puts "Closed List:"
+    @closed_list.each { |n|
+      p n
+    }
+    puts "Closed List # of nodes: #{@closed_list.size}"
+  end
+
+
+  class Node
+    attr_accessor :parent, :child
+    attr_accessor :h, :g, :f
+    
+    attr_reader :info
+
+    def <=>(b)
+      return -1 if @f > b.f
+      return  0 if @f == b.f
+      return  1
+    end
+
+    def inspect
+      "AStarNode: #{@f} = #{@g} + #{@h} #{@info.inspect}"
+    end
+
+    def initialize( info = nil )
+      @h = @g = @f = 0.0
+      @info = info
+    end
+  end
+
+  # sets start and end goals and initializes A* search
+  def goals( start, goal )
+    @start = Node.new( start )
+    @start.g    = 0.0
+    @start.h    = start.distance_estimate( goal )
+    @start.f    = @start.h
+
+    @open_list  = []
+    @open_list.push( @start )
+    @closed_list = []
+
+    @goal  = Node.new( goal )
+    
+    @state = SEARCH_STATE_SEARCHING
+  end
+
+  # Advances one search step
+  def search_step
+    if @open_list.empty?
+      @state = SEARCH_STATE_FAILED
+      return @state
+    end
+
+    # Pop the best node (the one with the lowest f)
+    n = @open_list.pop
+
+    # Check for the goal.  Once we pop that, we are done
+    if n.info.is_goal?( @goal.info )
+      # The user is going to use the Goal Node he passed in 
+      # so copy the parent pointer of n 
+      @goal.parent = n.parent
+      # Special case is that the goal was passed in as the start state
+      # so handle that here
+      if n != @start
+	child  = @goal
+	parent = @goal.parent
+
+	while child != @start
+	  parent.child = child
+	  child = parent
+	  parent = parent.parent
+	end
+      end
+      @state = SEARCH_STATE_SUCCEEDED
+      return @state
+    else
+      # Not goal, get successors
+      n.info.successors( self, n.parent )
+      @successors.each { |s|
+	newg = n.g + n.info.cost( s.info )
+
+	# Now, we need to find out if this node is on the open or close lists
+	# If it is, but the node that is already on them is better (lower g)
+	# then we can forget about this successor
+	open = @open_list.find { |e| e.info.is_same?( s.info ) }
+	# State in open list is cheaper than this successor
+	next if open and open.g <= newg
+
+	closed = @closed_list.find { |e| e.info.is_same?( s.info ) }
+	# We found a cheaper state in closed list
+	next if closed and closed.g <= newg
+	
+	# This node is the best node so far so let's keep it and set up
+	# its A* specific data
+	s.parent = n
+	s.g = newg
+	s.h = s.info.distance_estimate( @goal.info )
+	s.f = s.g + s.h
+
+	# Remove succesor from closed list if it was on it
+	@closed_list.delete(closed) if closed
+	# Remove succesor from open list if it was on it
+	@open_list.delete(open) if open
+	@open_list.push(s)
+	# Make sure open list stays sorted based on f
+	@open_list.sort!
+      }
+      @closed_list.push(n)
+      @successors.clear
+    end
+    return @state
+  end
+
+  def add_successor( info )
+    @successors << Node.new(info)
+  end
+
+  # return solution as an path (ie. an array of [x,y] coordinates)
+  def path
+    p = []
+    curr = @start
+    while curr
+      p << [curr.info.x, curr.info.y]
+      curr = curr.child
+    end
+    return p
+  end
+
+  def initialize
+    @state = SEARCH_STATE_NOT_INITIALIZED
+    @successors = []
+  end
+end
+
+
+#
+# Simple class used as a
+#
+class MapNode
+  attr_reader :x, :y
+  @@pmap = nil
+
+  def self.map(pmap)
+    @@pmap = pmap
+  end
+
+  def initialize(x, y)
+    @x = x
+    @y = y
+  end
+
+  def is_same?(node)
+    return true  if node and @x == node.x and @y == node.y
+    return false
+  end
+
+  def is_goal?( goal )
+    return true  if @x == goal.x and @y == goal.y
+    return false
+  end
+
+  def distance_estimate( goal )
+    dx = @x - goal.x
+    dy = @y - goal.y
+    return dx*dx + dy*dy
+  end
+
+  MAX_SCALE = 9
+
+  def get_map(x, y)
+    if x < 0 or y < 0 or x >= @@pmap.size or y >= @@pmap[0].size
+      return MAX_SCALE
+    else
+      t = @@pmap[x][y]
+      return MAX_SCALE   if t.kind_of?(Room)
+      return MAX_SCALE-1 if t.kind_of?(Connection)
+      return 1
+    end
+  end
+
+  def successors( astar, parent = nil )
+    info = nil
+    info = parent.info if parent
+    Room::DIR_TO_VECTOR.each_value { |x, y|
+      new_node = MapNode.new(@x + x, @y + y)
+      if get_map( new_node.x, new_node.y ) < MAX_SCALE and 
+	  not new_node.is_same?(info)
+	astar.add_successor(new_node)
+      end
+    }
+  end
+
+  def inspect
+    "pos: #{@x}, #{@y}"
+  end
+
+  def to_s
+    inspect
+  end
+
+  def cost( successor )
+    g  = get_map(@x,@y)
+
+#     dx = (@x - successor.x).abs
+#     dy = (@y - successor.y).abs
+#     if dx + dy == 1
+#        g += 0   # straight move
+#      else
+#        g += 4  # diagonal move
+#     end
+    return g
+  end
+
+end

data/lib/IFMapper/FXConnection.rb

@@ -55,27 +55,27 @@ class FXConnection < Connection
     [ @selected, @type, @dir, @roomA, @roomB, @exitAtext, @exitBtext ]
   end
 
+  #
+  # Change selection state of connection.  If Connection Properties
+  # window is open, copy the connection data to it.
+  #
   def selected=(value)
-    if value and @@win
-      @@win.copy_from(self)
-    end
+    @@win.copy_from(self) if value and @@win
     @selected = value
   end
 
+  #
+  # Change direction of connection
+  #
   def toggle_direction
     # If a self-loop, we cannot change dir
-    if @roomA == @roomB
-      return if @roomA.exits.index(self) ==  @roomA.exits.rindex(self)
-    end
+    return if @roomA == @roomB and
+      @roomA.exits.index(self) == @roomA.exits.rindex(self)
 
     @dir += 1
-    if @dir > BtoA
-      @dir = BOTH
-    end
+    @dir = BOTH if @dir > BtoA
 
-    if @@win
-      @@win.copy_from(self)
-    end
+    @@win.copy_from(self) if @@win
   end
 
   #
@@ -107,6 +107,75 @@ class FXConnection < Connection
     end
   end
 
+  #
+  # Main draw function
+  #
+  def draw(dc, zoom, opt)
+    if @selected
+      dc.foreground = 'yellow'
+    elsif @failed
+      dc.foreground = 'red'
+    else
+      dc.foreground = opt['Arrow Color']
+    end
+
+    draw_exit_text(dc, zoom)
+    if @type == SPECIAL
+      dc.lineStyle = LINE_ONOFF_DASH
+    else
+      dc.lineStyle = LINE_SOLID
+    end
+    if pts.size > 0
+      draw_complex(dc, zoom, opt)
+    else
+      draw_simple(dc, zoom)
+    end
+  end
+
+
+  def properties(map, event = nil)
+    if not @@win
+      @@win = FXConnectionDialogBox.new(map, self, event)
+    else
+      @@win.map = map
+    end
+    @@win.copy_from(self)
+    @@win.show
+    return
+  end
+
+  protected
+
+  RAD_45 = 45 * Math::PI / 180
+  SIN_45 = Math.sin(RAD_45)
+  COS_45 = Math.cos(RAD_45)
+
+  def _arrow_info( x1, y1, x2, y2, zoom = 1.0 )
+    pt1  = []
+    dir = 0
+    if    @dir == AtoB 
+      dir = @roomB.exits.rindex(self)
+      pt1 = [ x2, y2 ]
+    else
+      dir = @roomA.exits.index(self)
+      pt1 = [ x1, y1 ]
+    end
+    x, y      = Room::DIR_TO_VECTOR[dir]
+    arrow_len = 20.0 / Math.sqrt(x * x + y * y)
+    x *= arrow_len *  zoom
+    y *= arrow_len * -zoom
+
+    d = [
+      x * COS_45 + y * SIN_45,
+      x * SIN_45 - y * COS_45
+    ]
+    return pt1, d
+  end
+
+
+  #
+  # Draw a complex connection as a line path
+  #
   def draw_complex_as_lines(dc, zoom)
     p = []
     @pts.each { |pt|
@@ -116,6 +185,9 @@ class FXConnection < Connection
     return p
   end
 
+  #
+  # Draw a complex connection as a bspline path
+  #
   def draw_complex_as_bspline(dc, zoom)
     p = []
     p << [ @pts[0][0] * zoom, @pts[0][1] * zoom ]
@@ -130,6 +202,9 @@ class FXConnection < Connection
     return dc.drawBSpline( p )
   end
 
+  #
+  # Draw a complex connection
+  #
   def draw_complex(dc, zoom, opt)
     if opt['Paths as Curves']
       p = draw_complex_as_bspline(dc, zoom)
@@ -142,6 +217,10 @@ class FXConnection < Connection
     draw_arrow(dc, zoom, x1, y1, x2, y2)
   end
 
+  #
+  # Draw a simple connection.  Simple connections are straight
+  # line connections or 'stub' connections.
+  #
   def draw_simple(dc, zoom)
     dir    = @roomA.exits.index(self)
     x1, y1 = @roomA.corner(self, zoom, dir)
@@ -157,6 +236,7 @@ class FXConnection < Connection
 	dc.drawLine(x1, y1, x2, y2)
       end
     else
+      # Complex connection in progress or "stub" exit
       v = FXRoom::DIR_TO_VECTOR[dir]
       x2, y2 = [ @roomA.x + v[0] * 0.5, @roomA.y + v[1] * 0.5 ]
       x2 *= WW * zoom
@@ -167,33 +247,10 @@ class FXConnection < Connection
     end
   end
 
-  RAD_45 = 45 * Math::PI / 180
-  SIN_45 = Math.sin(RAD_45)
-  COS_45 = Math.cos(RAD_45)
-
-  def _arrow_info( x1, y1, x2, y2, zoom = 1.0 )
-    pt1  = []
-    dir = 0
-    if    @dir == AtoB 
-      dir = @roomB.exits.rindex(self)
-      pt1 = [ x2, y2 ]
-    else
-      dir = @roomA.exits.index(self)
-      pt1 = [ x1, y1 ]
-    end
-    x, y      = Room::DIR_TO_VECTOR[dir]
-    arrow_len = 20.0 / Math.sqrt(x * x + y * y)
-    x *= arrow_len *  zoom
-    y *= arrow_len * -zoom
-
-    d = [
-      x * COS_45 + y * SIN_45,
-      x * SIN_45 - y * COS_45
-    ]
-    return pt1, d
-  end
-
 
+  #
+  # Draw an arrow at one end of the path
+  #
   def draw_arrow( dc, zoom, x1, y1, x2, y2 )
     return if @dir == BOTH
     pt1, d = _arrow_info( x1, y1, x2, y2, zoom )
@@ -208,6 +265,9 @@ class FXConnection < Connection
     dc.fillPolygon(p)
   end
 
+  #
+  # Draw the connection text next to the arrow ('I', 'O', etc)
+  #
   def draw_text(dc, zoom, x, y, dir, text, arrow)
     if dir == 7 or dir < 6 and dir != 1
       if arrow and (dir == 0 or dir == 4)
@@ -230,6 +290,9 @@ class FXConnection < Connection
     dc.drawText(x, y, text)
   end
 
+  #
+  # Draw any exit text if available (exit text is 'U', 'D', 'I', 'O', etc)
+  #
   def draw_exit_text(dc, zoom)
     if @exitAtext != 0
       dir  = @roomA.exits.index(self)
@@ -245,39 +308,5 @@ class FXConnection < Connection
     end
   end
 
-  def draw(dc, zoom, opt)
-    if @selected
-      dc.foreground = 'yellow'
-    elsif @failed
-      dc.foreground = 'red'
-    else
-      dc.foreground = opt['Arrow Color']
-    end
-
-    draw_exit_text(dc, zoom)
-    if @type == SPECIAL
-      dc.lineStyle = LINE_ONOFF_DASH
-    else
-      dc.lineStyle = LINE_SOLID
-    end
-    if pts.size > 0
-      draw_complex(dc, zoom, opt)
-    else
-      draw_simple(dc, zoom)
-    end
-  end
-
-
-  def properties(map, event = nil)
-    if not @@win
-      @@win = FXConnectionDialogBox.new(map, self, event)
-    else
-      @@win.map = map
-    end
-    @@win.copy_from(self)
-    @@win.show
-    return
-  end
-
 end