doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_lattice.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_LATTICE_H__
21 #define __BKE_LATTICE_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #include "BLI_compiler_attrs.h"
28
29 struct BPoint;
30 struct Depsgraph;
31 struct Lattice;
32 struct MDeformVert;
33 struct Main;
34 struct Mesh;
35 struct Object;
36 struct Scene;
37 struct bGPDstroke;
38
39 void BKE_lattice_resize(struct Lattice *lt, int u, int v, int w, struct Object *ltOb);
40 void BKE_lattice_init(struct Lattice *lt);
41 struct Lattice *BKE_lattice_add(struct Main *bmain, const char *name);
42 void BKE_lattice_copy_data(struct Main *bmain, struct Lattice *lt_dst, const struct Lattice *lt_src, const int flag);
43 struct Lattice *BKE_lattice_copy(struct Main *bmain, const struct Lattice *lt);
44 void BKE_lattice_free(struct Lattice *lt);
45 void BKE_lattice_make_local(struct Main *bmain, struct Lattice *lt, const bool lib_local);
46 void calc_lat_fudu(int flag, int res, float *r_fu, float *r_du);
47
48 struct LatticeDeformData *init_latt_deform(struct Object *oblatt, struct Object *ob) ATTR_WARN_UNUSED_RESULT;
49 void calc_latt_deform(struct LatticeDeformData *lattice_deform_data, float co[3], float weight);
50 void end_latt_deform(struct LatticeDeformData *lattice_deform_data);
51
52 bool object_deform_mball(struct Object *ob, struct ListBase *dispbase);
53 void outside_lattice(struct Lattice *lt);
54
55 void curve_deform_verts(
56         struct Object *cuOb, struct Object *target, float (*vertexCos)[3],
57         int numVerts, struct MDeformVert *dvert, const int defgrp_index, short defaxis);
58 void curve_deform_vector(
59         struct Object *cuOb, struct Object *target,
60         float orco[3], float vec[3], float mat[3][3], int no_rot_axis);
61
62 void lattice_deform_verts(
63         struct Object *laOb, struct Object *target,
64         struct Mesh *mesh, float (*vertexCos)[3],
65         int numVerts, const char *vgroup, float influence);
66 void armature_deform_verts(
67         struct Object *armOb, struct Object *target,
68         const struct Mesh *mesh, float (*vertexCos)[3],
69         float (*defMats)[3][3], int numVerts, int deformflag,
70         float (*prevCos)[3], const char *defgrp_name,
71         struct bGPDstroke *gps);
72
73 float (*BKE_lattice_vertexcos_get(struct Object *ob, int *r_numVerts))[3];
74 void    BKE_lattice_vertexcos_apply(struct Object *ob, float (*vertexCos)[3]);
75 void    BKE_lattice_modifiers_calc(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
76
77 struct MDeformVert *BKE_lattice_deform_verts_get(struct Object *lattice);
78 struct BPoint *BKE_lattice_active_point_get(struct Lattice *lt);
79
80 struct BoundBox *BKE_lattice_boundbox_get(struct Object *ob);
81 void BKE_lattice_minmax_dl(struct Object *ob, struct Lattice *lt, float min[3], float max[3]);
82 void BKE_lattice_minmax(struct Lattice *lt, float min[3], float max[3]);
83 void BKE_lattice_center_median(struct Lattice *lt, float cent[3]);
84 void BKE_lattice_center_bounds(struct Lattice *lt, float cent[3]);
85 void BKE_lattice_translate(struct Lattice *lt, float offset[3], bool do_keys);
86 void BKE_lattice_transform(struct Lattice *lt, float mat[4][4], bool do_keys);
87
88 bool BKE_lattice_is_any_selected(const struct Lattice *lt);
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 int  BKE_lattice_index_flip(struct Lattice *lt, const int index,
93                             const bool flip_u, const bool flip_v, const bool flip_w);
94 void BKE_lattice_bitmap_from_flag(struct Lattice *lt, unsigned int *bitmap, const short flag,
95                                   const bool clear, const bool respecthide);
96
97 /* **** Depsgraph evaluation **** */
98
99 struct Depsgraph;
100
101 void BKE_lattice_eval_geometry(struct Depsgraph *depsgraph,
102                                struct Lattice *latt);
103
104 /* Draw Cache */
105 enum {
106         BKE_LATTICE_BATCH_DIRTY_ALL = 0,
107         BKE_LATTICE_BATCH_DIRTY_SELECT,
108 };
109 void BKE_lattice_batch_cache_dirty_tag(struct Lattice *lt, int mode);
110 void BKE_lattice_batch_cache_free(struct Lattice *lt);
111
112 #endif  /* __BKE_LATTICE_H__ */