Fix T69127: Node sockets location bug after a keyframe is inserted
[blender.git] / source / blender / blenkernel / BKE_object.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
17 #ifndef __BKE_OBJECT_H__
18 #define __BKE_OBJECT_H__
19
20 /** \file
21  * \ingroup bke
22  * \brief General operations, lookup, etc. for blender objects.
23  */
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 #include "BLI_compiler_attrs.h"
29
30 struct Base;
31 struct BoundBox;
32 struct Depsgraph;
33 struct GpencilModifierData;
34 struct HookGpencilModifierData;
35 struct HookModifierData;
36 struct ID;
37 struct Main;
38 struct Mesh;
39 struct ModifierData;
40 struct MovieClip;
41 struct Object;
42 struct RegionView3D;
43 struct RigidBodyWorld;
44 struct Scene;
45 struct ShaderFxData;
46 struct View3D;
47 struct ViewLayer;
48
49 #include "DNA_object_enums.h"
50
51 void BKE_object_workob_clear(struct Object *workob);
52 void BKE_object_workob_calc_parent(struct Depsgraph *depsgraph,
53                                    struct Scene *scene,
54                                    struct Object *ob,
55                                    struct Object *workob);
56
57 void BKE_object_transform_copy(struct Object *ob_tar, const struct Object *ob_src);
58 void BKE_object_copy_softbody(struct Object *ob_dst, const struct Object *ob_src, 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,
61                                      const struct Object *ob_src,
62                                      const int flag);
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 void BKE_object_modifier_gpencil_hook_reset(struct Object *ob,
74                                             struct HookGpencilModifierData *hmd);
75 bool BKE_object_modifier_gpencil_use_time(struct Object *ob, struct GpencilModifierData *md);
76
77 bool BKE_object_shaderfx_use_time(struct Object *ob, struct ShaderFxData *md);
78
79 bool BKE_object_support_modifier_type_check(const struct Object *ob, int modifier_type);
80
81 void BKE_object_link_modifiers(struct Scene *scene,
82                                struct Object *ob_dst,
83                                const struct Object *ob_src);
84 void BKE_object_free_modifiers(struct Object *ob, const int flag);
85 void BKE_object_free_shaderfx(struct Object *ob, const int flag);
86
87 void BKE_object_make_proxy(struct Main *bmain,
88                            struct Object *ob,
89                            struct Object *target,
90                            struct Object *gob);
91 void BKE_object_copy_proxy_drivers(struct Object *ob, struct Object *target);
92
93 bool BKE_object_exists_check(struct Main *bmain, const struct Object *obtest);
94 bool BKE_object_is_in_editmode(const struct Object *ob);
95 bool BKE_object_is_in_editmode_vgroup(const struct Object *ob);
96 bool BKE_object_is_in_wpaint_select_vert(const struct Object *ob);
97 bool BKE_object_has_mode_data(const struct Object *ob, eObjectMode object_mode);
98 bool BKE_object_is_mode_compat(const struct Object *ob, eObjectMode object_mode);
99
100 bool BKE_object_data_is_in_editmode(const struct ID *id);
101
102 void BKE_object_update_select_id(struct Main *bmain);
103
104 typedef enum eObjectVisibilityResult {
105   OB_VISIBLE_SELF = 1,
106   OB_VISIBLE_PARTICLES = 2,
107   OB_VISIBLE_INSTANCES = 4,
108   OB_VISIBLE_ALL = (OB_VISIBLE_SELF | OB_VISIBLE_PARTICLES | OB_VISIBLE_INSTANCES),
109 } eObjectVisibilityResult;
110
111 int BKE_object_visibility(const struct Object *ob, const int dag_eval_mode);
112
113 void BKE_object_init(struct Object *ob);
114 struct Object *BKE_object_add_only_object(struct Main *bmain, int type, const char *name)
115     ATTR_NONNULL(1) ATTR_RETURNS_NONNULL;
116 struct Object *BKE_object_add(struct Main *bmain,
117                               struct Scene *scene,
118                               struct ViewLayer *view_layer,
119                               int type,
120                               const char *name) ATTR_NONNULL(1, 2, 3) ATTR_RETURNS_NONNULL;
121 struct Object *BKE_object_add_from(struct Main *bmain,
122                                    struct Scene *scene,
123                                    struct ViewLayer *view_layer,
124                                    int type,
125                                    const char *name,
126                                    struct Object *ob_src)
127     ATTR_NONNULL(1, 2, 3, 6) ATTR_RETURNS_NONNULL;
128 struct Object *BKE_object_add_for_data(struct Main *bmain,
129                                        struct ViewLayer *view_layer,
130                                        int type,
131                                        const char *name,
132                                        struct ID *data,
133                                        bool do_id_user) ATTR_RETURNS_NONNULL;
134 void *BKE_object_obdata_add_from_type(struct Main *bmain, int type, const char *name)
135     ATTR_NONNULL(1);
136
137 void BKE_object_copy_data(struct Main *bmain,
138                           struct Object *ob_dst,
139                           const struct Object *ob_src,
140                           const int flag);
141 struct Object *BKE_object_copy(struct Main *bmain, const struct Object *ob);
142 void BKE_object_make_local(struct Main *bmain, struct Object *ob, const bool lib_local);
143 void BKE_object_make_local_ex(struct Main *bmain,
144                               struct Object *ob,
145                               const bool lib_local,
146                               const bool clear_proxy);
147 bool BKE_object_is_libdata(const struct Object *ob);
148 bool BKE_object_obdata_is_libdata(const struct Object *ob);
149
150 struct Object *BKE_object_duplicate(struct Main *bmain,
151                                     const struct Object *ob,
152                                     const int dupflag);
153
154 void BKE_object_obdata_size_init(struct Object *ob, const float scale);
155
156 void BKE_object_scale_to_mat3(struct Object *ob, float mat[3][3]);
157 void BKE_object_rot_to_mat3(const struct Object *ob, float mat[3][3], bool use_drot);
158 void BKE_object_mat3_to_rot(struct Object *ob, float mat[3][3], bool use_compat);
159 void BKE_object_to_mat3(struct Object *ob, float mat[3][3]);
160 void BKE_object_to_mat4(struct Object *ob, float mat[4][4]);
161 void BKE_object_apply_mat4(struct Object *ob,
162                            float mat[4][4],
163                            const bool use_compat,
164                            const bool use_parent);
165 void BKE_object_apply_mat4_ex(struct Object *ob,
166                               float mat[4][4],
167                               struct Object *parent,
168                               float parentinv[4][4],
169                               const bool use_compat);
170 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4]);
171
172 bool BKE_object_pose_context_check(const struct Object *ob);
173 struct Object *BKE_object_pose_armature_get(struct Object *ob);
174 struct Object *BKE_object_pose_armature_get_visible(struct Object *ob,
175                                                     struct ViewLayer *view_layer,
176                                                     struct View3D *v3d);
177
178 struct Object **BKE_object_pose_array_get_ex(struct ViewLayer *view_layer,
179                                              struct View3D *v3d,
180                                              unsigned int *r_objects_len,
181                                              bool unique);
182 struct Object **BKE_object_pose_array_get_unique(struct ViewLayer *view_layer,
183                                                  struct View3D *v3d,
184                                                  unsigned int *r_objects_len);
185 struct Object **BKE_object_pose_array_get(struct ViewLayer *view_layer,
186                                           struct View3D *v3d,
187                                           unsigned int *r_objects_len);
188
189 struct Base **BKE_object_pose_base_array_get_ex(struct ViewLayer *view_layer,
190                                                 struct View3D *v3d,
191                                                 unsigned int *r_bases_len,
192                                                 bool unique);
193 struct Base **BKE_object_pose_base_array_get_unique(struct ViewLayer *view_layer,
194                                                     struct View3D *v3d,
195                                                     unsigned int *r_bases_len);
196 struct Base **BKE_object_pose_base_array_get(struct ViewLayer *view_layer,
197                                              struct View3D *v3d,
198                                              unsigned int *r_bases_len);
199
200 void BKE_object_get_parent_matrix(struct Object *ob, struct Object *par, float parentmat[4][4]);
201 void BKE_object_where_is_calc(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
202 void BKE_object_where_is_calc_ex(struct Depsgraph *depsgraph,
203                                  struct Scene *scene,
204                                  struct RigidBodyWorld *rbw,
205                                  struct Object *ob,
206                                  float r_originmat[3][3]);
207 void BKE_object_where_is_calc_time(struct Depsgraph *depsgraph,
208                                    struct Scene *scene,
209                                    struct Object *ob,
210                                    float ctime);
211 void BKE_object_where_is_calc_mat4(struct Object *ob, float obmat[4][4]);
212
213 /* possibly belong in own moduke? */
214 struct BoundBox *BKE_boundbox_alloc_unit(void);
215 void BKE_boundbox_init_from_minmax(struct BoundBox *bb, const float min[3], const float max[3]);
216 void BKE_boundbox_calc_center_aabb(const struct BoundBox *bb, float r_cent[3]);
217 void BKE_boundbox_calc_size_aabb(const struct BoundBox *bb, float r_size[3]);
218 void BKE_boundbox_minmax(const struct BoundBox *bb,
219                          float obmat[4][4],
220                          float r_min[3],
221                          float r_max[3]);
222
223 struct BoundBox *BKE_object_boundbox_get(struct Object *ob);
224 void BKE_object_dimensions_get(struct Object *ob, float vec[3]);
225 void BKE_object_dimensions_set(struct Object *ob, const float value[3], int axis_mask);
226 void BKE_object_empty_draw_type_set(struct Object *ob, const int value);
227 void BKE_object_boundbox_flag(struct Object *ob, int flag, const bool set);
228 void BKE_object_boundbox_calc_from_mesh(struct Object *ob, struct Mesh *me_eval);
229 void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], const bool use_hidden);
230 bool BKE_object_minmax_dupli(struct Depsgraph *depsgraph,
231                              struct Scene *scene,
232                              struct Object *ob,
233                              float r_min[3],
234                              float r_max[3],
235                              const bool use_hidden);
236
237 /* sometimes min-max isn't enough, we need to loop over each point */
238 void BKE_object_foreach_display_point(struct Object *ob,
239                                       float obmat[4][4],
240                                       void (*func_cb)(const float[3], void *),
241                                       void *user_data);
242 void BKE_scene_foreach_display_point(struct Depsgraph *depsgraph,
243                                      void (*func_cb)(const float[3], void *),
244                                      void *user_data);
245
246 bool BKE_object_parent_loop_check(const struct Object *parent, const struct Object *ob);
247
248 void *BKE_object_tfm_backup(struct Object *ob);
249 void BKE_object_tfm_restore(struct Object *ob, void *obtfm_pt);
250
251 typedef struct ObjectTfmProtectedChannels {
252   float loc[3], dloc[3];
253   float scale[3], dscale[3];
254   float rot[3], drot[3];
255   float quat[4], dquat[4];
256   float rotAxis[3], drotAxis[3];
257   float rotAngle, drotAngle;
258 } ObjectTfmProtectedChannels;
259
260 void BKE_object_tfm_protected_backup(const struct Object *ob, ObjectTfmProtectedChannels *obtfm);
261
262 void BKE_object_tfm_protected_restore(struct Object *ob,
263                                       const ObjectTfmProtectedChannels *obtfm,
264                                       const short protectflag);
265
266 void BKE_object_tfm_copy(struct Object *object_dst, const struct Object *object_src);
267
268 void BKE_object_eval_reset(struct Object *ob_eval);
269
270 /* Dependency graph evaluation callbacks. */
271 void BKE_object_eval_local_transform(struct Depsgraph *depsgraph, struct Object *ob);
272 void BKE_object_eval_parent(struct Depsgraph *depsgraph, struct Object *ob);
273 void BKE_object_eval_constraints(struct Depsgraph *depsgraph,
274                                  struct Scene *scene,
275                                  struct Object *ob);
276 void BKE_object_eval_transform_final(struct Depsgraph *depsgraph, struct Object *ob);
277
278 bool BKE_object_eval_proxy_copy(struct Depsgraph *depsgraph, struct Object *object);
279 void BKE_object_eval_uber_transform(struct Depsgraph *depsgraph, struct Object *ob);
280 void BKE_object_eval_uber_data(struct Depsgraph *depsgraph,
281                                struct Scene *scene,
282                                struct Object *ob);
283
284 void BKE_object_eval_boundbox(struct Depsgraph *depsgraph, struct Object *object);
285 void BKE_object_synchronize_to_original(struct Depsgraph *depsgraph, struct Object *object);
286
287 void BKE_object_eval_ptcache_reset(struct Depsgraph *depsgraph,
288                                    struct Scene *scene,
289                                    struct Object *object);
290
291 void BKE_object_eval_transform_all(struct Depsgraph *depsgraph,
292                                    struct Scene *scene,
293                                    struct Object *object);
294
295 void BKE_object_eval_update_shading(struct Depsgraph *depsgraph, struct Object *object);
296 void BKE_object_data_select_update(struct Depsgraph *depsgraph, struct ID *object_data);
297 void BKE_object_select_update(struct Depsgraph *depsgraph, struct Object *object);
298
299 void BKE_object_eval_eval_base_flags(struct Depsgraph *depsgraph,
300                                      struct Scene *scene,
301                                      const int view_layer_index,
302                                      struct Object *object,
303                                      int base_index,
304                                      const bool is_from_set);
305
306 void BKE_object_handle_data_update(struct Depsgraph *depsgraph,
307                                    struct Scene *scene,
308                                    struct Object *ob);
309 void BKE_object_handle_update(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
310 void BKE_object_handle_update_ex(struct Depsgraph *depsgraph,
311                                  struct Scene *scene,
312                                  struct Object *ob,
313                                  struct RigidBodyWorld *rbw,
314                                  const bool do_proxy_update);
315
316 void BKE_object_sculpt_data_create(struct Object *ob);
317
318 int BKE_object_obdata_texspace_get(
319     struct Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot);
320
321 struct Mesh *BKE_object_get_evaluated_mesh(const struct Depsgraph *depsgraph, struct Object *ob);
322 struct Mesh *BKE_object_get_final_mesh(struct Object *object);
323 struct Mesh *BKE_object_get_pre_modified_mesh(struct Object *object);
324 struct Mesh *BKE_object_get_original_mesh(struct Object *object);
325
326 int BKE_object_insert_ptcache(struct Object *ob);
327 void BKE_object_delete_ptcache(struct Object *ob, int index);
328 struct KeyBlock *BKE_object_shapekey_insert(struct Main *bmain,
329                                             struct Object *ob,
330                                             const char *name,
331                                             const bool from_mix);
332 bool BKE_object_shapekey_remove(struct Main *bmain, struct Object *ob, struct KeyBlock *kb);
333 bool BKE_object_shapekey_free(struct Main *bmain, struct Object *ob);
334
335 bool BKE_object_flag_test_recursive(const struct Object *ob, short flag);
336
337 bool BKE_object_is_child_recursive(const struct Object *ob_parent, const struct Object *ob_child);
338 bool BKE_object_is_animated(struct Scene *scene, struct Object *ob);
339
340 /* return ModifierMode flag */
341 int BKE_object_is_modified(struct Scene *scene, struct Object *ob);
342 int BKE_object_is_deform_modified(struct Scene *scene, struct Object *ob);
343
344 int BKE_object_scenes_users_get(struct Main *bmain, struct Object *ob);
345
346 struct MovieClip *BKE_object_movieclip_get(struct Scene *scene,
347                                            struct Object *ob,
348                                            bool use_default);
349
350 void BKE_object_runtime_reset(struct Object *object);
351 void BKE_object_runtime_reset_on_copy(struct Object *object, const int flag);
352
353 void BKE_object_batch_cache_dirty_tag(struct Object *ob);
354
355 /* this function returns a superset of the scenes selection based on relationships */
356
357 typedef enum eObRelationTypes {
358   OB_REL_NONE = 0,                      /* just the selection as is */
359   OB_REL_PARENT = (1 << 0),             /* immediate parent */
360   OB_REL_PARENT_RECURSIVE = (1 << 1),   /* parents up to root of selection tree*/
361   OB_REL_CHILDREN = (1 << 2),           /* immediate children */
362   OB_REL_CHILDREN_RECURSIVE = (1 << 3), /* All children */
363   OB_REL_MOD_ARMATURE = (1 << 4),       /* Armatures related to the selected objects */
364   OB_REL_SCENE_CAMERA = (1 << 5), /* you might want the scene camera too even if unselected? */
365 } eObRelationTypes;
366
367 typedef enum eObjectSet {
368   OB_SET_SELECTED, /* Selected Objects */
369   OB_SET_VISIBLE,  /* Visible Objects  */
370   OB_SET_ALL,      /* All Objects      */
371 } eObjectSet;
372
373 struct LinkNode *BKE_object_relational_superset(struct ViewLayer *view_layer,
374                                                 eObjectSet objectSet,
375                                                 eObRelationTypes includeFilter);
376 struct LinkNode *BKE_object_groups(struct Main *bmain, struct Scene *scene, struct Object *ob);
377 void BKE_object_groups_clear(struct Main *bmain, struct Scene *scene, struct Object *object);
378
379 struct KDTree_3d *BKE_object_as_kdtree(struct Object *ob, int *r_tot);
380
381 bool BKE_object_modifier_use_time(struct Object *ob, struct ModifierData *md);
382
383 bool BKE_object_modifier_update_subframe(struct Depsgraph *depsgraph,
384                                          struct Scene *scene,
385                                          struct Object *ob,
386                                          bool update_mesh,
387                                          int parent_recursion,
388                                          float frame,
389                                          int type);
390
391 bool BKE_object_empty_image_frame_is_visible_in_view3d(const struct Object *ob,
392                                                        const struct RegionView3D *rv3d);
393 bool BKE_object_empty_image_data_is_visible_in_view3d(const struct Object *ob,
394                                                       const struct RegionView3D *rv3d);
395
396 /* This is an utility function for Python's object.to_mesh() (the naming is not very clear though).
397  * The result is owned by the object.
398  *
399  * The mesh will be freed when object is re-evaluated or is destroyed. It is possible to force to
400  * clear memory sued by this mesh by calling BKE_object_to_mesh_clear().
401  *
402  * If preserve_all_data_layers is truth then the modifier stack is re-evaluated to ensure it
403  * preserves all possible custom data layers.
404  *
405  * NOTE: Dependency graph argument is required when preserve_all_data_layers is truth, and is
406  * ignored otherwise. */
407 struct Mesh *BKE_object_to_mesh(struct Depsgraph *depsgraph,
408                                 struct Object *object,
409                                 bool preserve_all_data_layers);
410
411 void BKE_object_to_mesh_clear(struct Object *object);
412
413 #ifdef __cplusplus
414 }
415 #endif
416
417 #endif