summaryrefslogtreecommitdiffstats
path: root/src/3rdparty/adaptagrams/libavoid/vertices.h
blob: aac43bb4c31e5839ab0d354b1beb2baec47b43dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/*
 * vim: ts=4 sw=4 et tw=0 wm=0
 *
 * libavoid - Fast, Incremental, Object-avoiding Line Router
 *
 * Copyright (C) 2004-2013  Monash University
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * See the file LICENSE.LGPL distributed with the library.
 *
 * Licensees holding a valid commercial license may use this file in
 * accordance with the commercial license agreement provided with the 
 * library.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
 *
 * Author(s):   Michael Wybrow
*/


#ifndef AVOID_VERTICES_H
#define AVOID_VERTICES_H

#include <list>
#include <set>
#include <map>
#include <iostream>
#include <cstdio>
#include <utility>

#include "libavoid/geomtypes.h"

namespace Avoid {

class EdgeInf;
class VertInf;
class Router;

typedef std::list<EdgeInf *> EdgeInfList;
typedef std::pair<VertInf *, VertInf *> VertexPair;

typedef unsigned int ConnDirFlags;
typedef unsigned short VertIDProps;


class VertID
{
    public:
        unsigned int objID;
        unsigned short vn;
        // Properties:
        VertIDProps props;

        static const unsigned short src;
        static const unsigned short tar;
        
        static const VertIDProps PROP_ConnPoint;
        static const VertIDProps PROP_OrthShapeEdge;
        static const VertIDProps PROP_ConnectionPin;
        static const VertIDProps PROP_ConnCheckpoint;
        static const VertIDProps PROP_DummyPinHelper;

        VertID();
        VertID(unsigned int id, unsigned short n, VertIDProps p = 0);
        VertID(const VertID& other);
        VertID& operator= (const VertID& rhs);
        bool operator==(const VertID& rhs) const;
        bool operator!=(const VertID& rhs) const;
        bool operator<(const VertID& rhs) const;
        VertID operator+(const int& rhs) const;
        VertID operator-(const int& rhs) const;
        VertID& operator++(int);
        void print(FILE *file = stdout) const;
        void db_print(void) const;
        friend std::ostream& operator<<(std::ostream& os, const VertID& vID);
        
        // Property tests:
        inline bool isOrthShapeEdge(void) const
        {
            return (props & PROP_OrthShapeEdge) ? true : false;
        }
        inline bool isConnPt(void) const
        {
            return (props & PROP_ConnPoint) ? true : false;
        }
        inline bool isConnectionPin(void) const
        {
            return (props & PROP_ConnectionPin) ? true : false;
        }
        inline bool isConnCheckpoint(void) const
        {
            return (props & PROP_ConnCheckpoint) ? true : false;
        }
        inline bool isDummyPinHelper(void) const
        {
            return (props & PROP_DummyPinHelper) ? true : false;
        }
};


// An ID given to all dummy vertices inserted to allow creation of the
// orthogonal visibility graph since the vertices in the orthogonal graph 
// mostly do not correspond to shape corners or connector endpoints.
//
static const VertID dummyOrthogID(0, 0);
static const VertID dummyOrthogShapeID(0, 0, VertID::PROP_OrthShapeEdge);

class ANode;

class VertInf
{
    public:
        VertInf(Router *router, const VertID& vid, const Point& vpoint,
                const bool addToRouter = true);
        ~VertInf();
        void Reset(const VertID& vid, const Point& vpoint);
        void Reset(const Point& vpoint);
        void removeFromGraph(const bool isConnVert = true);
        bool orphaned(void);

        unsigned int pathLeadsBackTo(const VertInf *start) const;
        void setVisibleDirections(const ConnDirFlags directions);
        ConnDirFlags directionFrom(const VertInf *other) const;
        // Checks if this vertex has the target as a visibility neighbour.
        EdgeInf *hasNeighbour(VertInf *target, bool orthogonal) const;
        void orphan(void);

        VertInf **makeTreeRootPointer(VertInf *root);
        VertInf *treeRoot(void) const;
        VertInf **treeRootPointer(void) const;
        void setTreeRootPointer(VertInf **pointer);
        void clearTreeRootPointer(void);

        void setSPTFRoot(VertInf *root);
        VertInf *sptfRoot(void) const;

        Router *_router;
        VertID id;
        Point  point;
        VertInf *lstPrev;
        VertInf *lstNext;
        VertInf *shPrev;
        VertInf *shNext;
        EdgeInfList visList;
        unsigned int visListSize;
        EdgeInfList orthogVisList;
        unsigned int orthogVisListSize;
        EdgeInfList invisList;
        unsigned int invisListSize;
        VertInf *pathNext;

        // The tree root and distance value used when computing MTSTs.
        // XXX: Maybe these should be allocated as a separate struct
        //      and referenced via a pointer.  This would be slower due
        //      to memory allocation, but would save 2 x 8 = 24 bytes per 
        //      VertInf on 64-bit machines.
        VertInf *m_orthogonalPartner;
        VertInf **m_treeRoot;
        double sptfDist;

        ConnDirFlags visDirections;
        std::list<ANode *> aStarDoneNodes;
        std::list<ANode *> aStarPendingNodes;
        // Flags for orthogonal visibility properties, i.e., whether the 
        // line points to a shape edge, connection point or an obstacle.
        unsigned int orthogVisPropFlags;
};


// Orthogonal visibility property flags
static const unsigned int XL_EDGE = 1;
static const unsigned int XL_CONN = 2;
static const unsigned int XH_EDGE = 4;
static const unsigned int XH_CONN = 8;
static const unsigned int YL_EDGE = 16;
static const unsigned int YL_CONN = 32;
static const unsigned int YH_EDGE = 64;
static const unsigned int YH_CONN = 128;


bool directVis(VertInf *src, VertInf *dst);


// A linked list of all the vertices in the router instance.  All the 
// connector endpoints are listed first, then all the shape vertices.
// Dummy vertices inserted for orthogonal routing are classed as shape
// vertices but have VertID(0, 0).
//
class VertInfList
{
    public:
        VertInfList();
        void addVertex(VertInf *vert);
        VertInf *removeVertex(VertInf *vert);
        VertInf *getVertexByID(const VertID& id);
        VertInf *getVertexByPos(const Point& p);
        VertInf *shapesBegin(void);
        VertInf *connsBegin(void);
        VertInf *end(void);
        unsigned int connsSize(void) const;
        unsigned int shapesSize(void) const;
    private:
        VertInf *_firstShapeVert;
        VertInf *_firstConnVert;
        VertInf *_lastShapeVert;
        VertInf *_lastConnVert;
        unsigned int _shapeVertices;
        unsigned int _connVertices;
};


typedef std::set<unsigned int> ShapeSet;
typedef std::map<VertID, ShapeSet> ContainsMap;


}


#endif