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 #include "BLI_bitmap.h"
37
38 /*
39  * Shrinkwrap is composed by a set of functions and options that define the type of shrink.
40  *
41  * 3 modes are available:
42  * - Nearest vertex
43  * - Nearest surface
44  * - Normal projection
45  *
46  * ShrinkwrapCalcData encapsulates all needed data for shrinkwrap functions.
47  * (So that you don't have to pass an enormous amount of arguments to functions)
48  */
49
50 struct Object;
51 struct Mesh;
52 struct MVert;
53 struct MDeformVert;
54 struct ModifierEvalContext;
55 struct ShrinkwrapModifierData;
56 struct BVHTree;
57 struct SpaceTransform;
58
59 /* Information about boundary edges in the mesh. */
60 typedef struct ShrinkwrapBoundaryVertData {
61         /* Average direction of edges that meet here. */
62         float direction[3];
63
64         /* Closest vector to direction that is orthogonal to vertex normal. */
65         float normal_plane[3];
66 } ShrinkwrapBoundaryVertData;
67
68 typedef struct ShrinkwrapBoundaryData {
69         /* True if the edge belongs to exactly one face. */
70         const BLI_bitmap *edge_is_boundary;
71         /* True if the looptri has any boundary edges. */
72         const BLI_bitmap *looptri_has_boundary;
73
74         /* Mapping from vertex index to boundary vertex index, or -1.
75          * Used for compact storage of data about boundary vertices. */
76         const int *vert_boundary_id;
77         unsigned int num_boundary_verts;
78
79         /* Direction data about boundary vertices. */
80         const ShrinkwrapBoundaryVertData *boundary_verts;
81 } ShrinkwrapBoundaryData;
82
83 void BKE_shrinkwrap_discard_boundary_data(struct Mesh *mesh);
84 void BKE_shrinkwrap_compute_boundary_data(struct Mesh *mesh);
85
86 /* Information about a mesh and BVH tree. */
87 typedef struct ShrinkwrapTreeData {
88         Mesh *mesh;
89
90         BVHTree *bvh;
91         BVHTreeFromMesh treeData;
92
93         float (*clnors)[3];
94         ShrinkwrapBoundaryData *boundary;
95 } ShrinkwrapTreeData;
96
97 /* Checks if the modifier needs target normals with these settings. */
98 bool BKE_shrinkwrap_needs_normals(int shrinkType, int shrinkMode);
99
100 /* Initializes the mesh data structure from the given mesh and settings. */
101 bool BKE_shrinkwrap_init_tree(struct ShrinkwrapTreeData *data, Mesh *mesh, int shrinkType, int shrinkMode, bool force_normals);
102
103 /* Frees the tree data if necessary. */
104 void BKE_shrinkwrap_free_tree(struct ShrinkwrapTreeData *data);
105
106 /* Implementation of the Shrinkwrap modifier */
107 void shrinkwrapModifier_deform(
108         struct ShrinkwrapModifierData *smd, struct Scene *scene, struct Object *ob, struct Mesh *mesh,
109         struct MDeformVert *dvert, const int defgrp_index, float (*vertexCos)[3], int numVerts);
110
111 /*
112  * This function casts a ray in the given BVHTree.. but it takes into consideration the space_transform, that is:
113  *
114  * if transf was configured with "SPACE_TRANSFORM_SETUP( &transf,  ob1, ob2 )"
115  * then the input (vert, dir, BVHTreeRayHit) must be defined in ob1 coordinates space
116  * and the BVHTree must be built in ob2 coordinate space.
117  *
118  * Thus it provides an easy way to cast the same ray across several trees
119  * (where each tree was built on its own coords space)
120  */
121 bool BKE_shrinkwrap_project_normal(
122         char options, const float vert[3], const float dir[3], const float ray_radius,
123         const struct SpaceTransform *transf, struct ShrinkwrapTreeData *tree, BVHTreeRayHit *hit);
124
125 /* Maps the point to the nearest surface, either by simple nearest, or by target normal projection. */
126 void BKE_shrinkwrap_find_nearest_surface(
127         struct ShrinkwrapTreeData *tree, struct BVHTreeNearest *nearest, float co[3], int type);
128
129 /* Computes a smooth normal of the target (if applicable) at the hit location. */
130 void BKE_shrinkwrap_compute_smooth_normal(
131         const struct ShrinkwrapTreeData *tree, const struct SpaceTransform *transform,
132         int looptri_idx, const float hit_co[3], const float hit_no[3], float r_no[3]);
133
134 /* Apply the shrink to surface modes to the given original coordinates and nearest point. */
135 void BKE_shrinkwrap_snap_point_to_surface(
136         const struct ShrinkwrapTreeData *tree, const struct SpaceTransform *transform,
137         int mode, int hit_idx, const float hit_co[3], const float hit_no[3], float goal_dist,
138         const float point_co[3], float r_point_co[3]);
139
140 /*
141  * NULL initializers to local data
142  */
143 #define NULL_ShrinkwrapCalcData {NULL, }
144 #define NULL_BVHTreeFromMesh    {NULL, }
145 #define NULL_BVHTreeRayHit      {NULL, }
146 #define NULL_BVHTreeNearest     {0, }
147
148 #endif  /* __BKE_SHRINKWRAP_H__ */