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