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