gamnit: make `SpriteSet` public so clients can use its services

[nit.git] / lib / a_star.nit

diff --git a/lib/a_star.nit b/lib/a_star.nit
index a0b1b48..db80519 100644 (file)
--- a/lib/a_star.nit
+++ b/lib/a_star.nit
@@ -14,9 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Services related to pathfinding of graphs using A*
-# A single graph may have different properties according to the `PathContext` used
+# A* pathfinding in graphs
 #
+# A single graph may have different properties according to the `PathContext` used
 #
 # Usage:
 #
@@ -90,7 +90,7 @@ class Node
        # lifetime limited to evocation of `path_to`
        private var open: Bool = false
 
-       # Main functionnality, returns path from `self` to `dest`
+       # Main functionality, returns path from `self` to `dest`
        fun path_to(dest: N, max_cost: Int, context: PathContext): nullable AStarPath[N]
        do
                return path_to_alts(dest, max_cost, context, null)
@@ -188,13 +188,21 @@ class Node
                end
        end
 
+       # Find the closest node accepted by `cond` under `max_cost`
+       fun find_closest(max_cost: Int, context: PathContext, cond: nullable TargetCondition[N]): nullable N
+       do
+               var path = path_to_alts(null, max_cost, context, cond)
+               if path == null then return null
+               return path.nodes.last
+       end
+
        # We customize the serialization process to avoid problems with recursive
        # serialization engines. These engines, such as `JsonSerializer`,
        # are at danger to serialize the graph as a very deep tree.
        # With a large graph it can cause a stack overflow.
        #
        # Instead, we serialize the nodes first and then the links.
-       redef fun core_serialize_to(serializer: Serializer)
+       redef fun core_serialize_to(serializer)
        do
                serializer.serialize_attribute("graph", graph)
        end
@@ -211,7 +219,7 @@ end
 
 # Link between two nodes and associated to a graph
 class Link
-       auto_serializable
+       serialize
 
        # Type of the nodes in `graph`
        type N: Node
@@ -265,7 +273,7 @@ class Graph[N: Node, L: Link]
        # Used to check if nodes have been searched in one pathfinding
        private var pathfinding_current_evocation: Int = 0
 
-       redef fun core_serialize_to(serializer: Serializer)
+       redef fun core_serialize_to(serializer)
        do
                serializer.serialize_attribute("nodes", nodes)
                serializer.serialize_attribute("links", links)
@@ -287,7 +295,7 @@ end
 
 # Result from path finding and a walkable path
 class AStarPath[N]
-       auto_serializable
+       serialize
 
        # Total cost of this path
        var total_cost: Int
@@ -316,8 +324,8 @@ class AStarPath[N]
 end
 
 # Context related to an evocation of pathfinding
-class PathContext
-       auto_serializable
+abstract class PathContext
+       serialize
 
        # Type of the nodes in `graph`
        type N: Node
@@ -352,7 +360,7 @@ end
 # Warning: A* is not optimize for such a case
 class ConstantPathContext
        super PathContext
-       auto_serializable
+       serialize
 
        redef fun worst_cost do return 1
        redef fun cost(l) do return 1
@@ -364,7 +372,7 @@ end
 # A `PathContext` for graphs with `WeightedLink`
 class WeightedPathContext
        super PathContext
-       auto_serializable
+       serialize
 
        redef type L: WeightedLink
 
@@ -380,7 +388,7 @@ class WeightedPathContext
                self.worst_cost = worst_cost
        end
 
-       redef var worst_cost: Int is noinit
+       redef var worst_cost is noinit
 
        redef fun cost(l) do
                return l.weight
@@ -393,15 +401,15 @@ end
 # A `Link` with a `weight`
 class WeightedLink
        super Link
-       auto_serializable
+       serialize
 
        # The `weight`, or cost, of this link
        var weight: Int
 end
 
 # Advanced path conditions with customizable accept states
-class TargetCondition[N: Node]
-       auto_serializable
+abstract class TargetCondition[N: Node]
+       serialize
 
        # Should the pathfinding accept `node` as a goal?
        fun accept(node: N): Bool is abstract