Merge branch 'master' into blender2.8
[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 /* Shrinkwrap stuff */
35 #include "BKE_bvhutils.h"
36
37 /*
38  * Shrinkwrap is composed by a set of functions and options that define the type of shrink.
39  *
40  * 3 modes are available:
41  *    - Nearest vertex
42  *        - Nearest surface
43  *    - Normal projection
44  *
45  * ShrinkwrapCalcData encapsulates all needed data for shrinkwrap functions.
46  * (So that you don't have to pass an enormous amount of arguments to functions)
47  */
48
49 struct Object;
50 struct DerivedMesh;
51 struct Mesh;
52 struct MVert;
53 struct MDeformVert;
54 struct ModifierEvalContext;
55 struct ShrinkwrapModifierData;
56 struct BVHTree;
57 struct SpaceTransform;
58
59
60 typedef struct ShrinkwrapCalcData {
61         ShrinkwrapModifierData *smd;    //shrinkwrap modifier data
62
63         struct Object *ob;              //object we are applying shrinkwrap to
64
65         struct MVert *vert;             //Array of verts being projected (to fetch normals or other data)
66         float (*vertexCos)[3];          //vertexs being shrinkwraped
67         int numVerts;
68
69         struct MDeformVert *dvert;      //Pointer to mdeform array
70         int vgroup;                     //Vertex group num
71         bool invert_vgroup;             /* invert vertex group influence */
72
73         struct Mesh *target;     //mesh we are shrinking to
74         struct SpaceTransform local2target;    //transform to move between local and target space
75
76         float keepDist;                 //Distance to keep above target surface (units are in local space)
77
78 } ShrinkwrapCalcData;
79
80 void shrinkwrapModifier_deform(struct ShrinkwrapModifierData *smd, struct Object *ob, struct Mesh *mesh,
81                                float (*vertexCos)[3], int numVerts, const struct ModifierEvalContext *ctx);
82
83 /*
84  * This function casts a ray in the given BVHTree.. but it takes into consideration the space_transform, that is:
85  *
86  * if transf was configured with "SPACE_TRANSFORM_SETUP( &transf,  ob1, ob2 )"
87  * then the input (vert, dir, BVHTreeRayHit) must be defined in ob1 coordinates space
88  * and the BVHTree must be built in ob2 coordinate space.
89  *
90  * Thus it provides an easy way to cast the same ray across several trees
91  * (where each tree was built on its own coords space)
92  */
93 bool BKE_shrinkwrap_project_normal(
94         char options, const float vert[3], const float dir[3], const float ray_radius,
95         const struct SpaceTransform *transf, BVHTree *tree, BVHTreeRayHit *hit,
96         BVHTree_RayCastCallback callback, void *userdata);
97
98 /*
99  * NULL initializers to local data
100  */
101 #define NULL_ShrinkwrapCalcData {NULL, }
102 #define NULL_BVHTreeFromMesh    {NULL, }
103 #define NULL_BVHTreeRayHit      {NULL, }
104 #define NULL_BVHTreeNearest     {0, }
105
106 #endif  /* __BKE_SHRINKWRAP_H__ */