Initial revision
[blender.git] / intern / bsp / intern / BSP_CSGNCMeshSplitter.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 #ifndef BSP_CSGNCMeshSplitter_h
33
34 #define BSP_CSGNCMeshSplitter_h
35
36 class BSP_MeshFragment;
37 class MT_Plane3;
38 class BSP_CSGMesh;
39
40 #include "BSP_MeshPrimitives.h"
41 #include "../extern/CSG_BooleanOps.h"
42 #include "BSP_CSGISplitter.h"
43
44
45 /**
46  * This class contains splitting functions for a CSGMesh.
47  * The atomic operation of a bsp CSG algorithm is to split 
48  * a mesh fragment (connected collection of polygons contained
49  * in a convex cell) by a plane. This class makes no attempt
50  * to maintain edge connectivity in the mesh. It just rips
51  * up the polygons. This is fine for tree building.
52  */
53
54
55 class BSP_CSGNCMeshSplitter : public BSP_CSGISplitter
56 {
57 public :
58
59         /// construction
60
61         BSP_CSGNCMeshSplitter(
62         );
63
64         BSP_CSGNCMeshSplitter(
65                 const BSP_CSGNCMeshSplitter & other
66         );
67
68         /**
69          *  @section BSP specific mesh operations.
70          * Inherited from BSP_CSGISplitter
71          */
72         
73         /**
74          * Split a mesh fragment wrt plane. Generates 3 mesh fragments,
75          * in, out and on. Only splits polygons - not edges, does not maintain
76          * connectivity information. The contents of frag are consumed by this oepration.
77          */
78                 void
79         Split(
80                 const MT_Plane3& plane,
81                 BSP_MeshFragment *frag,
82                 BSP_MeshFragment *in_frag,
83                 BSP_MeshFragment *out_frag,
84                 BSP_MeshFragment *on_frag,
85                 BSP_MeshFragment *spanning_frag
86         );
87
88         /// Split the entire mesh with respect to the plane.
89
90                 void
91         Split(
92                 BSP_CSGMesh & mesh,
93                 const MT_Plane3& plane,
94                 BSP_MeshFragment *in_frag,
95                 BSP_MeshFragment *out_frag,
96                 BSP_MeshFragment *on_frag,
97                 BSP_MeshFragment *spanning_frag
98         );
99
100         ~BSP_CSGNCMeshSplitter(
101         );
102
103 private :
104
105                 void
106         SplitImp(
107                 BSP_CSGMesh & mesh,
108                 const MT_Plane3& plane,
109                 const std::vector<BSP_FaceInd> & spanning_faces,
110                 BSP_MeshFragment *in_frag,
111                 BSP_MeshFragment *out_frag,
112                 BSP_MeshFragment *on_frag,
113                 std::vector<BSP_VertexInd> & classified_verts
114
115         );              
116
117                 void
118         SplitPolygon(
119                 const MT_Plane3 &plane,
120                 BSP_CSGMesh & mesh,
121                 BSP_FaceInd fi,
122                 BSP_FaceInd &fin,
123                 BSP_FaceInd &fout
124         );
125
126         /// Cached helpers
127
128         /// Split function responsibe for:
129         std::vector<BSP_FaceInd> m_spanning_faces;
130         std::vector<BSP_VertexInd> m_tagged_verts;
131
132         /// SplitPolygon responsible for:
133         std::vector<BSP_FaceInd> m_in_loop,m_out_loop,m_on_loop;
134
135 };
136
137
138 #endif
139