d1fef8b0ce11186456156d3c3b2278bf79b31eb0
[blender.git] / source / blender / blenkernel / BKE_shrinkwrap.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) Blender Foundation.
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_SHRINKWRAP_H
28 #define BKE_SHRINKWRAP_H
29
30 /** \file BKE_shrinkwrap.h
31  *  \ingroup bke
32  */
33
34 /* mesh util */
35
36 //TODO: move this somewhere else
37 #include "BKE_customdata.h"
38 struct DerivedMesh;
39 struct Object;
40 struct DerivedMesh *object_get_derived_final(struct Object *ob);
41
42
43 /* SpaceTransform stuff */
44 /*
45  * TODO: move this somewhere else
46  *
47  * this structs encapsulates all needed data to convert between 2 coordinate spaces
48  * (where conversion can be represented by a matrix multiplication)
49  *
50  * This is used to reduce the number of arguments to pass to functions that need to perform
51  * this kind of operation and make it easier for the coder, as he/she doenst needs to recode
52  * the matrix calculation.
53  *
54  * A SpaceTransform is initialized using:
55  *   space_transform_setup( &data,  ob1, ob2 )
56  *
57  * After that the following calls can be used:
58  *   space_transform_apply (&data, co); //converts a coordinate in ob1 coords space to the corresponding ob2 coords
59  *   space_transform_invert(&data, co); //converts a coordinate in ob2 coords space to the corresponding ob1 coords
60  *
61  *      //Same Concept as space_transform_apply and space_transform_invert, but no is normalized after conversion
62  *   space_transform_apply_normal (&data, &no);
63  *   space_transform_invert_normal(&data, &no);
64  *
65  */
66 struct Object;
67
68 typedef struct SpaceTransform
69 {
70         float local2target[4][4];
71         float target2local[4][4];
72
73 } SpaceTransform;
74
75 void space_transform_from_matrixs(struct SpaceTransform *data, float local[4][4], float target[4][4]);
76 void space_transform_apply(const struct SpaceTransform *data, float *co);
77 void space_transform_invert(const struct SpaceTransform *data, float *co);
78
79 #define space_transform_setup(data, local, target) space_transform_from_matrixs(data, (local)->obmat, (target)->obmat)
80
81 /* Shrinkwrap stuff */
82 #include "BKE_bvhutils.h"
83
84 /*
85  * Shrinkwrap is composed by a set of functions and options that define the type of shrink.
86  *
87  * 3 modes are available:
88  *    - Nearest vertex
89  *        - Nearest surface
90  *    - Normal projection
91  *
92  * ShrinkwrapCalcData encapsulates all needed data for shrinkwrap functions.
93  * (So that you dont have to pass an enormous amount of arguments to functions)
94  */
95
96 struct Object;
97 struct Scene;
98 struct DerivedMesh;
99 struct MVert;
100 struct MDeformVert;
101 struct ShrinkwrapModifierData;
102 struct MDeformVert;
103 struct BVHTree;
104
105
106 typedef struct ShrinkwrapCalcData
107 {
108         ShrinkwrapModifierData *smd;    //shrinkwrap modifier data
109
110         struct Object *ob;                              //object we are applying shrinkwrap to
111
112         struct MVert *vert;                                     //Array of verts being projected (to fetch normals or other data)
113         float (*vertexCos)[3];                  //vertexs being shrinkwraped
114         int numVerts;
115
116         struct MDeformVert* dvert;                      //Pointer to mdeform array
117         int vgroup;                                             //Vertex group num
118
119         struct DerivedMesh *target;             //mesh we are shrinking to      
120         SpaceTransform local2target;    //transform to move between local and target space
121
122         float keepDist;                                 //Distance to keep above target surface (units are in local space)
123
124 } ShrinkwrapCalcData;
125
126 void shrinkwrapModifier_deform(struct ShrinkwrapModifierData *smd, struct Object *ob, struct DerivedMesh *dm, float (*vertexCos)[3], int numVerts);
127
128 /*
129  * This function casts a ray in the given BVHTree.. but it takes into consideration the space_transform, that is:
130  *
131  * if transf was configured with "space_transform_setup( &transf,  ob1, ob2 )"
132  * then the input (vert, dir, BVHTreeRayHit) must be defined in ob1 coordinates space
133  * and the BVHTree must be built in ob2 coordinate space.
134  *
135  * Thus it provides an easy way to cast the same ray across several trees (where each tree was built on its own coords space)
136  */
137 int normal_projection_project_vertex(char options, const float *vert, const float *dir, const SpaceTransform *transf, BVHTree *tree, BVHTreeRayHit *hit, BVHTree_RayCastCallback callback, void *userdata);
138
139 /*
140  * NULL initializers to local data
141  */
142 #define NULL_ShrinkwrapCalcData {NULL, }
143 #define NULL_BVHTreeFromMesh    {NULL, }
144 #define NULL_BVHTreeRayHit              {NULL, }
145 #define NULL_BVHTreeNearest             {0, }
146
147
148 #endif
149