Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
wayfind.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef VSI_WAYFIND_HH
51 #define VSI_WAYFIND_HH
52 
53 //== INCLUDES =================================================================
54 #include <QRegion>
55 #include <QPolygonF>
56 #include <QPoint>
57 #include <QLinkedList>
58 
59 //== NAMESPACES ===============================================================
60 namespace VSI {
61 
62 //== FORWARDDECLARATIONS ======================================================
63 class GraphicsScene;
64 class Connection;
65 
66 //== CLASS DEFINITION =========================================================
67 
70 class WayFind {
71 
72  public:
74  WayFind (GraphicsScene *_scene);
75 
77  ~WayFind ();
78 
80  QPolygonF findWay (Connection *_conn, QPoint _from, QPoint _to);
81 
82  private:
83 
84  // Area node class
85  class Node {
86  public:
87 
88  // node direction
89  enum Type {
90  Vertical,
91  Horizontal
92  };
93 
94  Node (unsigned int _counter);
95  ~Node ();
96 
97  public:
98  // last used counter
99  unsigned int counter_;
100 
101  // current direction
102  Type type_;
103 
104  // neighbor nodes
105  Node *n_[4];
106 
107  // linked list handling
108  Node *prev_;
109  Node *next_;
110 
111  // node position
112  QPoint pos_;
113 
114  // initialized from
115  Node *from_;
116 
117  // A-Star consts
118  unsigned int g_;
119  unsigned int f_;
120  unsigned int h_;
121 
122  // node cost
123  unsigned int cost_;
124 
125  // already traversed
126  bool closed_;
127  };
128 
129  // Next position in distance _step from _pnt in direction _dir
130  QPoint validPos (unsigned int _dir, int _step, QPoint _pnt);
131 
132  // Heuristic distance from _from to _to
133  int heuristicDistance (const QPoint &_from, const QPoint &_to) const;
134 
135  // cleanup ununsed nodes
136  void cleanup ();
137 
138  private:
139 
140  GraphicsScene *scene_;
141 
142  unsigned int counter_;
143 
144  QLinkedList<Node *> nodes_;
145  QHash<QPair<int, int>, Node*> map_;
146 
147  Node *ll_;
148  QPoint oldFrom_;
149  QRegion oldReg_;
150 };
151 
152 }
153 
154 #endif
~WayFind()
Destructor.
Definition: wayfind.cc:92
WayFind(GraphicsScene *_scene)
Constructor.
Definition: wayfind.cc:82
QPolygonF findWay(Connection *_conn, QPoint _from, QPoint _to)
Finds a way from _from to _to ignoring any already existent connections from _conn.
Definition: wayfind.cc:101