Physically based defaults for Eevee Bloom and Shutter
[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 #include "BLI_compiler_attrs.h"
38
39 struct Lattice;
40 struct Main;
41 struct Mesh;
42 struct Object;
43 struct Scene;
44 struct BPoint;
45 struct MDeformVert;
46 struct Depsgraph;
47 struct bGPDstroke;
48
49 void BKE_lattice_resize(struct Lattice *lt, int u, int v, int w, struct Object *ltOb);
50 void BKE_lattice_init(struct Lattice *lt);
51 struct Lattice *BKE_lattice_add(struct Main *bmain, const char *name);
52 void BKE_lattice_copy_data(struct Main *bmain, struct Lattice *lt_dst, const struct Lattice *lt_src, const int flag);
53 struct Lattice *BKE_lattice_copy(struct Main *bmain, const struct Lattice *lt);
54 void BKE_lattice_free(struct Lattice *lt);
55 void BKE_lattice_make_local(struct Main *bmain, struct Lattice *lt, const bool lib_local);
56 void calc_lat_fudu(int flag, int res, float *r_fu, float *r_du);
57
58 struct LatticeDeformData *init_latt_deform(struct Object *oblatt, struct Object *ob) ATTR_WARN_UNUSED_RESULT;
59 void calc_latt_deform(struct LatticeDeformData *lattice_deform_data, float co[3], float weight);
60 void end_latt_deform(struct LatticeDeformData *lattice_deform_data);
61
62 bool object_deform_mball(struct Object *ob, struct ListBase *dispbase);
63 void outside_lattice(struct Lattice *lt);
64
65 void curve_deform_verts(
66         struct Object *cuOb, struct Object *target, float (*vertexCos)[3],
67         int numVerts, struct MDeformVert *dvert, const int defgrp_index, short defaxis);
68 void curve_deform_vector(
69         struct Object *cuOb, struct Object *target,
70         float orco[3], float vec[3], float mat[3][3], int no_rot_axis);
71
72 void lattice_deform_verts(
73         struct Object *laOb, struct Object *target,
74         struct Mesh *mesh, float (*vertexCos)[3],
75         int numVerts, const char *vgroup, float influence);
76 void armature_deform_verts(
77         struct Object *armOb, struct Object *target,
78         const struct Mesh *mesh, float (*vertexCos)[3],
79         float (*defMats)[3][3], int numVerts, int deformflag,
80         float (*prevCos)[3], const char *defgrp_name,
81         struct bGPDstroke *gps);
82
83 float (*BKE_lattice_vertexcos_get(struct Object *ob, int *r_numVerts))[3];
84 void    BKE_lattice_vertexcos_apply(struct Object *ob, float (*vertexCos)[3]);
85 void    BKE_lattice_modifiers_calc(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
86
87 struct MDeformVert *BKE_lattice_deform_verts_get(struct Object *lattice);
88 struct BPoint *BKE_lattice_active_point_get(struct Lattice *lt);
89
90 struct BoundBox *BKE_lattice_boundbox_get(struct Object *ob);
91 void BKE_lattice_minmax_dl(struct Object *ob, struct Lattice *lt, float min[3], float max[3]);
92 void BKE_lattice_minmax(struct Lattice *lt, float min[3], float max[3]);
93 void BKE_lattice_center_median(struct Lattice *lt, float cent[3]);
94 void BKE_lattice_center_bounds(struct Lattice *lt, float cent[3]);
95 void BKE_lattice_translate(struct Lattice *lt, float offset[3], bool do_keys);
96 void BKE_lattice_transform(struct Lattice *lt, float mat[4][4], bool do_keys);
97
98 bool BKE_lattice_is_any_selected(const struct Lattice *lt);
99
100 int  BKE_lattice_index_from_uvw(struct Lattice *lt, const int u, const int v, const int w);
101 void BKE_lattice_index_to_uvw(struct Lattice *lt, const int index, int *r_u, int *r_v, int *r_w);
102 int  BKE_lattice_index_flip(struct Lattice *lt, const int index,
103                             const bool flip_u, const bool flip_v, const bool flip_w);
104 void BKE_lattice_bitmap_from_flag(struct Lattice *lt, unsigned int *bitmap, const short flag,
105                                   const bool clear, const bool respecthide);
106
107 /* **** Depsgraph evaluation **** */
108
109 struct Depsgraph;
110
111 void BKE_lattice_eval_geometry(struct Depsgraph *depsgraph,
112                                struct Lattice *latt);
113
114 /* Draw Cache */
115 enum {
116         BKE_LATTICE_BATCH_DIRTY_ALL = 0,
117         BKE_LATTICE_BATCH_DIRTY_SELECT,
118 };
119 void BKE_lattice_batch_cache_dirty_tag(struct Lattice *lt, int mode);
120 void BKE_lattice_batch_cache_free(struct Lattice *lt);
121
122 #endif  /* __BKE_LATTICE_H__ */