[#34013] [video sequence editor] Offset and crop of strips are wrong
[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         float local2target[4][4];
70         float target2local[4][4];
71
72 } SpaceTransform;
73
74 void space_transform_from_matrixs(struct SpaceTransform *data, float local[4][4], float target[4][4]);
75 void space_transform_apply(const struct SpaceTransform *data, float co[3]);
76 void space_transform_invert(const struct SpaceTransform *data, float co[3]);
77
78 #define SPACE_TRANSFORM_SETUP(data, local, target) space_transform_from_matrixs(data, (local)->obmat, (target)->obmat)
79
80 /* Shrinkwrap stuff */
81 #include "BKE_bvhutils.h"
82
83 /*
84  * Shrinkwrap is composed by a set of functions and options that define the type of shrink.
85  *
86  * 3 modes are available:
87  *    - Nearest vertex
88  *        - Nearest surface
89  *    - Normal projection
90  *
91  * ShrinkwrapCalcData encapsulates all needed data for shrinkwrap functions.
92  * (So that you don't have to pass an enormous amount of arguments to functions)
93  */
94
95 struct Object;
96 struct Scene;
97 struct DerivedMesh;
98 struct MVert;
99 struct MDeformVert;
100 struct ShrinkwrapModifierData;
101 struct MDeformVert;
102 struct BVHTree;
103
104
105 typedef struct ShrinkwrapCalcData {
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 Object *ob, struct DerivedMesh *dm,
125                                float (*vertexCos)[3], int numVerts);
126
127 /*
128  * This function casts a ray in the given BVHTree.. but it takes into consideration the space_transform, that is:
129  *
130  * if transf was configured with "SPACE_TRANSFORM_SETUP( &transf,  ob1, ob2 )"
131  * then the input (vert, dir, BVHTreeRayHit) must be defined in ob1 coordinates space
132  * and the BVHTree must be built in ob2 coordinate space.
133  *
134  * Thus it provides an easy way to cast the same ray across several trees
135  * (where each tree was built on its own coords space)
136  */
137 int normal_projection_project_vertex(char options, const float vert[3], const float dir[3],
138                                      const SpaceTransform *transf, BVHTree *tree, BVHTreeRayHit *hit,
139                                      BVHTree_RayCastCallback callback, void *userdata);
140
141 /*
142  * NULL initializers to local data
143  */
144 #define NULL_ShrinkwrapCalcData {NULL, }
145 #define NULL_BVHTreeFromMesh    {NULL, }
146 #define NULL_BVHTreeRayHit      {NULL, }
147 #define NULL_BVHTreeNearest     {0, }
148
149 #endif  /* __BKE_SHRINKWRAP_H__ */