doxygen: intern/boolop tagged
[blender.git] / intern / boolop / intern / BOP_BSPNode.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_BSPNode.h
29  *  \ingroup boolopintern
30  */
31
32  
33 #ifndef BOP_BSPNODE_H
34 #define BOP_BSPNODE_H
35
36 #include "MT_Plane3.h"
37 #include "BOP_Tag.h"
38 #include "BOP_Face.h"
39
40 typedef vector<MT_Point3> BOP_BSPPoints;
41 typedef vector<MT_Point3>::const_iterator BOP_IT_BSPPoints;
42
43 class BOP_BSPNode
44 {
45 protected:
46         BOP_BSPNode* m_inChild;
47         BOP_BSPNode* m_outChild;
48         MT_Plane3    m_plane;
49         unsigned int m_deep;
50
51 public:
52         // Construction methods
53         BOP_BSPNode(const MT_Plane3& plane);
54         ~BOP_BSPNode();
55         unsigned int addFace(const BOP_BSPPoints& pts, 
56                                                  const MT_Plane3& plane);
57         BOP_TAG classifyFace(const MT_Point3& p1, 
58                                                  const MT_Point3& p2, 
59                                                  const MT_Point3& p3, 
60                                                  const MT_Plane3& plane) const;
61         BOP_TAG simplifiedClassifyFace(const MT_Point3& p1, 
62                                                                    const MT_Point3& p2, 
63                                                                    const MT_Point3& p3, 
64                                                                    const MT_Plane3& plane) const;
65         
66 protected:
67         BOP_TAG testPoint(const MT_Point3& p) const;
68         BOP_TAG classifyFaceIN(const MT_Point3& p1, 
69                                                    const MT_Point3& p2, 
70                                                    const MT_Point3& p3, 
71                                                    const MT_Plane3& plane) const;
72         BOP_TAG classifyFaceOUT(const MT_Point3& p1, 
73                                                         const MT_Point3& p2, 
74                                                         const MT_Point3& p3, 
75                                                         const MT_Plane3& plane) const;
76         BOP_TAG simplifiedClassifyFaceIN(const MT_Point3& p1, 
77                                                                          const MT_Point3& p2, 
78                                                                          const MT_Point3& p3, 
79                                                                          const MT_Plane3& plane) const;
80         BOP_TAG simplifiedClassifyFaceOUT(const MT_Point3& p1, 
81                                                                           const MT_Point3& p2, 
82                                                                           const MT_Point3& p3, 
83                                                                           const MT_Plane3& plane) const;
84         bool hasSameOrientation(const MT_Plane3& plane) const;
85         int compChildren() const;
86         int splitTriangle(MT_Point3* res, 
87                                           const MT_Plane3& plane, 
88                                           const MT_Point3& p1, 
89                                           const MT_Point3& p2, 
90                                           const MT_Point3& p3, 
91                                           const BOP_TAG tag) const;
92
93 public:
94         // Inline acces methods
95         inline void setInChild(BOP_BSPNode* inChild) { m_inChild=inChild; };
96         inline void setOutChild(BOP_BSPNode* outChild) { m_outChild=outChild; };
97         inline BOP_BSPNode* getInChild() { return m_inChild; };
98         inline BOP_BSPNode* getOutChild() { return m_outChild; };
99         inline bool isLeaf() const { return !m_inChild && !m_outChild; };
100         inline void setPlane(const MT_Plane3& plane) {m_plane=plane;};
101         inline MT_Plane3& getPlane() { return m_plane; };
102
103         inline unsigned int getDeep() const {return m_deep;};
104         void print(unsigned int deep);
105 };
106
107 #endif