doxygen: intern/boolop tagged
[blender.git] / intern / boolop / intern / BOP_Segment.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file boolop/intern/BOP_Segment.h
29  *  \ingroup boolopintern
30  */
31
32  
33 #ifndef BOP_SEGMENT_H
34 #define BOP_SEGMENT_H
35
36 #include "BOP_Indexs.h"
37 #include <iostream>
38 using namespace std;
39
40 class BOP_Segment
41 {
42 private:
43         int getEdgeBetween(unsigned int v1, unsigned int v2);
44         bool isOnEdge(unsigned int v, unsigned int e);
45
46 public:
47         // Cfg : Configuration of the vertices
48         // Values:
49         //         20 IN,
50         //         1X Intersected edge X{1,2,3} of the face,
51         //         0X Coincident vertice X{1,2,3} of the face,
52         //         0 otherwise
53         unsigned int m_cfg1, m_cfg2; 
54         BOP_Index m_v1, m_v2;     // if cfgX >0, vX is the vertice index of the face
55         BOP_Segment();
56
57         static bool isIn(unsigned int cfg);
58         static bool isEdge(unsigned int cfg);
59         static bool isVertex(unsigned int cfg);
60         static bool isDefined(unsigned int cfg);
61         static bool isUndefined(unsigned int cfg);
62         static unsigned int getEdge(unsigned int cfg);
63         static BOP_Index getVertex(unsigned int cfg);
64         static unsigned int createEdgeCfg(unsigned int edge);
65         static unsigned int createVertexCfg(BOP_Index vertex);
66         static unsigned int createInCfg();
67         static unsigned int createUndefinedCfg();
68         void invert();  
69         void sort();
70         unsigned int getConfig();
71
72         friend   ostream &operator<<(ostream &stream, const BOP_Segment &c);
73 };
74
75 #endif