Correction for own recent commit -- didn't know it's unsupported in
[blender.git] / source / blender / blenkernel / BKE_booleanops_mesh.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BKE_PyBooleanOps_h
30 #define BKE_PyBooleanOps_h
31
32 /** \file BKE_booleanops_mesh.h
33  *  \ingroup bke
34  */
35
36 #include "CSG_BooleanOps.h"
37
38 /**
39  * Internal mesh structure.
40  * Safe to copy by value... hopefully.
41  */
42
43 struct Base;
44 struct Object;
45 struct CSG_MeshDescriptor;
46
47 typedef void (*CSG_DestroyMeshFunc)(struct CSG_MeshDescriptor *);
48
49 typedef struct CSG_MeshDescriptor {
50         struct Base *base; // Ptr to base of original blender object - used in creating a new object
51         CSG_MeshPropertyDescriptor m_descriptor;
52         CSG_FaceIteratorDescriptor m_face_iterator;
53         CSG_VertexIteratorDescriptor m_vertex_iterator;
54         CSG_DestroyMeshFunc m_destroy_func;
55 } CSG_MeshDescriptor;
56
57
58 extern
59         int
60 CSG_LoadBlenderMesh(
61         struct Object * obj,
62         CSG_MeshDescriptor *output
63 );
64
65 /**
66  * Destroy the contents of a mesh descriptor.
67  * If the internal descriptor refers to a blender
68  * mesh, no action is performed apart from freeing
69  * internal memory in the desriptor.
70  */
71
72 extern
73         void
74 CSG_DestroyMeshDescriptor(
75         CSG_MeshDescriptor *mesh
76 );
77
78 /**
79  * Perform a boolean operation between 2 meshes and return the 
80  * result as a new mesh descriptor.
81  * op_type is an integer code of the boolean operation type.
82  * 1 = intersection,
83  * 2 = union,
84  * 3 = difference.
85  */
86
87 extern
88         int 
89 CSG_PerformOp(
90         CSG_MeshDescriptor *mesh1,
91         CSG_MeshDescriptor *mesh2,
92         int op_type,
93         CSG_MeshDescriptor *output
94 );
95
96
97
98 /**
99  * Add a mesh to blender as a new object.
100  */
101
102 extern
103         int
104 CSG_AddMeshToBlender(
105         CSG_MeshDescriptor *mesh
106 );
107
108 /**
109  * Test functionality.
110  */
111
112 extern
113         int
114 NewBooleanMeshTest(
115         struct Base * base,
116         struct Base * base_select,
117         int op_type
118 );
119
120 #endif
121