Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_object.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: all of this file.
19  *
20  * Contributor(s): none yet.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #ifndef __BKE_OBJECT_H__
26 #define __BKE_OBJECT_H__
27
28 /** \file BKE_object.h
29  *  \ingroup bke
30  *  \brief General operations, lookup, etc. for blender objects.
31  */
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 #include "BLI_compiler_attrs.h"
37
38 struct Base;
39 struct Depsgraph;
40 struct Scene;
41 struct ViewLayer;
42 struct Object;
43 struct BoundBox;
44 struct View3D;
45 struct SoftBody;
46 struct MovieClip;
47 struct Main;
48 struct RigidBodyWorld;
49 struct HookModifierData;
50 struct ModifierData;
51
52 #include "DNA_object_enums.h"
53
54 void BKE_object_workob_clear(struct Object *workob);
55 void BKE_object_workob_calc_parent(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, struct Object *workob);
56
57 void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
58 struct SoftBody *copy_softbody(const struct SoftBody *sb, const int flag);
59 struct ParticleSystem *BKE_object_copy_particlesystem(struct ParticleSystem *psys, const int flag);
60 void BKE_object_copy_particlesystems(struct Object *ob_dst, const struct Object *ob_src, const int flag);
61 void BKE_object_copy_softbody(struct Object *ob_dst, const struct Object *ob_src);
62 void BKE_object_free_particlesystems(struct Object *ob);
63 void BKE_object_free_softbody(struct Object *ob);
64 void BKE_object_free_curve_cache(struct Object *ob);
65
66 void BKE_object_free(struct Object *ob);
67 void BKE_object_free_derived_caches(struct Object *ob);
68 void BKE_object_free_caches(struct Object *object);
69
70 void BKE_object_modifier_hook_reset(struct Object *ob, struct HookModifierData *hmd);
71
72 bool BKE_object_support_modifier_type_check(const struct Object *ob, int modifier_type);
73
74 void BKE_object_link_modifiers(struct Object *ob_dst, const struct Object *ob_src);
75 void BKE_object_free_modifiers(struct Object *ob, const int flag);
76
77 void BKE_object_make_proxy(struct Object *ob, struct Object *target, struct Object *gob);
78 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
79
80 bool BKE_object_exists_check(const struct Object *obtest);
81 bool BKE_object_is_in_editmode(const struct Object *ob);
82 bool BKE_object_is_in_editmode_vgroup(const struct Object *ob);
83 bool BKE_object_is_in_editmode_and_selected(const struct Object *ob);
84 bool BKE_object_is_in_wpaint_select_vert(const struct Object *ob);
85 bool BKE_object_has_mode_data(const struct Object *ob, eObjectMode object_mode);
86
87 typedef enum eObjectVisibilityCheck {
88         OB_VISIBILITY_CHECK_FOR_VIEWPORT,
89         OB_VISIBILITY_CHECK_FOR_RENDER,
90         OB_VISIBILITY_CHECK_UNKNOWN_RENDER_MODE,
91 } eObjectVisibilityCheck;
92
93 bool BKE_object_is_visible(struct Object *ob, const eObjectVisibilityCheck mode);
94
95 void BKE_object_init(struct Object *ob);
96 struct Object *BKE_object_add_only_object(
97         struct Main *bmain,
98         int type, const char *name)
99         ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
100 struct Object *BKE_object_add(
101         struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer,
102         int type, const char *name)
103         ATTR_NONNULL(1, 2, 3) ATTR_RETURNS_NONNULL;
104 struct Object *BKE_object_add_from(
105         struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer,
106         int type, const char *name, struct Object *ob_src)
107         ATTR_NONNULL(1, 2, 3, 6) ATTR_RETURNS_NONNULL;
108 void *BKE_object_obdata_add_from_type(
109         struct Main *bmain,
110         int type, const char *name)
111         ATTR_NONNULL(1);
112
113 void BKE_object_copy_data(struct Main *bmain, struct Object *ob_dst, const struct Object *ob_src, const int flag);
114 struct Object *BKE_object_copy(struct Main *bmain, const struct Object *ob);
115 void BKE_object_make_local(struct Main *bmain, struct Object *ob, const bool lib_local);
116 void BKE_object_make_local_ex(struct Main *bmain, struct Object *ob, const bool lib_local, const bool clear_proxy);
117 bool BKE_object_is_libdata(const struct Object *ob);
118 bool BKE_object_obdata_is_libdata(const struct Object *ob);
119
120 void BKE_object_obdata_size_init(struct Object *ob, const float scale);
121
122 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
123 void BKE_object_rot_to_mat3(struct Object *ob, float mat[3][3], bool use_drot);
124 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
125 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
126 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
127 void BKE_object_apply_mat4(struct Object *ob, float mat[4][4], const bool use_compat, const bool use_parent);
128 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
129
130 bool BKE_object_pose_context_check(const struct Object *ob);
131 struct Object *BKE_object_pose_armature_get(struct Object *ob);
132 struct Object *BKE_object_pose_armature_get_visible(struct Object *ob, struct ViewLayer *view_layer);
133
134 struct Object **BKE_object_pose_array_get_ex(struct ViewLayer *view_layer, unsigned int *r_objects_len, bool unique);
135 struct Object **BKE_object_pose_array_get_unique(struct ViewLayer *view_layer, unsigned int *r_objects_len);
136 struct Object **BKE_object_pose_array_get(struct ViewLayer *view_layer, unsigned int *r_objects_len);
137
138 struct Base **BKE_object_pose_base_array_get_ex(struct ViewLayer *view_layer, unsigned int *r_bases_len, bool unique);
139 struct Base **BKE_object_pose_base_array_get_unique(struct ViewLayer *view_layer, unsigned int *r_bases_len);
140 struct Base **BKE_object_pose_base_array_get(struct ViewLayer *view_layer, unsigned int *r_bases_len);
141
142 void BKE_object_get_parent_matrix(
143         struct Scene *scene, struct Object *ob,
144         struct Object *par, float parentmat[4][4]);
145 void BKE_object_where_is_calc(
146         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
147 void BKE_object_where_is_calc_ex(
148         struct Depsgraph *depsgraph, struct Scene *scene, struct RigidBodyWorld *rbw,
149         struct Object *ob, float r_originmat[3][3]);
150 void BKE_object_where_is_calc_time(
151         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, float ctime);
152 void BKE_object_where_is_calc_time_ex(
153         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, float ctime,
154         struct RigidBodyWorld *rbw, float r_originmat[3][3]);
155 void BKE_object_where_is_calc_mat4(struct Scene *scene, struct Object *ob, float obmat[4][4]);
156
157 /* possibly belong in own moduke? */
158 struct BoundBox *BKE_boundbox_alloc_unit(void);
159 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
160 void BKE_boundbox_calc_center_aabb(const struct BoundBox *bb, float r_cent[3]);
161 void BKE_boundbox_calc_size_aabb(const struct BoundBox *bb, float r_size[3]);
162 void BKE_boundbox_minmax(const struct BoundBox *bb, float obmat[4][4], float r_min[3], float r_max[3]);
163
164 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
165 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
166 void BKE_object_dimensions_set(struct Object *ob, const float value[3]);
167 void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
168 void BKE_object_boundbox_flag(struct Object *ob, int flag, const bool set);
169 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
170 bool BKE_object_minmax_dupli(
171         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob,
172         float r_min[3], float r_max[3], const bool use_hidden);
173
174 /* sometimes min-max isn't enough, we need to loop over each point */
175 void BKE_object_foreach_display_point(
176         struct Object *ob, float obmat[4][4],
177         void (*func_cb)(const float[3], void *), void *user_data);
178 void BKE_scene_foreach_display_point(
179         struct Depsgraph *depsgraph,
180         struct Scene *scene,
181         struct ViewLayer *view_layer,
182         void (*func_cb)(const float[3], void *), void *user_data);
183
184 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
185
186 void *BKE_object_tfm_backup(struct Object *ob);
187 void  BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
188
189 typedef struct ObjectTfmProtectedChannels {
190         float loc[3],     dloc[3];
191         float size[3],    dscale[3];
192         float rot[3],     drot[3];
193         float quat[4],    dquat[4];
194         float rotAxis[3], drotAxis[3];
195         float rotAngle,   drotAngle;
196 } ObjectTfmProtectedChannels;
197
198 void BKE_object_tfm_protected_backup(
199         const struct Object *ob,
200         ObjectTfmProtectedChannels *obtfm);
201
202 void BKE_object_tfm_protected_restore(
203         struct Object *ob,
204         const ObjectTfmProtectedChannels *obtfm,
205         const short protectflag);
206
207 /* Dependency graph evaluation callbacks. */
208 void BKE_object_eval_local_transform(
209         struct Depsgraph *depsgraph,
210         struct Object *ob);
211 void BKE_object_eval_parent(
212         struct Depsgraph *depsgraph,
213         struct Scene *scene,
214         struct Object *ob);
215 void BKE_object_eval_constraints(
216         struct Depsgraph *depsgraph,
217         struct Scene *scene,
218         struct Object *ob);
219 void BKE_object_eval_done(struct Depsgraph *depsgraph, struct Object *ob);
220
221 bool BKE_object_eval_proxy_copy(
222         struct Depsgraph *depsgraph,
223         struct Object *object);
224 void BKE_object_eval_uber_transform(
225         struct Depsgraph *depsgraph,
226         struct Object *ob);
227 void BKE_object_eval_uber_data(
228         struct Depsgraph *depsgraph,
229         struct Scene *scene,
230         struct Object *ob);
231
232 void BKE_object_eval_cloth(
233         struct Depsgraph *depsgraph,
234         struct Scene *scene,
235         struct Object *object);
236
237 void BKE_object_eval_transform_all(
238         struct Depsgraph *depsgraph,
239         struct Scene *scene,
240         struct Object *object);
241
242 void BKE_object_eval_update_shading(
243         struct Depsgraph *depsgraph,
244         struct Object *object);
245 void BKE_object_data_select_update(
246         struct Depsgraph *depsgraph,
247         struct ID *object_data);
248
249 void BKE_object_eval_flush_base_flags(
250         struct Depsgraph *depsgraph,
251         struct Scene *scene, const int view_layer_index,
252         struct Object *object, int base_index,
253         const bool is_from_set);
254
255 void BKE_object_handle_data_update(
256         struct Depsgraph *depsgraph,
257         struct Scene *scene,
258         struct Object *ob);
259 void BKE_object_handle_update(
260         struct Depsgraph *depsgraph,
261         struct Scene *scene, struct Object *ob);
262 void BKE_object_handle_update_ex(
263         struct Depsgraph *depsgraph,
264         struct Scene *scene, struct Object *ob,
265         struct RigidBodyWorld *rbw,
266         const bool do_proxy_update);
267 void BKE_object_sculpt_modifiers_changed(struct Object *ob);
268
269 int BKE_object_obdata_texspace_get(struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
270
271 int BKE_object_insert_ptcache(struct Object *ob);
272 void BKE_object_delete_ptcache(struct Object *ob, int index);
273 struct KeyBlock *BKE_object_shapekey_insert(struct Object *ob, const char *name, const bool from_mix);
274 bool BKE_object_shapekey_remove(struct Main *bmain, struct Object *ob, struct KeyBlock *kb);
275 bool BKE_object_shapekey_free(struct Main *bmain, struct Object *ob);
276
277 bool BKE_object_flag_test_recursive(const struct Object *ob, short flag);
278
279 bool BKE_object_is_child_recursive(const struct Object *ob_parent, const struct Object *ob_child);
280 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
281
282 /* return ModifierMode flag */
283 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
284 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
285
286 void BKE_object_relink(struct Object *ob);
287 void BKE_object_data_relink(struct Object *ob);
288
289 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene, struct Object *ob, bool use_default);
290
291 /* this function returns a superset of the scenes selection based on relationships */
292
293 typedef enum eObRelationTypes {
294         OB_REL_NONE               = 0,        /* just the selection as is */
295         OB_REL_PARENT             = (1 << 0), /* immediate parent */
296         OB_REL_PARENT_RECURSIVE   = (1 << 1), /* parents up to root of selection tree*/
297         OB_REL_CHILDREN           = (1 << 2), /* immediate children */
298         OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
299         OB_REL_MOD_ARMATURE       = (1 << 4), /* Armatures related to the selected objects */
300         OB_REL_SCENE_CAMERA       = (1 << 5), /* you might want the scene camera too even if unselected? */
301 } eObRelationTypes;
302
303 typedef enum eObjectSet {
304         OB_SET_SELECTED, /* Selected Objects */
305         OB_SET_VISIBLE,  /* Visible Objects  */
306         OB_SET_ALL       /* All Objects      */
307 } eObjectSet;
308
309 struct LinkNode *BKE_object_relational_superset(
310         struct ViewLayer *view_layer, eObjectSet objectSet, eObRelationTypes includeFilter);
311 struct LinkNode *BKE_object_groups(struct Object *ob);
312 void             BKE_object_groups_clear(struct Object *object);
313
314 struct KDTree *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
315
316 bool BKE_object_modifier_use_time(struct Object *ob, struct ModifierData *md);
317
318 bool BKE_object_modifier_update_subframe(
319         struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob,
320         bool update_mesh, int parent_recursion, float frame, int type);
321
322 #ifdef __cplusplus
323 }
324 #endif
325
326 #endif