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