Angel 3.2
A 2D Game Prototyping Engine
Traversal.h
1 
2 // Copyright (C) 2008-2013, Shane Liesegang
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of the copyright holder nor the names of any
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 // POSSIBILITY OF SUCH DAMAGE.
29 
30 #pragma once
31 
32 #include "../Infrastructure/Common.h"
33 #include "../Infrastructure/Vector2.h"
34 #include "../AI/SpatialGraph.h"
35 
36 #include <deque>
37 
38 class SpatialGraphKDNode;
39 
40 class Traversal
41 {
42  typedef hashmap_ns::hash_map<SpatialGraphKDNode*, int> VisitedNeighborsTable;
43  typedef std::deque<SpatialGraphKDNode*> CurrentNodesQueue;
44 public:
45 
46  Traversal()
47  : _traversalInitialized(false) {}
48  virtual ~Traversal() {}
49 
50  virtual void StartTraversal( const Vector2& vStartPoint, int maxResults = -1, int maxIterations = -1 );
51  virtual bool DoNextTraversal();
52  virtual void ExecuteFullTraversal();
53 
54  virtual std::vector<Vector2>& GetResults();
55 
56 protected:
57  virtual void EvaluateNode( SpatialGraphKDNode* pNode ) = 0;
58  virtual void AddSuccessors( SpatialGraphKDNode* pCurrent);
59 
60  virtual void AddNodeToVisit( SpatialGraphKDNode* pNode );
61  virtual bool HasNodesToVist();
62  virtual SpatialGraphKDNode* PopNextNode();
63  virtual void SetVisited( SpatialGraphKDNode* pNode );
64  virtual bool WasVisited( SpatialGraphKDNode* pNode );
65  virtual void ClearAllVisited();
66 private:
67 
68  bool _traversalInitialized;
69  int _maxIterations;
70  int _numIterations;
71  int _maxResults;
72  std::vector<Vector2> _results;
73  CurrentNodesQueue _nodesToVisit;
74  VisitedNeighborsTable _visited;
75 };