Make lattice deform safe for threading
[blender.git] / source / blender / blenkernel / BKE_lattice.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) 2001-2002 by NaN Holding BV.
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
28 #ifndef __BKE_LATTICE_H__
29 #define __BKE_LATTICE_H__
30
31 /** \file BKE_lattice.h
32  *  \ingroup bke
33  *  \author Ton Roosendaal
34  *  \since June 2001
35  */
36
37 struct Lattice;
38 struct Main;
39 struct Object;
40 struct Scene;
41 struct DerivedMesh;
42 struct BPoint;
43 struct MDeformVert;
44
45 void BKE_lattice_resize(struct Lattice *lt, int u, int v, int w, struct Object *ltOb);
46 struct Lattice *BKE_lattice_add(struct Main *bmain, const char *name);
47 struct Lattice *BKE_lattice_copy(struct Lattice *lt);
48 void BKE_lattice_free(struct Lattice *lt);
49 void BKE_lattice_make_local(struct Lattice *lt);
50 void calc_lat_fudu(int flag, int res, float *r_fu, float *r_du);
51
52 struct LatticeDeformData;
53 struct LatticeDeformData *init_latt_deform(struct Object *oblatt, struct Object *ob)
54 #ifdef __GNUC__
55 __attribute__((warn_unused_result))
56 #endif
57 ;
58 void calc_latt_deform(struct LatticeDeformData *lattice_deform_data, float co[3], float weight);
59 void end_latt_deform(struct LatticeDeformData *lattice_deform_data);
60
61 int object_deform_mball(struct Object *ob, struct ListBase *dispbase);
62 void outside_lattice(struct Lattice *lt);
63
64 void curve_deform_verts(struct Scene *scene, struct Object *cuOb, struct Object *target,
65                         struct DerivedMesh *dm, float (*vertexCos)[3],
66                         int numVerts, const char *vgroup, short defaxis);
67 void curve_deform_vector(struct Scene *scene, struct Object *cuOb, struct Object *target,
68                          float orco[3], float vec[3], float mat[3][3], int no_rot_axis);
69
70 void lattice_deform_verts(struct Object *laOb, struct Object *target,
71                           struct DerivedMesh *dm, float (*vertexCos)[3],
72                           int numVerts, const char *vgroup, float influence);
73 void armature_deform_verts(struct Object *armOb, struct Object *target,
74                            struct DerivedMesh *dm, float (*vertexCos)[3],
75                            float (*defMats)[3][3], int numVerts, int deformflag,
76                            float (*prevCos)[3], const char *defgrp_name);
77
78 float (*BKE_lattice_vertexcos_get(struct Object *ob, int *numVerts_r))[3];
79 void    BKE_lattice_vertexcos_apply(struct Object *ob, float (*vertexCos)[3]);
80 void    BKE_lattice_modifiers_calc(struct Scene *scene, struct Object *ob);
81
82 struct MDeformVert *BKE_lattice_deform_verts_get(struct Object *lattice);
83 struct BPoint *BKE_lattice_active_point_get(struct Lattice *lt);
84
85 void BKE_lattice_minmax(struct Lattice *lt, float min[3], float max[3]);
86 void BKE_lattice_center_median(struct Lattice *lt, float cent[3]);
87 void BKE_lattice_center_bounds(struct Lattice *lt, float cent[3]);
88 void BKE_lattice_translate(struct Lattice *lt, float offset[3], int do_keys);
89
90 int  BKE_lattice_index_from_uvw(struct Lattice *lt, const int u, const int v, const int w);
91 void BKE_lattice_index_to_uvw(struct Lattice *lt, const int index, int *r_u, int *r_v, int *r_w);
92
93 #endif
94