merge with 2.5 (not trunk, last merge message said that on accident) at r22252
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #include "CSG_BooleanOps.h"
33
34 /**
35  * Internal mesh structure.
36  * Safe to copy by value... hopefully.
37  */
38
39 struct Base;
40 struct Object;
41 struct CSG_MeshDescriptor;
42
43 typedef void (*CSG_DestroyMeshFunc)(struct CSG_MeshDescriptor *);
44
45 typedef struct CSG_MeshDescriptor {
46         struct Base *base; // Ptr to base of original blender object - used in creating a new object
47         CSG_MeshPropertyDescriptor m_descriptor;
48         CSG_FaceIteratorDescriptor m_face_iterator;
49         CSG_VertexIteratorDescriptor m_vertex_iterator;
50         CSG_DestroyMeshFunc m_destroy_func;
51 } CSG_MeshDescriptor;
52
53
54 extern
55         int
56 CSG_LoadBlenderMesh(
57         struct Object * obj,
58         CSG_MeshDescriptor *output
59 );
60
61 /**
62  * Destroy the contents of a mesh descriptor.
63  * If the internal descriptor refers to a blender
64  * mesh, no action is performed apart from freeing
65  * internal memory in the desriptor.
66  */
67
68 extern
69         void
70 CSG_DestroyMeshDescriptor(
71         CSG_MeshDescriptor *mesh
72 );
73
74 /**
75  * Perform a boolean operation between 2 meshes and return the 
76  * result as a new mesh descriptor.
77  * op_type is an integer code of the boolean operation type.
78  * 1 = intersection,
79  * 2 = union,
80  * 3 = difference.
81  */
82
83 extern
84         int 
85 CSG_PerformOp(
86         CSG_MeshDescriptor *mesh1,
87         CSG_MeshDescriptor *mesh2,
88         int op_type,
89         CSG_MeshDescriptor *output
90 );
91
92
93
94 /**
95  * Add a mesh to blender as a new object.
96  */
97
98 extern
99         int
100 CSG_AddMeshToBlender(
101         CSG_MeshDescriptor *mesh
102 );
103
104 /**
105  * Test functionality.
106  */
107
108 extern
109         int
110 NewBooleanMeshTest(
111         struct Base * base,
112         struct Base * base_select,
113         int op_type
114 );
115
116 #endif
117