ClangFormat: apply to source, most of intern
[blender.git] / source / blender / blenkernel / intern / object.c
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 /** \file
21  * \ingroup bke
22  */
23
24 #include <string.h>
25 #include <math.h>
26 #include <stdio.h>
27
28 #include "CLG_log.h"
29
30 #include "MEM_guardedalloc.h"
31
32 #include "DNA_anim_types.h"
33 #include "DNA_armature_types.h"
34 #include "DNA_camera_types.h"
35 #include "DNA_collection_types.h"
36 #include "DNA_constraint_types.h"
37 #include "DNA_gpencil_types.h"
38 #include "DNA_gpencil_modifier_types.h"
39 #include "DNA_key_types.h"
40 #include "DNA_light_types.h"
41 #include "DNA_lattice_types.h"
42 #include "DNA_material_types.h"
43 #include "DNA_meta_types.h"
44 #include "DNA_mesh_types.h"
45 #include "DNA_meshdata_types.h"
46 #include "DNA_movieclip_types.h"
47 #include "DNA_scene_types.h"
48 #include "DNA_screen_types.h"
49 #include "DNA_sequence_types.h"
50 #include "DNA_shader_fx_types.h"
51 #include "DNA_smoke_types.h"
52 #include "DNA_space_types.h"
53 #include "DNA_view3d_types.h"
54 #include "DNA_world_types.h"
55 #include "DNA_object_types.h"
56 #include "DNA_lightprobe_types.h"
57 #include "DNA_rigidbody_types.h"
58
59 #include "BLI_blenlib.h"
60 #include "BLI_math.h"
61 #include "BLI_threads.h"
62 #include "BLI_utildefines.h"
63 #include "BLI_linklist.h"
64 #include "BLI_kdtree.h"
65
66 #include "BLT_translation.h"
67
68 #include "BKE_pbvh.h"
69 #include "BKE_main.h"
70 #include "BKE_global.h"
71 #include "BKE_idprop.h"
72 #include "BKE_armature.h"
73 #include "BKE_action.h"
74 #include "BKE_deform.h"
75 #include "BKE_DerivedMesh.h"
76 #include "BKE_animsys.h"
77 #include "BKE_anim.h"
78 #include "BKE_collection.h"
79 #include "BKE_constraint.h"
80 #include "BKE_curve.h"
81 #include "BKE_displist.h"
82 #include "BKE_effect.h"
83 #include "BKE_fcurve.h"
84 #include "BKE_gpencil_modifier.h"
85 #include "BKE_icons.h"
86 #include "BKE_key.h"
87 #include "BKE_light.h"
88 #include "BKE_layer.h"
89 #include "BKE_lattice.h"
90 #include "BKE_library.h"
91 #include "BKE_library_query.h"
92 #include "BKE_library_remap.h"
93 #include "BKE_linestyle.h"
94 #include "BKE_mesh.h"
95 #include "BKE_editmesh.h"
96 #include "BKE_mball.h"
97 #include "BKE_modifier.h"
98 #include "BKE_multires.h"
99 #include "BKE_node.h"
100 #include "BKE_object.h"
101 #include "BKE_object_facemap.h"
102 #include "BKE_paint.h"
103 #include "BKE_particle.h"
104 #include "BKE_pointcache.h"
105 #include "BKE_lightprobe.h"
106 #include "BKE_rigidbody.h"
107 #include "BKE_scene.h"
108 #include "BKE_sequencer.h"
109 #include "BKE_shader_fx.h"
110 #include "BKE_speaker.h"
111 #include "BKE_softbody.h"
112 #include "BKE_subsurf.h"
113 #include "BKE_subdiv_ccg.h"
114 #include "BKE_material.h"
115 #include "BKE_camera.h"
116 #include "BKE_image.h"
117 #include "BKE_gpencil.h"
118
119 #include "DEG_depsgraph.h"
120 #include "DEG_depsgraph_query.h"
121
122 #include "DRW_engine.h"
123
124 #ifdef WITH_MOD_FLUID
125 #  include "LBM_fluidsim.h"
126 #endif
127
128 #ifdef WITH_PYTHON
129 #  include "BPY_extern.h"
130 #endif
131
132 #include "CCGSubSurf.h"
133 #include "atomic_ops.h"
134
135 static CLG_LogRef LOG = {"bke.object"};
136
137 /* Vertex parent modifies original BMesh which is not safe for threading.
138  * Ideally such a modification should be handled as a separate DAG update
139  * callback for mesh datablock, but for until it is actually supported use
140  * simpler solution with a mutex lock.
141  *                                               - sergey -
142  */
143 #define VPARENT_THREADING_HACK
144
145 #ifdef VPARENT_THREADING_HACK
146 static ThreadMutex vparent_lock = BLI_MUTEX_INITIALIZER;
147 #endif
148
149 void BKE_object_workob_clear(Object *workob)
150 {
151   memset(workob, 0, sizeof(Object));
152
153   workob->scale[0] = workob->scale[1] = workob->scale[2] = 1.0f;
154   workob->dscale[0] = workob->dscale[1] = workob->dscale[2] = 1.0f;
155   workob->rotmode = ROT_MODE_EUL;
156 }
157
158 void BKE_object_free_particlesystems(Object *ob)
159 {
160   ParticleSystem *psys;
161
162   while ((psys = BLI_pophead(&ob->particlesystem))) {
163     psys_free(ob, psys);
164   }
165 }
166
167 void BKE_object_free_softbody(Object *ob)
168 {
169   sbFree(ob);
170 }
171
172 void BKE_object_free_curve_cache(Object *ob)
173 {
174   if (ob->runtime.curve_cache) {
175     BKE_displist_free(&ob->runtime.curve_cache->disp);
176     BKE_curve_bevelList_free(&ob->runtime.curve_cache->bev);
177     if (ob->runtime.curve_cache->path) {
178       free_path(ob->runtime.curve_cache->path);
179     }
180     BKE_nurbList_free(&ob->runtime.curve_cache->deformed_nurbs);
181     MEM_freeN(ob->runtime.curve_cache);
182     ob->runtime.curve_cache = NULL;
183   }
184 }
185
186 void BKE_object_free_modifiers(Object *ob, const int flag)
187 {
188   ModifierData *md;
189   GpencilModifierData *gp_md;
190
191   while ((md = BLI_pophead(&ob->modifiers))) {
192     modifier_free_ex(md, flag);
193   }
194
195   while ((gp_md = BLI_pophead(&ob->greasepencil_modifiers))) {
196     BKE_gpencil_modifier_free_ex(gp_md, flag);
197   }
198   /* particle modifiers were freed, so free the particlesystems as well */
199   BKE_object_free_particlesystems(ob);
200
201   /* same for softbody */
202   BKE_object_free_softbody(ob);
203
204   /* modifiers may have stored data in the DM cache */
205   BKE_object_free_derived_caches(ob);
206 }
207
208 void BKE_object_free_shaderfx(Object *ob, const int flag)
209 {
210   ShaderFxData *fx;
211
212   while ((fx = BLI_pophead(&ob->shader_fx))) {
213     BKE_shaderfx_free_ex(fx, flag);
214   }
215 }
216
217 void BKE_object_modifier_hook_reset(Object *ob, HookModifierData *hmd)
218 {
219   /* reset functionality */
220   if (hmd->object) {
221     bPoseChannel *pchan = BKE_pose_channel_find_name(hmd->object->pose, hmd->subtarget);
222
223     if (hmd->subtarget[0] && pchan) {
224       float imat[4][4], mat[4][4];
225
226       /* calculate the world-space matrix for the pose-channel target first, then carry on as usual */
227       mul_m4_m4m4(mat, hmd->object->obmat, pchan->pose_mat);
228
229       invert_m4_m4(imat, mat);
230       mul_m4_m4m4(hmd->parentinv, imat, ob->obmat);
231     }
232     else {
233       invert_m4_m4(hmd->object->imat, hmd->object->obmat);
234       mul_m4_m4m4(hmd->parentinv, hmd->object->imat, ob->obmat);
235     }
236   }
237 }
238
239 void BKE_object_modifier_gpencil_hook_reset(Object *ob, HookGpencilModifierData *hmd)
240 {
241   if (hmd->object == NULL) {
242     return;
243   }
244   /* reset functionality */
245   bPoseChannel *pchan = BKE_pose_channel_find_name(hmd->object->pose, hmd->subtarget);
246
247   if (hmd->subtarget[0] && pchan) {
248     float imat[4][4], mat[4][4];
249
250     /* calculate the world-space matrix for the pose-channel target first, then carry on as usual */
251     mul_m4_m4m4(mat, hmd->object->obmat, pchan->pose_mat);
252
253     invert_m4_m4(imat, mat);
254     mul_m4_m4m4(hmd->parentinv, imat, ob->obmat);
255   }
256   else {
257     invert_m4_m4(hmd->object->imat, hmd->object->obmat);
258     mul_m4_m4m4(hmd->parentinv, hmd->object->imat, ob->obmat);
259   }
260 }
261
262 bool BKE_object_support_modifier_type_check(const Object *ob, int modifier_type)
263 {
264   const ModifierTypeInfo *mti;
265
266   mti = modifierType_getInfo(modifier_type);
267
268   /* only geometry objects should be able to get modifiers [#25291] */
269   if (!ELEM(ob->type, OB_MESH, OB_CURVE, OB_SURF, OB_FONT, OB_LATTICE)) {
270     return false;
271   }
272
273   if (ob->type == OB_LATTICE && (mti->flags & eModifierTypeFlag_AcceptsLattice) == 0) {
274     return false;
275   }
276
277   if (!((mti->flags & eModifierTypeFlag_AcceptsCVs) ||
278         (ob->type == OB_MESH && (mti->flags & eModifierTypeFlag_AcceptsMesh)))) {
279     return false;
280   }
281
282   return true;
283 }
284
285 void BKE_object_link_modifiers(Scene *scene, struct Object *ob_dst, const struct Object *ob_src)
286 {
287   ModifierData *md;
288   BKE_object_free_modifiers(ob_dst, 0);
289
290   if (!ELEM(ob_dst->type, OB_MESH, OB_CURVE, OB_SURF, OB_FONT, OB_LATTICE)) {
291     /* only objects listed above can have modifiers and linking them to objects
292      * which doesn't have modifiers stack is quite silly */
293     return;
294   }
295
296   for (md = ob_src->modifiers.first; md; md = md->next) {
297     ModifierData *nmd = NULL;
298
299     if (ELEM(md->type, eModifierType_Hook, eModifierType_Collision)) {
300       continue;
301     }
302
303     if (!BKE_object_support_modifier_type_check(ob_dst, md->type))
304       continue;
305
306     switch (md->type) {
307       case eModifierType_Softbody:
308         BKE_object_copy_softbody(ob_dst, ob_src, 0);
309         break;
310       case eModifierType_Skin:
311         /* ensure skin-node customdata exists */
312         BKE_mesh_ensure_skin_customdata(ob_dst->data);
313         break;
314     }
315
316     nmd = modifier_new(md->type);
317     BLI_strncpy(nmd->name, md->name, sizeof(nmd->name));
318
319     if (md->type == eModifierType_Multires) {
320       /* Has to be done after mod creation, but *before* we actually copy its settings! */
321       multiresModifier_sync_levels_ex(
322           scene, ob_dst, (MultiresModifierData *)md, (MultiresModifierData *)nmd);
323     }
324
325     modifier_copyData(md, nmd);
326     BLI_addtail(&ob_dst->modifiers, nmd);
327     modifier_unique_name(&ob_dst->modifiers, nmd);
328   }
329
330   BKE_object_copy_particlesystems(ob_dst, ob_src, 0);
331
332   /* TODO: smoke?, cloth? */
333 }
334
335 /* Copy CCG related data. Used to sync copy of mesh with reshaped original
336  * mesh.
337  */
338 static void copy_ccg_data(Mesh *mesh_destination, Mesh *mesh_source, int layer_type)
339 {
340   BLI_assert(mesh_destination->totloop == mesh_source->totloop);
341   CustomData *data_destination = &mesh_destination->ldata;
342   CustomData *data_source = &mesh_source->ldata;
343   const int num_elements = mesh_source->totloop;
344   if (!CustomData_has_layer(data_source, layer_type)) {
345     return;
346   }
347   const int layer_index = CustomData_get_layer_index(data_destination, layer_type);
348   CustomData_free_layer(data_destination, layer_type, num_elements, layer_index);
349   BLI_assert(!CustomData_has_layer(data_destination, layer_type));
350   CustomData_add_layer(data_destination, layer_type, CD_CALLOC, NULL, num_elements);
351   BLI_assert(CustomData_has_layer(data_destination, layer_type));
352   CustomData_copy_layer_type_data(data_source, data_destination, layer_type, 0, 0, num_elements);
353 }
354
355 static void object_update_from_subsurf_ccg(Object *object)
356 {
357   /* Currently CCG is only created for Mesh objects. */
358   if (object->type != OB_MESH) {
359     return;
360   }
361   /* Object was never evaluated, so can not have CCG subdivision surface. */
362   Mesh *mesh_eval = object->runtime.mesh_eval;
363   if (mesh_eval == NULL) {
364     return;
365   }
366   SubdivCCG *subdiv_ccg = mesh_eval->runtime.subdiv_ccg;
367   if (subdiv_ccg == NULL) {
368     return;
369   }
370   /* Check whether there is anything to be reshaped. */
371   if (!subdiv_ccg->dirty.coords && !subdiv_ccg->dirty.hidden) {
372     return;
373   }
374   const int tot_level = mesh_eval->runtime.subdiv_ccg_tot_level;
375   Object *object_orig = DEG_get_original_object(object);
376   Mesh *mesh_orig = (Mesh *)object_orig->data;
377   multiresModifier_reshapeFromCCG(tot_level, mesh_orig, subdiv_ccg);
378   /* NOTE: we need to reshape into an original mesh from main database,
379    * allowing:
380    *
381    *  - Update copies of that mesh at any moment.
382    *  - Save the file without doing extra reshape.
383    *  - All the users of the mesh have updated displacement.
384    *
385    * However, the tricky part here is that we only know about sculpted
386    * state of a mesh on an object level, and object is being updated after
387    * mesh datablock is updated. This forces us to:
388    *
389    *  - Update mesh datablock from object evaluation, which is technically
390    *    forbidden, but there is no other place for this yet.
391    *  - Reshape to the original mesh from main database, and then copy updated
392    *    layer to copy of that mesh (since copy of the mesh has decoupled
393    *    custom data layers).
394    *
395    * All this is defeating all the designs we need to follow to allow safe
396    * threaded evaluation, but this is as good as we can make it within the
397    * current sculpt//evaluated mesh design. This is also how we've survived
398    * with old DerivedMesh based solutions. So, while this is all wrong and
399    * needs reconsideration, doesn't seem to be a big stopper for real
400    * production artists.
401    */
402   /* TODO(sergey): Solve this somehow, to be fully stable for threaded
403    * evaluation environment.
404    */
405   /* NOTE: runtime.mesh_orig is what was before assigning mesh_eval,
406    * it is orig as in what was in object_eval->data before evaluating
407    * modifier stack.
408    *
409    * mesh_cow is a copy-on-written version od object_orig->data.
410    */
411   Mesh *mesh_cow = object->runtime.mesh_orig;
412   copy_ccg_data(mesh_cow, mesh_orig, CD_MDISPS);
413   copy_ccg_data(mesh_cow, mesh_orig, CD_GRID_PAINT_MASK);
414   /* Everything is now up-to-date. */
415   subdiv_ccg->dirty.coords = false;
416   subdiv_ccg->dirty.hidden = false;
417 }
418
419 /* free data derived from mesh, called when mesh changes or is freed */
420 void BKE_object_free_derived_caches(Object *ob)
421 {
422   /* Also serves as signal to remake texspace.
423    *
424    * NOTE: This function can be called from threads on different objects
425    * sharing same data datablock. So we need to ensure atomic nature of
426    * data modification here.
427    */
428   if (ob->type == OB_MESH) {
429     Mesh *me = ob->data;
430
431     if (me && me->bb) {
432       atomic_fetch_and_or_int32(&me->bb->flag, BOUNDBOX_DIRTY);
433     }
434   }
435   else if (ELEM(ob->type, OB_SURF, OB_CURVE, OB_FONT)) {
436     Curve *cu = ob->data;
437
438     if (cu && cu->bb) {
439       atomic_fetch_and_or_int32(&cu->bb->flag, BOUNDBOX_DIRTY);
440     }
441   }
442
443   MEM_SAFE_FREE(ob->runtime.bb);
444
445   object_update_from_subsurf_ccg(ob);
446   BKE_object_free_derived_mesh_caches(ob);
447   BKE_armature_cached_bbone_deformation_free(ob);
448
449   if (ob->runtime.mesh_eval != NULL) {
450     Mesh *mesh_eval = ob->runtime.mesh_eval;
451     /* Restore initial pointer. */
452     if (ob->data == mesh_eval) {
453       ob->data = ob->runtime.mesh_orig;
454     }
455     /* Evaluated mesh points to edit mesh, but does not own it. */
456     mesh_eval->edit_mesh = NULL;
457     BKE_mesh_free(mesh_eval);
458     BKE_libblock_free_data(&mesh_eval->id, false);
459     MEM_freeN(mesh_eval);
460     ob->runtime.mesh_eval = NULL;
461   }
462   if (ob->runtime.mesh_deform_eval != NULL) {
463     Mesh *mesh_deform_eval = ob->runtime.mesh_deform_eval;
464     BKE_mesh_free(mesh_deform_eval);
465     BKE_libblock_free_data(&mesh_deform_eval->id, false);
466     MEM_freeN(mesh_deform_eval);
467     ob->runtime.mesh_deform_eval = NULL;
468   }
469
470   BKE_object_free_curve_cache(ob);
471
472   /* clear grease pencil data */
473   DRW_gpencil_freecache(ob);
474 }
475
476 void BKE_object_free_derived_mesh_caches(struct Object *ob)
477 {
478   if (ob->derivedFinal) {
479     ob->derivedFinal->needsFree = 1;
480     ob->derivedFinal->release(ob->derivedFinal);
481     ob->derivedFinal = NULL;
482   }
483   if (ob->derivedDeform) {
484     ob->derivedDeform->needsFree = 1;
485     ob->derivedDeform->release(ob->derivedDeform);
486     ob->derivedDeform = NULL;
487   }
488 }
489
490 void BKE_object_free_caches(Object *object)
491 {
492   ModifierData *md;
493   short update_flag = 0;
494
495   /* Free particle system caches holding paths. */
496   if (object->particlesystem.first) {
497     ParticleSystem *psys;
498     for (psys = object->particlesystem.first; psys != NULL; psys = psys->next) {
499       psys_free_path_cache(psys, psys->edit);
500       update_flag |= ID_RECALC_PSYS_REDO;
501     }
502   }
503
504   /* Free memory used by cached derived meshes in the particle system modifiers. */
505   for (md = object->modifiers.first; md != NULL; md = md->next) {
506     if (md->type == eModifierType_ParticleSystem) {
507       ParticleSystemModifierData *psmd = (ParticleSystemModifierData *)md;
508       if (psmd->mesh_final) {
509         BKE_id_free(NULL, psmd->mesh_final);
510         psmd->mesh_final = NULL;
511         if (psmd->mesh_original) {
512           BKE_id_free(NULL, psmd->mesh_original);
513           psmd->mesh_original = NULL;
514         }
515         psmd->flag |= eParticleSystemFlag_file_loaded;
516         update_flag |= ID_RECALC_GEOMETRY;
517       }
518     }
519   }
520
521   /* NOTE: If object is coming from a duplicator, it might be a temporary
522    * object created by dependency graph, which shares pointers with original
523    * object. In this case we can not free anything.
524    */
525   if ((object->base_flag & BASE_FROM_DUPLI) == 0) {
526     BKE_object_free_derived_caches(object);
527     update_flag |= ID_RECALC_GEOMETRY;
528   }
529
530   /* Tag object for update, so once memory critical operation is over and
531    * scene update routines are back to it's business the object will be
532    * guaranteed to be in a known state.
533    */
534   if (update_flag != 0) {
535     DEG_id_tag_update(&object->id, update_flag);
536   }
537 }
538
539 /** Free (or release) any data used by this object (does not free the object itself). */
540 void BKE_object_free(Object *ob)
541 {
542   BKE_animdata_free((ID *)ob, false);
543
544   DRW_drawdata_free((ID *)ob);
545
546   /* BKE_<id>_free shall never touch to ID->us. Never ever. */
547   BKE_object_free_modifiers(ob, LIB_ID_CREATE_NO_USER_REFCOUNT);
548   BKE_object_free_shaderfx(ob, LIB_ID_CREATE_NO_USER_REFCOUNT);
549
550   MEM_SAFE_FREE(ob->mat);
551   MEM_SAFE_FREE(ob->matbits);
552   MEM_SAFE_FREE(ob->iuser);
553   MEM_SAFE_FREE(ob->runtime.bb);
554
555   BLI_freelistN(&ob->defbase);
556   BLI_freelistN(&ob->fmaps);
557   if (ob->pose) {
558     BKE_pose_free_ex(ob->pose, false);
559     ob->pose = NULL;
560   }
561   if (ob->mpath) {
562     animviz_free_motionpath(ob->mpath);
563     ob->mpath = NULL;
564   }
565
566   BKE_constraints_free_ex(&ob->constraints, false);
567
568   BKE_partdeflect_free(ob->pd);
569   BKE_rigidbody_free_object(ob, NULL);
570   BKE_rigidbody_free_constraint(ob);
571
572   sbFree(ob);
573
574   BKE_sculptsession_free(ob);
575
576   BLI_freelistN(&ob->pc_ids);
577
578   BLI_freelistN(&ob->lodlevels);
579
580   /* Free runtime curves data. */
581   if (ob->runtime.curve_cache) {
582     BKE_curve_bevelList_free(&ob->runtime.curve_cache->bev);
583     if (ob->runtime.curve_cache->path)
584       free_path(ob->runtime.curve_cache->path);
585     MEM_freeN(ob->runtime.curve_cache);
586     ob->runtime.curve_cache = NULL;
587   }
588
589   BKE_previewimg_free(&ob->preview);
590 }
591
592 /* actual check for internal data, not context or flags */
593 bool BKE_object_is_in_editmode(const Object *ob)
594 {
595   if (ob->data == NULL) {
596     return false;
597   }
598
599   switch (ob->type) {
600     case OB_MESH:
601       return ((Mesh *)ob->data)->edit_mesh != NULL;
602     case OB_ARMATURE:
603       return ((bArmature *)ob->data)->edbo != NULL;
604     case OB_FONT:
605       return ((Curve *)ob->data)->editfont != NULL;
606     case OB_MBALL:
607       return ((MetaBall *)ob->data)->editelems != NULL;
608     case OB_LATTICE:
609       return ((Lattice *)ob->data)->editlatt != NULL;
610     case OB_SURF:
611     case OB_CURVE:
612       return ((Curve *)ob->data)->editnurb != NULL;
613     default:
614       return false;
615   }
616 }
617
618 bool BKE_object_is_in_editmode_vgroup(const Object *ob)
619 {
620   return (OB_TYPE_SUPPORT_VGROUP(ob->type) && BKE_object_is_in_editmode(ob));
621 }
622
623 bool BKE_object_data_is_in_editmode(const ID *id)
624 {
625   const short type = GS(id->name);
626   BLI_assert(OB_DATA_SUPPORT_EDITMODE(type));
627   switch (type) {
628     case ID_ME:
629       return ((const Mesh *)id)->edit_mesh != NULL;
630     case ID_CU:
631       return ((((const Curve *)id)->editnurb != NULL) || (((const Curve *)id)->editfont != NULL));
632     case ID_MB:
633       return ((const MetaBall *)id)->editelems != NULL;
634     case ID_LT:
635       return ((const Lattice *)id)->editlatt != NULL;
636     case ID_AR:
637       return ((const bArmature *)id)->edbo != NULL;
638     default:
639       BLI_assert(0);
640       return false;
641   }
642 }
643
644 bool BKE_object_is_in_wpaint_select_vert(const Object *ob)
645 {
646   if (ob->type == OB_MESH) {
647     Mesh *me = ob->data;
648     return ((ob->mode & OB_MODE_WEIGHT_PAINT) && (me->edit_mesh == NULL) &&
649             (ME_EDIT_PAINT_SEL_MODE(me) == SCE_SELECT_VERTEX));
650   }
651
652   return false;
653 }
654
655 bool BKE_object_has_mode_data(const struct Object *ob, eObjectMode object_mode)
656 {
657   if (object_mode & OB_MODE_EDIT) {
658     if (BKE_object_is_in_editmode(ob)) {
659       return true;
660     }
661   }
662   else if (object_mode & OB_MODE_VERTEX_PAINT) {
663     if (ob->sculpt && (ob->sculpt->mode_type == OB_MODE_VERTEX_PAINT)) {
664       return true;
665     }
666   }
667   else if (object_mode & OB_MODE_WEIGHT_PAINT) {
668     if (ob->sculpt && (ob->sculpt->mode_type == OB_MODE_WEIGHT_PAINT)) {
669       return true;
670     }
671   }
672   else if (object_mode & OB_MODE_SCULPT) {
673     if (ob->sculpt && (ob->sculpt->mode_type == OB_MODE_SCULPT)) {
674       return true;
675     }
676   }
677   else if (object_mode & OB_MODE_POSE) {
678     if (ob->pose != NULL) {
679       return true;
680     }
681   }
682   return false;
683 }
684
685 bool BKE_object_is_mode_compat(const struct Object *ob, eObjectMode object_mode)
686 {
687   return ((ob->mode == object_mode) || (ob->mode & object_mode) != 0);
688 }
689
690 /**
691  * Return which parts of the object are visible, as evaluated by depsgraph
692  */
693 int BKE_object_visibility(const Object *ob, const int dag_eval_mode)
694 {
695   if ((ob->base_flag & BASE_VISIBLE) == 0) {
696     return 0;
697   }
698
699   /* Test which components the object has. */
700   int visibility = OB_VISIBLE_SELF;
701   if (ob->particlesystem.first) {
702     visibility |= OB_VISIBLE_INSTANCES | OB_VISIBLE_PARTICLES;
703   }
704   else if (ob->transflag & OB_DUPLI) {
705     visibility |= OB_VISIBLE_INSTANCES;
706   }
707
708   /* Optional hiding of self if there are particles or instancers. */
709   if (visibility & (OB_VISIBLE_PARTICLES | OB_VISIBLE_INSTANCES)) {
710     switch ((eEvaluationMode)dag_eval_mode) {
711       case DAG_EVAL_VIEWPORT:
712         if (!(ob->duplicator_visibility_flag & OB_DUPLI_FLAG_VIEWPORT)) {
713           visibility &= ~OB_VISIBLE_SELF;
714         }
715         break;
716       case DAG_EVAL_RENDER:
717         if (!(ob->duplicator_visibility_flag & OB_DUPLI_FLAG_RENDER)) {
718           visibility &= ~OB_VISIBLE_SELF;
719         }
720         break;
721     }
722   }
723
724   return visibility;
725 }
726
727 bool BKE_object_exists_check(Main *bmain, const Object *obtest)
728 {
729   Object *ob;
730
731   if (obtest == NULL)
732     return false;
733
734   ob = bmain->objects.first;
735   while (ob) {
736     if (ob == obtest)
737       return true;
738     ob = ob->id.next;
739   }
740   return false;
741 }
742
743 /* *************************************************** */
744
745 static const char *get_obdata_defname(int type)
746 {
747   switch (type) {
748     case OB_MESH:
749       return DATA_("Mesh");
750     case OB_CURVE:
751       return DATA_("Curve");
752     case OB_SURF:
753       return DATA_("Surf");
754     case OB_FONT:
755       return DATA_("Text");
756     case OB_MBALL:
757       return DATA_("Mball");
758     case OB_CAMERA:
759       return DATA_("Camera");
760     case OB_LAMP:
761       return CTX_DATA_(BLT_I18NCONTEXT_ID_LIGHT, "Light");
762     case OB_LATTICE:
763       return DATA_("Lattice");
764     case OB_ARMATURE:
765       return DATA_("Armature");
766     case OB_SPEAKER:
767       return DATA_("Speaker");
768     case OB_EMPTY:
769       return DATA_("Empty");
770     case OB_GPENCIL:
771       return DATA_("GPencil");
772     default:
773       CLOG_ERROR(&LOG, "Internal error, bad type: %d", type);
774       return DATA_("Empty");
775   }
776 }
777
778 void *BKE_object_obdata_add_from_type(Main *bmain, int type, const char *name)
779 {
780   if (name == NULL) {
781     name = get_obdata_defname(type);
782   }
783
784   switch (type) {
785     case OB_MESH:
786       return BKE_mesh_add(bmain, name);
787     case OB_CURVE:
788       return BKE_curve_add(bmain, name, OB_CURVE);
789     case OB_SURF:
790       return BKE_curve_add(bmain, name, OB_SURF);
791     case OB_FONT:
792       return BKE_curve_add(bmain, name, OB_FONT);
793     case OB_MBALL:
794       return BKE_mball_add(bmain, name);
795     case OB_CAMERA:
796       return BKE_camera_add(bmain, name);
797     case OB_LAMP:
798       return BKE_light_add(bmain, name);
799     case OB_LATTICE:
800       return BKE_lattice_add(bmain, name);
801     case OB_ARMATURE:
802       return BKE_armature_add(bmain, name);
803     case OB_SPEAKER:
804       return BKE_speaker_add(bmain, name);
805     case OB_LIGHTPROBE:
806       return BKE_lightprobe_add(bmain, name);
807     case OB_GPENCIL:
808       return BKE_gpencil_data_addnew(bmain, name);
809     case OB_EMPTY:
810       return NULL;
811     default:
812       CLOG_ERROR(&LOG, "Internal error, bad type: %d", type);
813       return NULL;
814   }
815 }
816
817 void BKE_object_init(Object *ob)
818 {
819   /* BLI_assert(MEMCMP_STRUCT_AFTER_IS_ZERO(ob, id)); */ /* ob->type is already initialized... */
820
821   copy_v4_fl(ob->color, 1.0f);
822
823   ob->scale[0] = ob->scale[1] = ob->scale[2] = 1.0;
824   ob->dscale[0] = ob->dscale[1] = ob->dscale[2] = 1.0;
825
826   /* objects should default to having Euler XYZ rotations,
827    * but rotations default to quaternions
828    */
829   ob->rotmode = ROT_MODE_EUL;
830
831   unit_axis_angle(ob->rotAxis, &ob->rotAngle);
832   unit_axis_angle(ob->drotAxis, &ob->drotAngle);
833
834   unit_qt(ob->quat);
835   unit_qt(ob->dquat);
836
837   /* rotation locks should be 4D for 4 component rotations by default... */
838   ob->protectflag = OB_LOCK_ROT4D;
839
840   unit_m4(ob->constinv);
841   unit_m4(ob->parentinv);
842   unit_m4(ob->obmat);
843   ob->dt = OB_TEXTURE;
844   ob->empty_drawtype = OB_PLAINAXES;
845   ob->empty_drawsize = 1.0;
846   ob->empty_image_depth = OB_EMPTY_IMAGE_DEPTH_DEFAULT;
847   if (ob->type == OB_EMPTY) {
848     copy_v2_fl(ob->ima_ofs, -0.5f);
849   }
850
851   if (ELEM(ob->type, OB_LAMP, OB_CAMERA, OB_SPEAKER)) {
852     ob->trackflag = OB_NEGZ;
853     ob->upflag = OB_POSY;
854   }
855   else {
856     ob->trackflag = OB_POSY;
857     ob->upflag = OB_POSZ;
858   }
859
860   ob->instance_faces_scale = 1.0;
861
862   ob->col_group = 0x01;
863   ob->col_mask = 0xffff;
864   ob->preview = NULL;
865   ob->duplicator_visibility_flag = OB_DUPLI_FLAG_VIEWPORT | OB_DUPLI_FLAG_RENDER;
866
867   /* NT fluid sim defaults */
868   ob->fluidsimSettings = NULL;
869
870   BLI_listbase_clear(&ob->pc_ids);
871
872   /* Animation Visualization defaults */
873   animviz_settings_init(&ob->avs);
874 }
875
876 /* more general add: creates minimum required data, but without vertices etc. */
877 Object *BKE_object_add_only_object(Main *bmain, int type, const char *name)
878 {
879   Object *ob;
880
881   if (!name)
882     name = get_obdata_defname(type);
883
884   ob = BKE_libblock_alloc(bmain, ID_OB, name, 0);
885
886   /* We increase object user count when linking to Collections. */
887   id_us_min(&ob->id);
888
889   /* default object vars */
890   ob->type = type;
891
892   BKE_object_init(ob);
893
894   return ob;
895 }
896
897 static Object *object_add_common(Main *bmain, ViewLayer *view_layer, int type, const char *name)
898 {
899   Object *ob;
900
901   ob = BKE_object_add_only_object(bmain, type, name);
902   ob->data = BKE_object_obdata_add_from_type(bmain, type, name);
903   BKE_view_layer_base_deselect_all(view_layer);
904
905   DEG_id_tag_update_ex(
906       bmain, &ob->id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY | ID_RECALC_ANIMATION);
907   return ob;
908 }
909
910 /**
911  * General add: to scene, with layer from area and default name
912  *
913  * Object is added to the active Collection.
914  * If there is no linked collection to the active ViewLayer we create a new one.
915  */
916 /* creates minimum required data, but without vertices etc. */
917 Object *BKE_object_add(
918     Main *bmain, Scene *UNUSED(scene), ViewLayer *view_layer, int type, const char *name)
919 {
920   Object *ob;
921   Base *base;
922   LayerCollection *layer_collection;
923
924   ob = object_add_common(bmain, view_layer, type, name);
925
926   layer_collection = BKE_layer_collection_get_active(view_layer);
927   BKE_collection_object_add(bmain, layer_collection->collection, ob);
928
929   base = BKE_view_layer_base_find(view_layer, ob);
930   BKE_view_layer_base_select_and_set_active(view_layer, base);
931
932   return ob;
933 }
934
935 /**
936  * Add a new object, using another one as a reference
937  *
938  * \param ob_src: object to use to determine the collections of the new object.
939  */
940 Object *BKE_object_add_from(
941     Main *bmain, Scene *scene, ViewLayer *view_layer, int type, const char *name, Object *ob_src)
942 {
943   Object *ob;
944   Base *base;
945
946   ob = object_add_common(bmain, view_layer, type, name);
947   BKE_collection_object_add_from(bmain, scene, ob_src, ob);
948
949   base = BKE_view_layer_base_find(view_layer, ob);
950   BKE_view_layer_base_select_and_set_active(view_layer, base);
951
952   return ob;
953 }
954
955 /**
956  * Add a new object, but assign the given datablock as the ob->data
957  * for the newly created object.
958  *
959  * \param data: The datablock to assign as ob->data for the new object.
960  *             This is assumed to be of the correct type.
961  * \param do_id_user: If true, id_us_plus() will be called on data when
962  *                 assigning it to the object.
963  */
964 Object *BKE_object_add_for_data(
965     Main *bmain, ViewLayer *view_layer, int type, const char *name, ID *data, bool do_id_user)
966 {
967   Object *ob;
968   Base *base;
969   LayerCollection *layer_collection;
970
971   /* same as object_add_common, except we don't create new ob->data */
972   ob = BKE_object_add_only_object(bmain, type, name);
973   ob->data = data;
974   if (do_id_user)
975     id_us_plus(data);
976
977   BKE_view_layer_base_deselect_all(view_layer);
978   DEG_id_tag_update_ex(
979       bmain, &ob->id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY | ID_RECALC_ANIMATION);
980
981   layer_collection = BKE_layer_collection_get_active(view_layer);
982   BKE_collection_object_add(bmain, layer_collection->collection, ob);
983
984   base = BKE_view_layer_base_find(view_layer, ob);
985   BKE_view_layer_base_select_and_set_active(view_layer, base);
986
987   return ob;
988 }
989
990 void BKE_object_copy_softbody(struct Object *ob_dst, const struct Object *ob_src, const int flag)
991 {
992   SoftBody *sb = ob_src->soft;
993   SoftBody *sbn;
994   bool tagged_no_main = ob_dst->id.tag & LIB_TAG_NO_MAIN;
995
996   ob_dst->softflag = ob_src->softflag;
997   if (sb == NULL) {
998     ob_dst->soft = NULL;
999     return;
1000   }
1001
1002   sbn = MEM_dupallocN(sb);
1003
1004   if ((flag & LIB_ID_COPY_CACHES) == 0) {
1005     sbn->totspring = sbn->totpoint = 0;
1006     sbn->bpoint = NULL;
1007     sbn->bspring = NULL;
1008   }
1009   else {
1010     sbn->totspring = sb->totspring;
1011     sbn->totpoint = sb->totpoint;
1012
1013     if (sbn->bpoint) {
1014       int i;
1015
1016       sbn->bpoint = MEM_dupallocN(sbn->bpoint);
1017
1018       for (i = 0; i < sbn->totpoint; i++) {
1019         if (sbn->bpoint[i].springs)
1020           sbn->bpoint[i].springs = MEM_dupallocN(sbn->bpoint[i].springs);
1021       }
1022     }
1023
1024     if (sb->bspring)
1025       sbn->bspring = MEM_dupallocN(sb->bspring);
1026   }
1027
1028   sbn->keys = NULL;
1029   sbn->totkey = sbn->totpointkey = 0;
1030
1031   sbn->scratch = NULL;
1032
1033   if (tagged_no_main == 0) {
1034     sbn->shared = MEM_dupallocN(sb->shared);
1035     sbn->shared->pointcache = BKE_ptcache_copy_list(
1036         &sbn->shared->ptcaches, &sb->shared->ptcaches, flag);
1037   }
1038
1039   if (sb->effector_weights)
1040     sbn->effector_weights = MEM_dupallocN(sb->effector_weights);
1041
1042   ob_dst->soft = sbn;
1043 }
1044
1045 ParticleSystem *BKE_object_copy_particlesystem(ParticleSystem *psys, const int flag)
1046 {
1047   ParticleSystem *psysn = MEM_dupallocN(psys);
1048
1049   psys_copy_particles(psysn, psys);
1050
1051   if (psys->clmd) {
1052     psysn->clmd = (ClothModifierData *)modifier_new(eModifierType_Cloth);
1053     modifier_copyData_ex((ModifierData *)psys->clmd, (ModifierData *)psysn->clmd, flag);
1054     psys->hair_in_mesh = psys->hair_out_mesh = NULL;
1055   }
1056
1057   BLI_duplicatelist(&psysn->targets, &psys->targets);
1058
1059   psysn->pathcache = NULL;
1060   psysn->childcache = NULL;
1061   psysn->edit = NULL;
1062   psysn->pdd = NULL;
1063   psysn->effectors = NULL;
1064   psysn->tree = NULL;
1065   psysn->bvhtree = NULL;
1066   psysn->batch_cache = NULL;
1067
1068   BLI_listbase_clear(&psysn->pathcachebufs);
1069   BLI_listbase_clear(&psysn->childcachebufs);
1070
1071   if (flag & LIB_ID_CREATE_NO_MAIN) {
1072     BLI_assert((psys->flag & PSYS_SHARED_CACHES) == 0);
1073     psysn->flag |= PSYS_SHARED_CACHES;
1074     BLI_assert(psysn->pointcache != NULL);
1075   }
1076   else {
1077     psysn->pointcache = BKE_ptcache_copy_list(&psysn->ptcaches, &psys->ptcaches, flag);
1078   }
1079
1080   /* XXX - from reading existing code this seems correct but intended usage of
1081    * pointcache should /w cloth should be added in 'ParticleSystem' - campbell */
1082   if (psysn->clmd) {
1083     psysn->clmd->point_cache = psysn->pointcache;
1084   }
1085
1086   if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
1087     id_us_plus((ID *)psysn->part);
1088   }
1089
1090   return psysn;
1091 }
1092
1093 void BKE_object_copy_particlesystems(Object *ob_dst, const Object *ob_src, const int flag)
1094 {
1095   ParticleSystem *psys, *npsys;
1096   ModifierData *md;
1097
1098   if (ob_dst->type != OB_MESH) {
1099     /* currently only mesh objects can have soft body */
1100     return;
1101   }
1102
1103   BLI_listbase_clear(&ob_dst->particlesystem);
1104   for (psys = ob_src->particlesystem.first; psys; psys = psys->next) {
1105     npsys = BKE_object_copy_particlesystem(psys, flag);
1106
1107     BLI_addtail(&ob_dst->particlesystem, npsys);
1108
1109     /* need to update particle modifiers too */
1110     for (md = ob_dst->modifiers.first; md; md = md->next) {
1111       if (md->type == eModifierType_ParticleSystem) {
1112         ParticleSystemModifierData *psmd = (ParticleSystemModifierData *)md;
1113         if (psmd->psys == psys)
1114           psmd->psys = npsys;
1115       }
1116       else if (md->type == eModifierType_DynamicPaint) {
1117         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *)md;
1118         if (pmd->brush) {
1119           if (pmd->brush->psys == psys) {
1120             pmd->brush->psys = npsys;
1121           }
1122         }
1123       }
1124       else if (md->type == eModifierType_Smoke) {
1125         SmokeModifierData *smd = (SmokeModifierData *)md;
1126
1127         if (smd->type == MOD_SMOKE_TYPE_FLOW) {
1128           if (smd->flow) {
1129             if (smd->flow->psys == psys)
1130               smd->flow->psys = npsys;
1131           }
1132         }
1133       }
1134     }
1135   }
1136 }
1137
1138 static void copy_object_pose(Object *obn, const Object *ob, const int flag)
1139 {
1140   bPoseChannel *chan;
1141
1142   /* note: need to clear obn->pose pointer first,
1143    * so that BKE_pose_copy_data works (otherwise there's a crash) */
1144   obn->pose = NULL;
1145   BKE_pose_copy_data_ex(&obn->pose, ob->pose, flag, true); /* true = copy constraints */
1146
1147   for (chan = obn->pose->chanbase.first; chan; chan = chan->next) {
1148     bConstraint *con;
1149
1150     chan->flag &= ~(POSE_LOC | POSE_ROT | POSE_SIZE);
1151
1152     /* XXX Remapping object pointing onto itself should be handled by generic BKE_library_remap stuff, but...
1153      *     the flush_constraint_targets callback am not sure about, so will delay that for now. */
1154     for (con = chan->constraints.first; con; con = con->next) {
1155       const bConstraintTypeInfo *cti = BKE_constraint_typeinfo_get(con);
1156       ListBase targets = {NULL, NULL};
1157       bConstraintTarget *ct;
1158
1159       if (cti && cti->get_constraint_targets) {
1160         cti->get_constraint_targets(con, &targets);
1161
1162         for (ct = targets.first; ct; ct = ct->next) {
1163           if (ct->tar == ob)
1164             ct->tar = obn;
1165         }
1166
1167         if (cti->flush_constraint_targets)
1168           cti->flush_constraint_targets(con, &targets, 0);
1169       }
1170     }
1171   }
1172 }
1173
1174 static void copy_object_lod(Object *obn, const Object *ob, const int UNUSED(flag))
1175 {
1176   BLI_duplicatelist(&obn->lodlevels, &ob->lodlevels);
1177
1178   obn->currentlod = (LodLevel *)obn->lodlevels.first;
1179 }
1180
1181 bool BKE_object_pose_context_check(const Object *ob)
1182 {
1183   if ((ob) && (ob->type == OB_ARMATURE) && (ob->pose) && (ob->mode & OB_MODE_POSE)) {
1184     return true;
1185   }
1186   else {
1187     return false;
1188   }
1189 }
1190
1191 Object *BKE_object_pose_armature_get(Object *ob)
1192 {
1193   if (ob == NULL)
1194     return NULL;
1195
1196   if (BKE_object_pose_context_check(ob))
1197     return ob;
1198
1199   ob = modifiers_isDeformedByArmature(ob);
1200
1201   /* Only use selected check when non-active. */
1202   if (BKE_object_pose_context_check(ob))
1203     return ob;
1204
1205   return NULL;
1206 }
1207
1208 Object *BKE_object_pose_armature_get_visible(Object *ob, ViewLayer *view_layer, View3D *v3d)
1209 {
1210   Object *ob_armature = BKE_object_pose_armature_get(ob);
1211   if (ob_armature) {
1212     Base *base = BKE_view_layer_base_find(view_layer, ob_armature);
1213     if (base) {
1214       if (BASE_VISIBLE(v3d, base)) {
1215         return ob_armature;
1216       }
1217     }
1218   }
1219   return NULL;
1220 }
1221
1222 /**
1223  * Access pose array with special check to get pose object when in weight paint mode.
1224  */
1225 Object **BKE_object_pose_array_get_ex(ViewLayer *view_layer,
1226                                       View3D *v3d,
1227                                       uint *r_objects_len,
1228                                       bool unique)
1229 {
1230   Object *ob_active = OBACT(view_layer);
1231   Object *ob_pose = BKE_object_pose_armature_get(ob_active);
1232   Object **objects = NULL;
1233   if (ob_pose == ob_active) {
1234     objects = BKE_view_layer_array_from_objects_in_mode(view_layer,
1235                                                         v3d,
1236                                                         r_objects_len,
1237                                                         {
1238                                                             .object_mode = OB_MODE_POSE,
1239                                                             .no_dup_data = unique,
1240                                                         });
1241   }
1242   else if (ob_pose != NULL) {
1243     *r_objects_len = 1;
1244     objects = MEM_mallocN(sizeof(*objects), __func__);
1245     objects[0] = ob_pose;
1246   }
1247   else {
1248     *r_objects_len = 0;
1249     objects = MEM_mallocN(0, __func__);
1250   }
1251   return objects;
1252 }
1253 Object **BKE_object_pose_array_get_unique(ViewLayer *view_layer, View3D *v3d, uint *r_objects_len)
1254 {
1255   return BKE_object_pose_array_get_ex(view_layer, v3d, r_objects_len, true);
1256 }
1257 Object **BKE_object_pose_array_get(ViewLayer *view_layer, View3D *v3d, uint *r_objects_len)
1258 {
1259   return BKE_object_pose_array_get_ex(view_layer, v3d, r_objects_len, false);
1260 }
1261
1262 Base **BKE_object_pose_base_array_get_ex(ViewLayer *view_layer,
1263                                          View3D *v3d,
1264                                          uint *r_bases_len,
1265                                          bool unique)
1266 {
1267   Base *base_active = BASACT(view_layer);
1268   Object *ob_pose = base_active ? BKE_object_pose_armature_get(base_active->object) : NULL;
1269   Base *base_pose = NULL;
1270   Base **bases = NULL;
1271
1272   if (base_active) {
1273     if (ob_pose == base_active->object) {
1274       base_pose = base_active;
1275     }
1276     else {
1277       base_pose = BKE_view_layer_base_find(view_layer, ob_pose);
1278     }
1279   }
1280
1281   if (base_active && (base_pose == base_active)) {
1282     bases = BKE_view_layer_array_from_bases_in_mode(view_layer,
1283                                                     v3d,
1284                                                     r_bases_len,
1285                                                     {
1286                                                         .object_mode = OB_MODE_POSE,
1287                                                         .no_dup_data = unique,
1288                                                     });
1289   }
1290   else if (base_pose != NULL) {
1291     *r_bases_len = 1;
1292     bases = MEM_mallocN(sizeof(*bases), __func__);
1293     bases[0] = base_pose;
1294   }
1295   else {
1296     *r_bases_len = 0;
1297     bases = MEM_mallocN(0, __func__);
1298   }
1299   return bases;
1300 }
1301 Base **BKE_object_pose_base_array_get_unique(ViewLayer *view_layer, View3D *v3d, uint *r_bases_len)
1302 {
1303   return BKE_object_pose_base_array_get_ex(view_layer, v3d, r_bases_len, true);
1304 }
1305 Base **BKE_object_pose_base_array_get(ViewLayer *view_layer, View3D *v3d, uint *r_bases_len)
1306 {
1307   return BKE_object_pose_base_array_get_ex(view_layer, v3d, r_bases_len, false);
1308 }
1309
1310 void BKE_object_transform_copy(Object *ob_tar, const Object *ob_src)
1311 {
1312   copy_v3_v3(ob_tar->loc, ob_src->loc);
1313   copy_v3_v3(ob_tar->rot, ob_src->rot);
1314   copy_v3_v3(ob_tar->quat, ob_src->quat);
1315   copy_v3_v3(ob_tar->rotAxis, ob_src->rotAxis);
1316   ob_tar->rotAngle = ob_src->rotAngle;
1317   ob_tar->rotmode = ob_src->rotmode;
1318   copy_v3_v3(ob_tar->scale, ob_src->scale);
1319 }
1320
1321 /**
1322  * Only copy internal data of Object ID from source to already allocated/initialized destination.
1323  * You probably never want to use that directly, use BKE_id_copy or BKE_id_copy_ex for typical needs.
1324  *
1325  * WARNING! This function will not handle ID user count!
1326  *
1327  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
1328  */
1329 void BKE_object_copy_data(Main *bmain, Object *ob_dst, const Object *ob_src, const int flag)
1330 {
1331   ModifierData *md;
1332   GpencilModifierData *gmd;
1333   ShaderFxData *fx;
1334
1335   /* Do not copy runtime data. */
1336   BKE_object_runtime_reset_on_copy(ob_dst, flag);
1337
1338   /* We never handle usercount here for own data. */
1339   const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT;
1340
1341   if (ob_src->totcol) {
1342     ob_dst->mat = MEM_dupallocN(ob_src->mat);
1343     ob_dst->matbits = MEM_dupallocN(ob_src->matbits);
1344     ob_dst->totcol = ob_src->totcol;
1345   }
1346   else if (ob_dst->mat != NULL || ob_dst->matbits != NULL) {
1347     /* This shall not be needed, but better be safe than sorry. */
1348     BLI_assert(!"Object copy: non-NULL material pointers with zero counter, should not happen.");
1349     ob_dst->mat = NULL;
1350     ob_dst->matbits = NULL;
1351   }
1352
1353   if (ob_src->iuser)
1354     ob_dst->iuser = MEM_dupallocN(ob_src->iuser);
1355
1356   if (ob_src->runtime.bb)
1357     ob_dst->runtime.bb = MEM_dupallocN(ob_src->runtime.bb);
1358
1359   BLI_listbase_clear(&ob_dst->modifiers);
1360
1361   for (md = ob_src->modifiers.first; md; md = md->next) {
1362     ModifierData *nmd = modifier_new(md->type);
1363     BLI_strncpy(nmd->name, md->name, sizeof(nmd->name));
1364     modifier_copyData_ex(md, nmd, flag_subdata);
1365     BLI_addtail(&ob_dst->modifiers, nmd);
1366   }
1367
1368   BLI_listbase_clear(&ob_dst->greasepencil_modifiers);
1369
1370   for (gmd = ob_src->greasepencil_modifiers.first; gmd; gmd = gmd->next) {
1371     GpencilModifierData *nmd = BKE_gpencil_modifier_new(gmd->type);
1372     BLI_strncpy(nmd->name, gmd->name, sizeof(nmd->name));
1373     BKE_gpencil_modifier_copyData_ex(gmd, nmd, flag_subdata);
1374     BLI_addtail(&ob_dst->greasepencil_modifiers, nmd);
1375   }
1376
1377   BLI_listbase_clear(&ob_dst->shader_fx);
1378
1379   for (fx = ob_src->shader_fx.first; fx; fx = fx->next) {
1380     ShaderFxData *nfx = BKE_shaderfx_new(fx->type);
1381     BLI_strncpy(nfx->name, fx->name, sizeof(nfx->name));
1382     BKE_shaderfx_copyData_ex(fx, nfx, flag_subdata);
1383     BLI_addtail(&ob_dst->shader_fx, nfx);
1384   }
1385
1386   if (ob_src->pose) {
1387     copy_object_pose(ob_dst, ob_src, flag_subdata);
1388     /* backwards compat... non-armatures can get poses in older files? */
1389     if (ob_src->type == OB_ARMATURE) {
1390       const bool do_pose_id_user = (flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0;
1391       BKE_pose_rebuild(bmain, ob_dst, ob_dst->data, do_pose_id_user);
1392     }
1393   }
1394   defgroup_copy_list(&ob_dst->defbase, &ob_src->defbase);
1395   BKE_object_facemap_copy_list(&ob_dst->fmaps, &ob_src->fmaps);
1396   BKE_constraints_copy_ex(&ob_dst->constraints, &ob_src->constraints, flag_subdata, true);
1397
1398   ob_dst->mode = ob_dst->type != OB_GPENCIL ? OB_MODE_OBJECT : ob_dst->mode;
1399   ob_dst->sculpt = NULL;
1400
1401   if (ob_src->pd) {
1402     ob_dst->pd = MEM_dupallocN(ob_src->pd);
1403     if (ob_dst->pd->rng) {
1404       ob_dst->pd->rng = MEM_dupallocN(ob_src->pd->rng);
1405     }
1406   }
1407   BKE_object_copy_softbody(ob_dst, ob_src, flag_subdata);
1408   ob_dst->rigidbody_object = BKE_rigidbody_copy_object(ob_src, flag_subdata);
1409   ob_dst->rigidbody_constraint = BKE_rigidbody_copy_constraint(ob_src, flag_subdata);
1410
1411   BKE_object_copy_particlesystems(ob_dst, ob_src, flag_subdata);
1412
1413   ob_dst->derivedDeform = NULL;
1414   ob_dst->derivedFinal = NULL;
1415
1416   BLI_listbase_clear((ListBase *)&ob_dst->drawdata);
1417   BLI_listbase_clear(&ob_dst->pc_ids);
1418
1419   ob_dst->avs = ob_src->avs;
1420   ob_dst->mpath = animviz_copy_motionpath(ob_src->mpath);
1421
1422   copy_object_lod(ob_dst, ob_src, flag_subdata);
1423
1424   /* Do not copy object's preview (mostly due to the fact renderers create temp copy of objects). */
1425   if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0 && false) { /* XXX TODO temp hack */
1426     BKE_previewimg_id_copy(&ob_dst->id, &ob_src->id);
1427   }
1428   else {
1429     ob_dst->preview = NULL;
1430   }
1431 }
1432
1433 /* copy objects, will re-initialize cached simulation data */
1434 Object *BKE_object_copy(Main *bmain, const Object *ob)
1435 {
1436   Object *ob_copy;
1437   BKE_id_copy(bmain, &ob->id, (ID **)&ob_copy);
1438
1439   /* We increase object user count when linking to Collections. */
1440   id_us_min(&ob_copy->id);
1441
1442   return ob_copy;
1443 }
1444
1445 /** Perform deep-copy of object and its 'children' data-blocks (obdata, materials, actions, etc.).
1446  *
1447  * \param dupflag Controls which sub-data are also duplicated (see #eDupli_ID_Flags in DNA_userdef_types.h).
1448  *
1449  * \note This function does not do any remapping to new IDs, caller must do it (\a #BKE_libblock_relink_to_newid()).
1450  * \note Caller MUST free \a newid pointers itself (#BKE_main_id_clear_newpoins()) and call updates of DEG too
1451  *       (#DAG_relations_tag_update()).
1452  */
1453 Object *BKE_object_duplicate(Main *bmain, const Object *ob, const int dupflag)
1454 {
1455   Material ***matarar;
1456   ID *id;
1457   int a, didit;
1458   Object *obn = BKE_object_copy(bmain, ob);
1459
1460   /* 0 == full linked. */
1461   if (dupflag == 0) {
1462     return obn;
1463   }
1464
1465 #define ID_NEW_REMAP_US(a) \
1466   if ((a)->id.newid) { \
1467     (a) = (void *)(a)->id.newid; \
1468     (a)->id.us++; \
1469   }
1470 #define ID_NEW_REMAP_US2(a) \
1471   if (((ID *)a)->newid) { \
1472     (a) = ((ID *)a)->newid; \
1473     ((ID *)a)->us++; \
1474   }
1475
1476   /* duplicates using userflags */
1477   if (dupflag & USER_DUP_ACT) {
1478     BKE_animdata_copy_id_action(bmain, &obn->id, true);
1479   }
1480
1481   if (dupflag & USER_DUP_MAT) {
1482     for (a = 0; a < obn->totcol; a++) {
1483       id = (ID *)obn->mat[a];
1484       if (id) {
1485         ID_NEW_REMAP_US(obn->mat[a])
1486         else
1487         {
1488           obn->mat[a] = ID_NEW_SET(obn->mat[a], BKE_material_copy(bmain, obn->mat[a]));
1489         }
1490         id_us_min(id);
1491
1492         if (dupflag & USER_DUP_ACT) {
1493           BKE_animdata_copy_id_action(bmain, &obn->mat[a]->id, true);
1494         }
1495       }
1496     }
1497   }
1498   if (dupflag & USER_DUP_PSYS) {
1499     ParticleSystem *psys;
1500     for (psys = obn->particlesystem.first; psys; psys = psys->next) {
1501       id = (ID *)psys->part;
1502       if (id) {
1503         ID_NEW_REMAP_US(psys->part)
1504         else
1505         {
1506           psys->part = ID_NEW_SET(psys->part, BKE_particlesettings_copy(bmain, psys->part));
1507         }
1508
1509         if (dupflag & USER_DUP_ACT) {
1510           BKE_animdata_copy_id_action(bmain, &psys->part->id, true);
1511         }
1512
1513         id_us_min(id);
1514       }
1515     }
1516   }
1517
1518   id = obn->data;
1519   didit = 0;
1520
1521   switch (obn->type) {
1522     case OB_MESH:
1523       if (dupflag & USER_DUP_MESH) {
1524         ID_NEW_REMAP_US2(obn->data)
1525         else
1526         {
1527           obn->data = ID_NEW_SET(obn->data, BKE_mesh_copy(bmain, obn->data));
1528           didit = 1;
1529         }
1530         id_us_min(id);
1531       }
1532       break;
1533     case OB_CURVE:
1534       if (dupflag & USER_DUP_CURVE) {
1535         ID_NEW_REMAP_US2(obn->data)
1536         else
1537         {
1538           obn->data = ID_NEW_SET(obn->data, BKE_curve_copy(bmain, obn->data));
1539           didit = 1;
1540         }
1541         id_us_min(id);
1542       }
1543       break;
1544     case OB_SURF:
1545       if (dupflag & USER_DUP_SURF) {
1546         ID_NEW_REMAP_US2(obn->data)
1547         else
1548         {
1549           obn->data = ID_NEW_SET(obn->data, BKE_curve_copy(bmain, obn->data));
1550           didit = 1;
1551         }
1552         id_us_min(id);
1553       }
1554       break;
1555     case OB_FONT:
1556       if (dupflag & USER_DUP_FONT) {
1557         ID_NEW_REMAP_US2(obn->data)
1558         else
1559         {
1560           obn->data = ID_NEW_SET(obn->data, BKE_curve_copy(bmain, obn->data));
1561           didit = 1;
1562         }
1563         id_us_min(id);
1564       }
1565       break;
1566     case OB_MBALL:
1567       if (dupflag & USER_DUP_MBALL) {
1568         ID_NEW_REMAP_US2(obn->data)
1569         else
1570         {
1571           obn->data = ID_NEW_SET(obn->data, BKE_mball_copy(bmain, obn->data));
1572           didit = 1;
1573         }
1574         id_us_min(id);
1575       }
1576       break;
1577     case OB_LAMP:
1578       if (dupflag & USER_DUP_LAMP) {
1579         ID_NEW_REMAP_US2(obn->data)
1580         else
1581         {
1582           obn->data = ID_NEW_SET(obn->data, BKE_light_copy(bmain, obn->data));
1583           didit = 1;
1584         }
1585         id_us_min(id);
1586       }
1587       break;
1588     case OB_ARMATURE:
1589       if (dupflag != 0) {
1590         DEG_id_tag_update(&obn->id, ID_RECALC_GEOMETRY);
1591         if (obn->pose)
1592           BKE_pose_tag_recalc(bmain, obn->pose);
1593         if (dupflag & USER_DUP_ARM) {
1594           ID_NEW_REMAP_US2(obn->data)
1595           else
1596           {
1597             obn->data = ID_NEW_SET(obn->data, BKE_armature_copy(bmain, obn->data));
1598             BKE_pose_rebuild(bmain, obn, obn->data, true);
1599             didit = 1;
1600           }
1601           id_us_min(id);
1602         }
1603       }
1604       break;
1605     case OB_LATTICE:
1606       if (dupflag != 0) {
1607         ID_NEW_REMAP_US2(obn->data)
1608         else
1609         {
1610           obn->data = ID_NEW_SET(obn->data, BKE_lattice_copy(bmain, obn->data));
1611           didit = 1;
1612         }
1613         id_us_min(id);
1614       }
1615       break;
1616     case OB_CAMERA:
1617       if (dupflag != 0) {
1618         ID_NEW_REMAP_US2(obn->data)
1619         else
1620         {
1621           obn->data = ID_NEW_SET(obn->data, BKE_camera_copy(bmain, obn->data));
1622           didit = 1;
1623         }
1624         id_us_min(id);
1625       }
1626       break;
1627     case OB_LIGHTPROBE:
1628       if (dupflag != 0) {
1629         ID_NEW_REMAP_US2(obn->data)
1630         else
1631         {
1632           obn->data = ID_NEW_SET(obn->data, BKE_lightprobe_copy(bmain, obn->data));
1633           didit = 1;
1634         }
1635         id_us_min(id);
1636       }
1637       break;
1638     case OB_SPEAKER:
1639       if (dupflag != 0) {
1640         ID_NEW_REMAP_US2(obn->data)
1641         else
1642         {
1643           obn->data = ID_NEW_SET(obn->data, BKE_speaker_copy(bmain, obn->data));
1644           didit = 1;
1645         }
1646         id_us_min(id);
1647       }
1648       break;
1649     case OB_GPENCIL:
1650       if (dupflag != 0) {
1651         ID_NEW_REMAP_US2(obn->data)
1652         else
1653         {
1654           obn->data = ID_NEW_SET(obn->data, BKE_gpencil_copy(bmain, obn->data));
1655           didit = 1;
1656         }
1657         id_us_min(id);
1658       }
1659       break;
1660   }
1661
1662   /* Check if obdata is copied. */
1663   if (didit) {
1664     Key *key = BKE_key_from_object(obn);
1665
1666     Key *oldkey = BKE_key_from_object(ob);
1667     if (oldkey != NULL) {
1668       ID_NEW_SET(oldkey, key);
1669     }
1670
1671     if (dupflag & USER_DUP_ACT) {
1672       BKE_animdata_copy_id_action(bmain, (ID *)obn->data, true);
1673       if (key) {
1674         BKE_animdata_copy_id_action(bmain, (ID *)key, true);
1675       }
1676     }
1677
1678     if (dupflag & USER_DUP_MAT) {
1679       matarar = give_matarar(obn);
1680       if (matarar) {
1681         for (a = 0; a < obn->totcol; a++) {
1682           id = (ID *)(*matarar)[a];
1683           if (id) {
1684             ID_NEW_REMAP_US((*matarar)[a])
1685             else
1686             {
1687               (*matarar)[a] = ID_NEW_SET((*matarar)[a], BKE_material_copy(bmain, (*matarar)[a]));
1688             }
1689             id_us_min(id);
1690           }
1691         }
1692       }
1693     }
1694   }
1695
1696 #undef ID_NEW_REMAP_US
1697 #undef ID_NEW_REMAP_US2
1698
1699   if (ob->data != NULL) {
1700     DEG_id_tag_update_ex(bmain, (ID *)obn->data, ID_RECALC_EDITORS);
1701   }
1702
1703   return obn;
1704 }
1705
1706 void BKE_object_make_local_ex(Main *bmain,
1707                               Object *ob,
1708                               const bool lib_local,
1709                               const bool clear_proxy)
1710 {
1711   bool is_local = false, is_lib = false;
1712
1713   /* - only lib users: do nothing (unless force_local is set)
1714    * - only local users: set flag
1715    * - mixed: make copy
1716    * In case we make a whole lib's content local, we always want to localize, and we skip remapping (done later).
1717    */
1718
1719   if (!ID_IS_LINKED(ob)) {
1720     return;
1721   }
1722
1723   BKE_library_ID_test_usages(bmain, ob, &is_local, &is_lib);
1724
1725   if (lib_local || is_local) {
1726     if (!is_lib) {
1727       id_clear_lib_data(bmain, &ob->id);
1728       BKE_id_expand_local(bmain, &ob->id);
1729       if (clear_proxy) {
1730         if (ob->proxy_from != NULL) {
1731           ob->proxy_from->proxy = NULL;
1732           ob->proxy_from->proxy_group = NULL;
1733         }
1734         ob->proxy = ob->proxy_from = ob->proxy_group = NULL;
1735       }
1736     }
1737     else {
1738       Object *ob_new = BKE_object_copy(bmain, ob);
1739
1740       ob_new->id.us = 0;
1741       ob_new->proxy = ob_new->proxy_from = ob_new->proxy_group = NULL;
1742
1743       /* setting newid is mandatory for complex make_lib_local logic... */
1744       ID_NEW_SET(ob, ob_new);
1745
1746       if (!lib_local) {
1747         BKE_libblock_remap(bmain, ob, ob_new, ID_REMAP_SKIP_INDIRECT_USAGE);
1748       }
1749     }
1750   }
1751 }
1752
1753 void BKE_object_make_local(Main *bmain, Object *ob, const bool lib_local)
1754 {
1755   BKE_object_make_local_ex(bmain, ob, lib_local, true);
1756 }
1757
1758 /* Returns true if the Object is from an external blend file (libdata) */
1759 bool BKE_object_is_libdata(const Object *ob)
1760 {
1761   return (ob && ID_IS_LINKED(ob));
1762 }
1763
1764 /* Returns true if the Object data is from an external blend file (libdata) */
1765 bool BKE_object_obdata_is_libdata(const Object *ob)
1766 {
1767   /* Linked objects with local obdata are forbidden! */
1768   BLI_assert(!ob || !ob->data || (ID_IS_LINKED(ob) ? ID_IS_LINKED(ob->data) : true));
1769   return (ob && ob->data && ID_IS_LINKED(ob->data));
1770 }
1771
1772 /* *************** PROXY **************** */
1773
1774 /* when you make proxy, ensure the exposed layers are extern */
1775 static void armature_set_id_extern(Object *ob)
1776 {
1777   bArmature *arm = ob->data;
1778   bPoseChannel *pchan;
1779   unsigned int lay = arm->layer_protected;
1780
1781   for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) {
1782     if (!(pchan->bone->layer & lay))
1783       id_lib_extern((ID *)pchan->custom);
1784   }
1785 }
1786
1787 void BKE_object_copy_proxy_drivers(Object *ob, Object *target)
1788 {
1789   if ((target->adt) && (target->adt->drivers.first)) {
1790     FCurve *fcu;
1791
1792     /* add new animdata block */
1793     if (!ob->adt)
1794       ob->adt = BKE_animdata_add_id(&ob->id);
1795
1796     /* make a copy of all the drivers (for now), then correct any links that need fixing */
1797     free_fcurves(&ob->adt->drivers);
1798     copy_fcurves(&ob->adt->drivers, &target->adt->drivers);
1799
1800     for (fcu = ob->adt->drivers.first; fcu; fcu = fcu->next) {
1801       ChannelDriver *driver = fcu->driver;
1802       DriverVar *dvar;
1803
1804       for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
1805         /* all drivers */
1806         DRIVER_TARGETS_LOOPER_BEGIN (dvar) {
1807           if (dtar->id) {
1808             if ((Object *)dtar->id == target)
1809               dtar->id = (ID *)ob;
1810             else {
1811               /* only on local objects because this causes indirect links
1812                * 'a -> b -> c', blend to point directly to a.blend
1813                * when a.blend has a proxy thats linked into c.blend  */
1814               if (!ID_IS_LINKED(ob))
1815                 id_lib_extern((ID *)dtar->id);
1816             }
1817           }
1818         }
1819         DRIVER_TARGETS_LOOPER_END;
1820       }
1821     }
1822   }
1823 }
1824
1825 /* proxy rule: lib_object->proxy_from == the one we borrow from, set temporally while object_update */
1826 /*             local_object->proxy == pointer to library object, saved in files and read */
1827 /*             local_object->proxy_group == pointer to collection dupli-object, saved in files and read */
1828
1829 void BKE_object_make_proxy(Main *bmain, Object *ob, Object *target, Object *cob)
1830 {
1831   /* paranoia checks */
1832   if (ID_IS_LINKED(ob) || !ID_IS_LINKED(target)) {
1833     CLOG_ERROR(&LOG, "cannot make proxy");
1834     return;
1835   }
1836
1837   ob->proxy = target;
1838   ob->proxy_group = cob;
1839   id_lib_extern(&target->id);
1840
1841   DEG_id_tag_update(&ob->id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY | ID_RECALC_ANIMATION);
1842   DEG_id_tag_update(&target->id, ID_RECALC_TRANSFORM | ID_RECALC_GEOMETRY | ID_RECALC_ANIMATION);
1843
1844   /* copy transform
1845    * - cob means this proxy comes from a collection, just apply the matrix
1846    *   so the object wont move from its dupli-transform.
1847    *
1848    * - no cob means this is being made from a linked object,
1849    *   this is closer to making a copy of the object - in-place. */
1850   if (cob) {
1851     ob->rotmode = target->rotmode;
1852     mul_m4_m4m4(ob->obmat, cob->obmat, target->obmat);
1853     if (cob->instance_collection) { /* should always be true */
1854       float tvec[3];
1855       mul_v3_mat3_m4v3(tvec, ob->obmat, cob->instance_collection->instance_offset);
1856       sub_v3_v3(ob->obmat[3], tvec);
1857     }
1858     BKE_object_apply_mat4(ob, ob->obmat, false, true);
1859   }
1860   else {
1861     BKE_object_transform_copy(ob, target);
1862     ob->parent = target->parent; /* libdata */
1863     copy_m4_m4(ob->parentinv, target->parentinv);
1864   }
1865
1866   /* copy animdata stuff - drivers only for now... */
1867   BKE_object_copy_proxy_drivers(ob, target);
1868
1869   /* skip constraints? */
1870   /* FIXME: this is considered by many as a bug */
1871
1872   /* set object type and link to data */
1873   ob->type = target->type;
1874   ob->data = target->data;
1875   id_us_plus((ID *)ob->data); /* ensures lib data becomes LIB_TAG_EXTERN */
1876
1877   /* copy vertex groups */
1878   defgroup_copy_list(&ob->defbase, &target->defbase);
1879
1880   /* copy material and index information */
1881   ob->actcol = ob->totcol = 0;
1882   if (ob->mat)
1883     MEM_freeN(ob->mat);
1884   if (ob->matbits)
1885     MEM_freeN(ob->matbits);
1886   ob->mat = NULL;
1887   ob->matbits = NULL;
1888   if ((target->totcol) && (target->mat) && OB_TYPE_SUPPORT_MATERIAL(ob->type)) {
1889     int i;
1890
1891     ob->actcol = target->actcol;
1892     ob->totcol = target->totcol;
1893
1894     ob->mat = MEM_dupallocN(target->mat);
1895     ob->matbits = MEM_dupallocN(target->matbits);
1896     for (i = 0; i < target->totcol; i++) {
1897       /* don't need to run test_object_materials
1898        * since we know this object is new and not used elsewhere */
1899       id_us_plus((ID *)ob->mat[i]);
1900     }
1901   }
1902
1903   /* type conversions */
1904   if (target->type == OB_ARMATURE) {
1905     copy_object_pose(ob, target, 0);             /* data copy, object pointers in constraints */
1906     BKE_pose_rest(ob->pose);                     /* clear all transforms in channels */
1907     BKE_pose_rebuild(bmain, ob, ob->data, true); /* set all internal links */
1908
1909     armature_set_id_extern(ob);
1910   }
1911   else if (target->type == OB_EMPTY) {
1912     ob->empty_drawtype = target->empty_drawtype;
1913     ob->empty_drawsize = target->empty_drawsize;
1914   }
1915
1916   /* copy IDProperties */
1917   if (ob->id.properties) {
1918     IDP_FreeProperty(ob->id.properties);
1919     MEM_freeN(ob->id.properties);
1920     ob->id.properties = NULL;
1921   }
1922   if (target->id.properties) {
1923     ob->id.properties = IDP_CopyProperty(target->id.properties);
1924   }
1925
1926   /* copy drawtype info */
1927   ob->dt = target->dt;
1928 }
1929
1930 /**
1931  * Use with newly created objects to set their size
1932  * (used to apply scene-scale).
1933  */
1934 void BKE_object_obdata_size_init(struct Object *ob, const float size)
1935 {
1936   /* apply radius as a scale to types that support it */
1937   switch (ob->type) {
1938     case OB_EMPTY: {
1939       ob->empty_drawsize *= size;
1940       break;
1941     }
1942     case OB_FONT: {
1943       Curve *cu = ob->data;
1944       cu->fsize *= size;
1945       break;
1946     }
1947     case OB_CAMERA: {
1948       Camera *cam = ob->data;
1949       cam->drawsize *= size;
1950       break;
1951     }
1952     case OB_LAMP: {
1953       Light *lamp = ob->data;
1954       lamp->dist *= size;
1955       lamp->area_size *= size;
1956       lamp->area_sizey *= size;
1957       lamp->area_sizez *= size;
1958       break;
1959     }
1960     /* Only lattice (not mesh, curve, mball...),
1961      * because its got data when newly added */
1962     case OB_LATTICE: {
1963       struct Lattice *lt = ob->data;
1964       float mat[4][4];
1965
1966       unit_m4(mat);
1967       scale_m4_fl(mat, size);
1968
1969       BKE_lattice_transform(lt, (float(*)[4])mat, false);
1970       break;
1971     }
1972   }
1973 }
1974
1975 /* *************** CALC ****************** */
1976
1977 void BKE_object_scale_to_mat3(Object *ob, float mat[3][3])
1978 {
1979   float vec[3];
1980   mul_v3_v3v3(vec, ob->scale, ob->dscale);
1981   size_to_mat3(mat, vec);
1982 }
1983
1984 void BKE_object_rot_to_mat3(Object *ob, float mat[3][3], bool use_drot)
1985 {
1986   float rmat[3][3], dmat[3][3];
1987
1988   /* 'dmat' is the delta-rotation matrix, which will get (pre)multiplied
1989    * with the rotation matrix to yield the appropriate rotation
1990    */
1991
1992   /* rotations may either be quats, eulers (with various rotation orders), or axis-angle */
1993   if (ob->rotmode > 0) {
1994     /* euler rotations (will cause gimble lock, but this can be alleviated a bit with rotation orders) */
1995     eulO_to_mat3(rmat, ob->rot, ob->rotmode);
1996     eulO_to_mat3(dmat, ob->drot, ob->rotmode);
1997   }
1998   else if (ob->rotmode == ROT_MODE_AXISANGLE) {
1999     /* axis-angle - not really that great for 3D-changing orientations */
2000     axis_angle_to_mat3(rmat, ob->rotAxis, ob->rotAngle);
2001     axis_angle_to_mat3(dmat, ob->drotAxis, ob->drotAngle);
2002   }
2003   else {
2004     /* quats are normalized before use to eliminate scaling issues */
2005     float tquat[4];
2006
2007     normalize_qt_qt(tquat, ob->quat);
2008     quat_to_mat3(rmat, tquat);
2009
2010     normalize_qt_qt(tquat, ob->dquat);
2011     quat_to_mat3(dmat, tquat);
2012   }
2013
2014   /* combine these rotations */
2015   if (use_drot)
2016     mul_m3_m3m3(mat, dmat, rmat);
2017   else
2018     copy_m3_m3(mat, rmat);
2019 }
2020
2021 void BKE_object_mat3_to_rot(Object *ob, float mat[3][3], bool use_compat)
2022 {
2023   BLI_ASSERT_UNIT_M3(mat);
2024
2025   switch (ob->rotmode) {
2026     case ROT_MODE_QUAT: {
2027       float dquat[4];
2028       mat3_normalized_to_quat(ob->quat, mat);
2029       normalize_qt_qt(dquat, ob->dquat);
2030       invert_qt_normalized(dquat);
2031       mul_qt_qtqt(ob->quat, dquat, ob->quat);
2032       break;
2033     }
2034     case ROT_MODE_AXISANGLE: {
2035       float quat[4];
2036       float dquat[4];
2037
2038       /* without drot we could apply 'mat' directly */
2039       mat3_normalized_to_quat(quat, mat);
2040       axis_angle_to_quat(dquat, ob->drotAxis, ob->drotAngle);
2041       invert_qt_normalized(dquat);
2042       mul_qt_qtqt(quat, dquat, quat);
2043       quat_to_axis_angle(ob->rotAxis, &ob->rotAngle, quat);
2044       break;
2045     }
2046     default: /* euler */
2047     {
2048       float quat[4];
2049       float dquat[4];
2050
2051       /* without drot we could apply 'mat' directly */
2052       mat3_normalized_to_quat(quat, mat);
2053       eulO_to_quat(dquat, ob->drot, ob->rotmode);
2054       invert_qt_normalized(dquat);
2055       mul_qt_qtqt(quat, dquat, quat);
2056       /* end drot correction */
2057
2058       if (use_compat)
2059         quat_to_compatible_eulO(ob->rot, ob->rot, ob->rotmode, quat);
2060       else
2061         quat_to_eulO(ob->rot, ob->rotmode, quat);
2062       break;
2063     }
2064   }
2065 }
2066
2067 void BKE_object_tfm_protected_backup(const Object *ob, ObjectTfmProtectedChannels *obtfm)
2068 {
2069
2070 #define TFMCPY(_v) (obtfm->_v = ob->_v)
2071 #define TFMCPY3D(_v) copy_v3_v3(obtfm->_v, ob->_v)
2072 #define TFMCPY4D(_v) copy_v4_v4(obtfm->_v, ob->_v)
2073
2074   TFMCPY3D(loc);
2075   TFMCPY3D(dloc);
2076   TFMCPY3D(scale);
2077   TFMCPY3D(dscale);
2078   TFMCPY3D(rot);
2079   TFMCPY3D(drot);
2080   TFMCPY4D(quat);
2081   TFMCPY4D(dquat);
2082   TFMCPY3D(rotAxis);
2083   TFMCPY3D(drotAxis);
2084   TFMCPY(rotAngle);
2085   TFMCPY(drotAngle);
2086
2087 #undef TFMCPY
2088 #undef TFMCPY3D
2089 #undef TFMCPY4D
2090 }
2091
2092 void BKE_object_tfm_protected_restore(Object *ob,
2093                                       const ObjectTfmProtectedChannels *obtfm,
2094                                       const short protectflag)
2095 {
2096   unsigned int i;
2097
2098   for (i = 0; i < 3; i++) {
2099     if (protectflag & (OB_LOCK_LOCX << i)) {
2100       ob->loc[i] = obtfm->loc[i];
2101       ob->dloc[i] = obtfm->dloc[i];
2102     }
2103
2104     if (protectflag & (OB_LOCK_SCALEX << i)) {
2105       ob->scale[i] = obtfm->scale[i];
2106       ob->dscale[i] = obtfm->dscale[i];
2107     }
2108
2109     if (protectflag & (OB_LOCK_ROTX << i)) {
2110       ob->rot[i] = obtfm->rot[i];
2111       ob->drot[i] = obtfm->drot[i];
2112
2113       ob->quat[i + 1] = obtfm->quat[i + 1];
2114       ob->dquat[i + 1] = obtfm->dquat[i + 1];
2115
2116       ob->rotAxis[i] = obtfm->rotAxis[i];
2117       ob->drotAxis[i] = obtfm->drotAxis[i];
2118     }
2119   }
2120
2121   if ((protectflag & OB_LOCK_ROT4D) && (protectflag & OB_LOCK_ROTW)) {
2122     ob->quat[0] = obtfm->quat[0];
2123     ob->dquat[0] = obtfm->dquat[0];
2124
2125     ob->rotAngle = obtfm->rotAngle;
2126     ob->drotAngle = obtfm->drotAngle;
2127   }
2128 }
2129
2130 void BKE_object_tfm_copy(Object *object_dst, const Object *object_src)
2131 {
2132 #define TFMCPY(_v) (object_dst->_v = object_src->_v)
2133 #define TFMCPY3D(_v) copy_v3_v3(object_dst->_v, object_src->_v)
2134 #define TFMCPY4D(_v) copy_v4_v4(object_dst->_v, object_src->_v)
2135
2136   TFMCPY3D(loc);
2137   TFMCPY3D(dloc);
2138   TFMCPY3D(scale);
2139   TFMCPY3D(dscale);
2140   TFMCPY3D(rot);
2141   TFMCPY3D(drot);
2142   TFMCPY4D(quat);
2143   TFMCPY4D(dquat);
2144   TFMCPY3D(rotAxis);
2145   TFMCPY3D(drotAxis);
2146   TFMCPY(rotAngle);
2147   TFMCPY(drotAngle);
2148
2149 #undef TFMCPY
2150 #undef TFMCPY3D
2151 #undef TFMCPY4D
2152 }
2153
2154 void BKE_object_to_mat3(Object *ob, float mat[3][3]) /* no parent */
2155 {
2156   float smat[3][3];
2157   float rmat[3][3];
2158   /*float q1[4];*/
2159
2160   /* scale */
2161   BKE_object_scale_to_mat3(ob, smat);
2162
2163   /* rot */
2164   BKE_object_rot_to_mat3(ob, rmat, true);
2165   mul_m3_m3m3(mat, rmat, smat);
2166 }
2167
2168 void BKE_object_to_mat4(Object *ob, float mat[4][4])
2169 {
2170   float tmat[3][3];
2171
2172   BKE_object_to_mat3(ob, tmat);
2173
2174   copy_m4_m3(mat, tmat);
2175
2176   add_v3_v3v3(mat[3], ob->loc, ob->dloc);
2177 }
2178
2179 void BKE_object_matrix_local_get(struct Object *ob, float mat[4][4])
2180 {
2181   if (ob->parent) {
2182     float par_imat[4][4];
2183
2184     BKE_object_get_parent_matrix(ob, ob->parent, par_imat);
2185     invert_m4(par_imat);
2186     mul_m4_m4m4(mat, par_imat, ob->obmat);
2187   }
2188   else {
2189     copy_m4_m4(mat, ob->obmat);
2190   }
2191 }
2192
2193 /**
2194  * \param depsgraph: Used for dupli-frame time.
2195  * \return success if \a mat is set.
2196  */
2197 static bool ob_parcurve(Object *ob, Object *par, float mat[4][4])
2198 {
2199   Curve *cu = par->data;
2200   float vec[4], dir[3], quat[4], radius, ctime;
2201
2202   /* NOTE: Curve cache is supposed to be evaluated here already, however there
2203    * are cases where we can not guarantee that. This includes, for example,
2204    * dependency cycles. We can't correct anything from here, since that would
2205    * cause a threading conflicts.
2206    *
2207    * TODO(sergey): Somce of the legit looking cases like T56619 need to be
2208    * looked into, and maybe curve cache (and other dependencies) are to be
2209    * evaluated prior to conversion. */
2210   if (par->runtime.curve_cache == NULL) {
2211     return false;
2212   }
2213   if (par->runtime.curve_cache->path == NULL) {
2214     return false;
2215   }
2216
2217   /* ctime is now a proper var setting of Curve which gets set by Animato like any other var that's animated,
2218    * but this will only work if it actually is animated...
2219    *
2220    * we divide the curvetime calculated in the previous step by the length of the path, to get a time
2221    * factor, which then gets clamped to lie within 0.0 - 1.0 range
2222    */
2223   if (cu->pathlen) {
2224     ctime = cu->ctime / cu->pathlen;
2225   }
2226   else {
2227     ctime = cu->ctime;
2228   }
2229   CLAMP(ctime, 0.0f, 1.0f);
2230
2231   unit_m4(mat);
2232
2233   /* vec: 4 items! */
2234   if (where_on_path(par, ctime, vec, dir, (cu->flag & CU_FOLLOW) ? quat : NULL, &radius, NULL)) {
2235     if (cu->flag & CU_FOLLOW) {
2236       quat_apply_track(quat, ob->trackflag, ob->upflag);
2237       normalize_qt(quat);
2238       quat_to_mat4(mat, quat);
2239     }
2240     if (cu->flag & CU_PATH_RADIUS) {
2241       float tmat[4][4], rmat[4][4];
2242       scale_m4_fl(tmat, radius);
2243       mul_m4_m4m4(rmat, tmat, mat);
2244       copy_m4_m4(mat, rmat);
2245     }
2246     copy_v3_v3(mat[3], vec);
2247   }
2248
2249   return true;
2250 }
2251
2252 static void ob_parbone(Object *ob, Object *par, float mat[4][4])
2253 {
2254   bPoseChannel *pchan;
2255   float vec[3];
2256
2257   if (par->type != OB_ARMATURE) {
2258     unit_m4(mat);
2259     return;
2260   }
2261
2262   /* Make sure the bone is still valid */
2263   pchan = BKE_pose_channel_find_name(par->pose, ob->parsubstr);
2264   if (!pchan || !pchan->bone) {
2265     CLOG_ERROR(
2266         &LOG, "Object %s with Bone parent: bone %s doesn't exist", ob->id.name + 2, ob->parsubstr);
2267     unit_m4(mat);
2268     return;
2269   }
2270
2271   /* get bone transform */
2272   if (pchan->bone->flag & BONE_RELATIVE_PARENTING) {
2273     /* the new option uses the root - expected behavior, but differs from old... */
2274     /* XXX check on version patching? */
2275     copy_m4_m4(mat, pchan->chan_mat);
2276   }
2277   else {
2278     copy_m4_m4(mat, pchan->pose_mat);
2279
2280     /* but for backwards compatibility, the child has to move to the tail */
2281     copy_v3_v3(vec, mat[1]);
2282     mul_v3_fl(vec, pchan->bone->length);
2283     add_v3_v3(mat[3], vec);
2284   }
2285 }
2286
2287 static void give_parvert(Object *par, int nr, float vec[3])
2288 {
2289   zero_v3(vec);
2290
2291   if (par->type == OB_MESH) {
2292     Mesh *me = par->data;
2293     BMEditMesh *em = me->edit_mesh;
2294     Mesh *me_eval = (em) ? em->mesh_eval_final : par->runtime.mesh_eval;
2295
2296     if (me_eval) {
2297       int count = 0;
2298       const int numVerts = me_eval->totvert;
2299
2300       if (nr < numVerts) {
2301         if (em && me_eval->runtime.is_original) {
2302           if (em->bm->elem_table_dirty & BM_VERT) {
2303 #ifdef VPARENT_THREADING_HACK
2304             BLI_mutex_lock(&vparent_lock);
2305             if (em->bm->elem_table_dirty & BM_VERT) {
2306               BM_mesh_elem_table_ensure(em->bm, BM_VERT);
2307             }
2308             BLI_mutex_unlock(&vparent_lock);
2309 #else
2310             BLI_assert(!"Not safe for threading");
2311             BM_mesh_elem_table_ensure(em->bm, BM_VERT);
2312 #endif
2313           }
2314         }
2315
2316         if (CustomData_has_layer(&me_eval->vdata, CD_ORIGINDEX) &&
2317             !(em && me_eval->runtime.is_original)) {
2318           const int *index = CustomData_get_layer(&me_eval->vdata, CD_ORIGINDEX);
2319           /* Get the average of all verts with (original index == nr). */
2320           for (int i = 0; i < numVerts; i++) {
2321             if (index[i] == nr) {
2322               add_v3_v3(vec, me_eval->mvert[i].co);
2323               count++;
2324             }
2325           }
2326         }
2327         else {
2328           if (nr < numVerts) {
2329             add_v3_v3(vec, me_eval->mvert[nr].co);
2330             count++;
2331           }
2332         }
2333       }
2334
2335       if (count == 0) {
2336         /* keep as 0, 0, 0 */
2337       }
2338       else if (count > 0) {
2339         mul_v3_fl(vec, 1.0f / count);
2340       }
2341       else {
2342         /* use first index if its out of range */
2343         if (me_eval->totvert) {
2344           copy_v3_v3(vec, me_eval->mvert[0].co);
2345         }
2346       }
2347     }
2348     else {
2349       CLOG_ERROR(&LOG,
2350                  "Evaluated mesh is needed to solve parenting, "
2351                  "object position can be wrong now");
2352     }
2353   }
2354   else if (ELEM(par->type, OB_CURVE, OB_SURF)) {
2355     ListBase *nurb;
2356
2357     /* Unless there's some weird depsgraph failure the cache should exist. */
2358     BLI_assert(par->runtime.curve_cache != NULL);
2359
2360     if (par->runtime.curve_cache->deformed_nurbs.first != NULL) {
2361       nurb = &par->runtime.curve_cache->deformed_nurbs;
2362     }
2363     else {
2364       Curve *cu = par->data;
2365       nurb = BKE_curve_nurbs_get(cu);
2366     }
2367
2368     BKE_nurbList_index_get_co(nurb, nr, vec);
2369   }
2370   else if (par->type == OB_LATTICE) {
2371     Lattice *latt = par->data;
2372     DispList *dl = par->runtime.curve_cache ?
2373                        BKE_displist_find(&par->runtime.curve_cache->disp, DL_VERTS) :
2374                        NULL;
2375     float(*co)[3] = dl ? (float(*)[3])dl->verts : NULL;
2376     int tot;
2377
2378     if (latt->editlatt)
2379       latt = latt->editlatt->latt;
2380
2381     tot = latt->pntsu * latt->pntsv * latt->pntsw;
2382
2383     /* ensure dl is correct size */
2384     BLI_assert(dl == NULL || dl->nr == tot);
2385
2386     if (nr < tot) {
2387       if (co) {
2388         copy_v3_v3(vec, co[nr]);
2389       }
2390       else {
2391         copy_v3_v3(vec, latt->def[nr].vec);
2392       }
2393     }
2394   }
2395 }
2396
2397 static void ob_parvert3(Object *ob, Object *par, float mat[4][4])
2398 {
2399
2400   /* in local ob space */
2401   if (OB_TYPE_SUPPORT_PARVERT(par->type)) {
2402     float cmat[3][3], v1[3], v2[3], v3[3], q[4];
2403
2404     give_parvert(par, ob->par1, v1);
2405     give_parvert(par, ob->par2, v2);
2406     give_parvert(par, ob->par3, v3);
2407
2408     tri_to_quat(q, v1, v2, v3);
2409     quat_to_mat3(cmat, q);
2410     copy_m4_m3(mat, cmat);
2411
2412     mid_v3_v3v3v3(mat[3], v1, v2, v3);
2413   }
2414   else {
2415     unit_m4(mat);
2416   }
2417 }
2418
2419 void BKE_object_get_parent_matrix(Object *ob, Object *par, float parentmat[4][4])
2420 {
2421   float tmat[4][4];
2422   float vec[3];
2423   bool ok;
2424
2425   switch (ob->partype & PARTYPE) {
2426     case PAROBJECT:
2427       ok = 0;
2428       if (par->type == OB_CURVE) {
2429         if ((((Curve *)par->data)->flag & CU_PATH) && (ob_parcurve(ob, par, tmat))) {
2430           ok = 1;
2431         }
2432       }
2433
2434       if (ok)
2435         mul_m4_m4m4(parentmat, par->obmat, tmat);
2436       else
2437         copy_m4_m4(parentmat, par->obmat);
2438
2439       break;
2440     case PARBONE:
2441       ob_parbone(ob, par, tmat);
2442       mul_m4_m4m4(parentmat, par->obmat, tmat);
2443       break;
2444
2445     case PARVERT1:
2446       unit_m4(parentmat);
2447       give_parvert(par, ob->par1, vec);
2448       mul_v3_m4v3(parentmat[3], par->obmat, vec);
2449       break;
2450     case PARVERT3:
2451       ob_parvert3(ob, par, tmat);
2452
2453       mul_m4_m4m4(parentmat, par->obmat, tmat);
2454       break;
2455
2456     case PARSKEL:
2457       copy_m4_m4(parentmat, par->obmat);
2458       break;
2459   }
2460 }
2461
2462 /**
2463  * \param r_originmat: Optional matrix that stores the space the object is in (without its own matrix applied)
2464  */
2465 static void solve_parenting(
2466     Object *ob, Object *par, float obmat[4][4], float r_originmat[3][3], const bool set_origin)
2467 {
2468   float totmat[4][4];
2469   float tmat[4][4];
2470   float locmat[4][4];
2471
2472   BKE_object_to_mat4(ob, locmat);
2473
2474   BKE_object_get_parent_matrix(ob, par, totmat);
2475
2476   /* total */
2477   mul_m4_m4m4(tmat, totmat, ob->parentinv);
2478   mul_m4_m4m4(obmat, tmat, locmat);
2479
2480   if (r_originmat) {
2481     /* usable originmat */
2482     copy_m3_m4(r_originmat, tmat);
2483   }
2484
2485   /* origin, for help line */
2486   if (set_origin) {
2487     if ((ob->partype & PARTYPE) == PARSKEL) {
2488       copy_v3_v3(ob->runtime.parent_display_origin, par->obmat[3]);
2489     }
2490     else {
2491       copy_v3_v3(ob->runtime.parent_display_origin, totmat[3]);
2492     }
2493   }
2494 }
2495
2496 /* note, scene is the active scene while actual_scene is the scene the object resides in */
2497 static void object_where_is_calc_ex(Depsgraph *depsgraph,
2498                                     Scene *scene,
2499                                     Object *ob,
2500                                     float ctime,
2501                                     RigidBodyWorld *rbw,
2502                                     float r_originmat[3][3])
2503 {
2504   if (ob->parent) {
2505     Object *par = ob->parent;
2506
2507     /* calculate parent matrix */
2508     solve_parenting(ob, par, ob->obmat, r_originmat, true);
2509   }
2510   else {
2511     BKE_object_to_mat4(ob, ob->obmat);
2512   }
2513
2514   /* try to fall back to the scene rigid body world if none given */
2515   rbw = rbw ? rbw : scene->rigidbody_world;
2516   /* read values pushed into RBO from sim/cache... */
2517   BKE_rigidbody_sync_transforms(rbw, ob, ctime);
2518
2519   /* solve constraints */
2520   if (ob->constraints.first && !(ob->transflag & OB_NO_CONSTRAINTS)) {
2521     bConstraintOb *cob;
2522     cob = BKE_constraints_make_evalob(depsgraph, scene, ob, NULL, CONSTRAINT_OBTYPE_OBJECT);
2523     BKE_constraints_solve(depsgraph, &ob->constraints, cob, ctime);
2524     BKE_constraints_clear_evalob(cob);
2525   }
2526
2527   /* set negative scale flag in object */
2528   if (is_negative_m4(ob->obmat))
2529     ob->transflag |= OB_NEG_SCALE;
2530   else
2531     ob->transflag &= ~OB_NEG_SCALE;
2532 }
2533
2534 void BKE_object_where_is_calc_time(Depsgraph *depsgraph, Scene *scene, Object *ob, float ctime)
2535 {
2536   /* Execute drivers and animation. */
2537   BKE_animsys_evaluate_animdata(depsgraph, scene, &ob->id, ob->adt, ctime, ADT_RECALC_ALL);
2538   object_where_is_calc_ex(depsgraph, scene, ob, ctime, NULL, NULL);
2539 }
2540
2541 /* get object transformation matrix without recalculating dependencies and
2542  * constraints -- assume dependencies are already solved by depsgraph.
2543  * no changes to object and it's parent would be done.
2544  * used for bundles orientation in 3d space relative to parented blender camera */
2545 void BKE_object_where_is_calc_mat4(Object *ob, float obmat[4][4])
2546 {
2547   if (ob->parent) {
2548     Object *par = ob->parent;
2549     solve_parenting(ob, par, obmat, NULL, false);
2550   }
2551   else {
2552     BKE_object_to_mat4(ob, obmat);
2553   }
2554 }
2555
2556 void BKE_object_where_is_calc_ex(
2557     Depsgraph *depsgraph, Scene *scene, RigidBodyWorld *rbw, Object *ob, float r_originmat[3][3])
2558 {
2559   float ctime = DEG_get_ctime(depsgraph);
2560   object_where_is_calc_ex(depsgraph, scene, ob, ctime, rbw, r_originmat);
2561 }
2562 void BKE_object_where_is_calc(Depsgraph *depsgraph, Scene *scene, Object *ob)
2563 {
2564   float ctime = DEG_get_ctime(depsgraph);
2565   object_where_is_calc_ex(depsgraph, scene, ob, ctime, NULL, NULL);
2566 }
2567
2568 /**
2569  * For calculation of the inverse parent transform, only used for editor.
2570  *
2571  * It assumes the object parent is already in the depsgraph.
2572  * Otherwise, after changing ob->parent you need to call:
2573  * - #DEG_relations_tag_update(bmain);
2574  * - #BKE_scene_graph_update_tagged(depsgraph, bmain);
2575  */
2576 void BKE_object_workob_calc_parent(Depsgraph *depsgraph, Scene *scene, Object *ob, Object *workob)
2577 {
2578   BKE_object_workob_clear(workob);
2579
2580   unit_m4(workob->obmat);
2581   unit_m4(workob->parentinv);
2582   unit_m4(workob->constinv);
2583
2584   /* Since this is used while calculating parenting, at this moment ob_eval->parent is still NULL. */
2585   workob->parent = DEG_get_evaluated_object(depsgraph, ob->parent);
2586
2587   workob->trackflag = ob->trackflag;
2588   workob->upflag = ob->upflag;
2589
2590   workob->partype = ob->partype;
2591   workob->par1 = ob->par1;
2592   workob->par2 = ob->par2;
2593   workob->par3 = ob->par3;
2594
2595   workob->constraints = ob->constraints;
2596
2597   BLI_strncpy(workob->parsubstr, ob->parsubstr, sizeof(workob->parsubstr));
2598
2599   BKE_object_where_is_calc(depsgraph, scene, workob);
2600 }
2601
2602 /**
2603  * Applies the global transformation \a mat to the \a ob using a relative parent space if supplied.
2604  *
2605  * \param mat: the global transformation mat that the object should be set object to.
2606  * \param parent: the parent space in which this object will be set relative to (should probably always be parent_eval).
2607  * \param use_compat: true to ensure that rotations are set using the min difference between the old and new orientation.
2608  */
2609 void BKE_object_apply_mat4_ex(
2610     Object *ob, float mat[4][4], Object *parent, float parentinv[4][4], const bool use_compat)
2611 {
2612   /* see BKE_pchan_apply_mat4() for the equivalent 'pchan' function */
2613
2614   float rot[3][3];
2615
2616   if (parent != NULL) {
2617     float rmat[4][4], diff_mat[4][4], imat[4][4], parent_mat[4][4];
2618
2619     BKE_object_get_parent_matrix(ob, parent, parent_mat);
2620
2621     mul_m4_m4m4(diff_mat, parent_mat, parentinv);
2622     invert_m4_m4(imat, diff_mat);
2623     mul_m4_m4m4(rmat, imat, mat); /* get the parent relative matrix */
2624
2625     /* same as below, use rmat rather than mat */
2626     mat4_to_loc_rot_size(ob->loc, rot, ob->scale, rmat);
2627   }
2628   else {
2629     mat4_to_loc_rot_size(ob->loc, rot, ob->scale, mat);
2630   }
2631
2632   BKE_object_mat3_to_rot(ob, rot, use_compat);
2633
2634   sub_v3_v3(ob->loc, ob->dloc);
2635
2636   if (ob->dscale[0] != 0.0f)
2637     ob->scale[0] /= ob->dscale[0];
2638   if (ob->dscale[1] != 0.0f)
2639     ob->scale[1] /= ob->dscale[1];
2640   if (ob->dscale[2] != 0.0f)
2641     ob->scale[2] /= ob->dscale[2];
2642
2643   /* BKE_object_mat3_to_rot handles delta rotations */
2644 }
2645
2646 /* XXX: should be removed after COW operators port to use BKE_object_apply_mat4_ex directly */
2647 void BKE_object_apply_mat4(Object *ob,
2648                            float mat[4][4],
2649                            const bool use_compat,
2650                            const bool use_parent)
2651 {
2652   BKE_object_apply_mat4_ex(ob, mat, use_parent ? ob->parent : NULL, ob->parentinv, use_compat);
2653 }
2654
2655 BoundBox *BKE_boundbox_alloc_unit(void)
2656 {
2657   BoundBox *bb;
2658   const float min[3] = {-1.0f, -1.0f, -1.0f}, max[3] = {1.0f, 1.0f, 1.0f};
2659
2660   bb = MEM_callocN(sizeof(BoundBox), "OB-BoundBox");
2661   BKE_boundbox_init_from_minmax(bb, min, max);
2662
2663   return bb;
2664 }
2665
2666 void BKE_boundbox_init_from_minmax(BoundBox *bb, const float min[3], const float max[3])
2667 {
2668   bb->vec[0][0] = bb->vec[1][0] = bb->vec[2][0] = bb->vec[3][0] = min[0];
2669   bb->vec[4][0] = bb->vec[5][0] = bb->vec[6][0] = bb->vec[7][0] = max[0];
2670
2671   bb->vec[0][1] = bb->vec[1][1] = bb->vec[4][1] = bb->vec[5][1] = min[1];
2672   bb->vec[2][1] = bb->vec[3][1] = bb->vec[6][1] = bb->vec[7][1] = max[1];
2673
2674   bb->vec[0][2] = bb->vec[3][2] = bb->vec[4][2] = bb->vec[7][2] = min[2];
2675   bb->vec[1][2] = bb->vec[2][2] = bb->vec[5][2] = bb->vec[6][2] = max[2];
2676 }
2677
2678 void BKE_boundbox_calc_center_aabb(const BoundBox *bb, float r_cent[3])
2679 {
2680   r_cent[0] = 0.5f * (bb->vec[0][0] + bb->vec[4][0]);
2681   r_cent[1] = 0.5f * (bb->vec[0][1] + bb->vec[2][1]);
2682   r_cent[2] = 0.5f * (bb->vec[0][2] + bb->vec[1][2]);
2683 }
2684
2685 void BKE_boundbox_calc_size_aabb(const BoundBox *bb, float r_size[3])
2686 {
2687   r_size[0] = 0.5f * fabsf(bb->vec[0][0] - bb->vec[4][0]);
2688   r_size[1] = 0.5f * fabsf(bb->vec[0][1] - bb->vec[2][1]);
2689   r_size[2] = 0.5f * fabsf(bb->vec[0][2] - bb->vec[1][2]);
2690 }
2691
2692 void BKE_boundbox_minmax(const BoundBox *bb, float obmat[4][4], float r_min[3], float r_max[3])
2693 {
2694   int i;
2695   for (i = 0; i < 8; i++) {
2696     float vec[3];
2697     mul_v3_m4v3(vec, obmat, bb->vec[i]);
2698     minmax_v3v3_v3(r_min, r_max, vec);
2699   }
2700 }
2701
2702 BoundBox *BKE_object_boundbox_get(Object *ob)
2703 {
2704   BoundBox *bb = NULL;
2705
2706   switch (ob->type) {
2707     case OB_MESH:
2708       bb = BKE_mesh_boundbox_get(ob);
2709       break;
2710     case OB_CURVE:
2711     case OB_SURF:
2712     case OB_FONT:
2713       bb = BKE_curve_boundbox_get(ob);
2714       break;
2715     case OB_MBALL:
2716       bb = BKE_mball_boundbox_get(ob);
2717       break;
2718     case OB_LATTICE:
2719       bb = BKE_lattice_boundbox_get(ob);
2720       break;
2721     case OB_ARMATURE:
2722       bb = BKE_armature_boundbox_get(ob);
2723       break;
2724     case OB_GPENCIL:
2725       bb = BKE_gpencil_boundbox_get(ob);
2726       break;
2727     default:
2728       break;
2729   }
2730   return bb;
2731 }
2732
2733 /* used to temporally disable/enable boundbox */
2734 void BKE_object_boundbox_flag(Object *ob, int flag, const bool set)
2735 {
2736   BoundBox *bb = BKE_object_boundbox_get(ob);
2737   if (bb) {
2738     if (set)
2739       bb->flag |= flag;
2740     else
2741       bb->flag &= ~flag;
2742   }
2743 }
2744
2745 void BKE_object_boundbox_calc_from_mesh(struct Object *ob, struct Mesh *me_eval)
2746 {
2747   float min[3], max[3];
2748
2749   INIT_MINMAX(min, max);
2750
2751   if (!BKE_mesh_minmax(me_eval, min, max)) {
2752     zero_v3(min);
2753     zero_v3(max);
2754   }
2755
2756   if (ob->runtime.bb == NULL) {
2757     ob->runtime.bb = MEM_callocN(sizeof(BoundBox), "DM-BoundBox");
2758   }
2759
2760   BKE_boundbox_init_from_minmax(ob->runtime.bb, min, max);
2761
2762   ob->runtime.bb->flag &= ~BOUNDBOX_DIRTY;
2763 }
2764
2765 void BKE_object_dimensions_get(Object *ob, float vec[3])
2766 {
2767   BoundBox *bb = NULL;
2768
2769   bb = BKE_object_boundbox_get(ob);
2770   if (bb) {
2771     float scale[3];
2772
2773     mat4_to_size(scale, ob->obmat);
2774
2775     vec[0] = fabsf(scale[0]) * (bb->vec[4][0] - bb->vec[0][0]);
2776     vec[1] = fabsf(scale[1]) * (bb->vec[2][1] - bb->vec[0][1]);
2777     vec[2] = fabsf(scale[2]) * (bb->vec[1][2] - bb->vec[0][2]);
2778   }
2779   else {
2780     zero_v3(vec);
2781   }
2782 }
2783
2784 void BKE_object_dimensions_set(Object *ob, const float value[3], int axis_mask)
2785 {
2786   BoundBox *bb = NULL;
2787
2788   bb = BKE_object_boundbox_get(ob);
2789   if (bb) {
2790     float len[3];
2791
2792     len[0] = bb->vec[4][0] - bb->vec[0][0];
2793     len[1] = bb->vec[2][1] - bb->vec[0][1];
2794     len[2] = bb->vec[1][2] - bb->vec[0][2];
2795
2796     for (int i = 0; i < 3; i++) {
2797       if (((1 << i) & axis_mask) == 0) {
2798         if (len[i] > 0.0f) {
2799           ob->scale[i] = copysignf(value[i] / len[i], ob->scale[i]);
2800         }
2801       }
2802     }
2803   }
2804 }
2805
2806 void BKE_object_minmax(Object *ob, float min_r[3], float max_r[3], const bool use_hidden)
2807 {
2808   BoundBox bb;
2809   float vec[3];
2810   bool changed = false;
2811
2812   switch (ob->type) {
2813     case OB_CURVE:
2814     case OB_FONT:
2815     case OB_SURF: {
2816       bb = *BKE_curve_boundbox_get(ob);
2817       BKE_boundbox_minmax(&bb, ob->obmat, min_r, max_r);
2818       changed = true;
2819       break;
2820     }
2821     case OB_MESH: {
2822       bb = *BKE_mesh_boundbox_get(ob);
2823       BKE_boundbox_minmax(&bb, ob->obmat, min_r, max_r);
2824       changed = true;
2825       break;
2826     }
2827     case OB_GPENCIL: {
2828       bb = *BKE_gpencil_boundbox_get(ob);
2829       BKE_boundbox_minmax(&bb, ob->obmat, min_r, max_r);
2830       changed = true;
2831       break;
2832     }
2833     case OB_LATTICE: {
2834       Lattice *lt = ob->data;
2835       BPoint *bp = lt->def;
2836       int u, v, w;
2837
2838       for (w = 0; w < lt->pntsw; w++) {
2839         for (v = 0; v < lt->pntsv; v++) {
2840           for (u = 0; u < lt->pntsu; u++, bp++) {
2841             mul_v3_m4v3(vec, ob->obmat, bp->vec);
2842             minmax_v3v3_v3(min_r, max_r, vec);
2843           }
2844         }
2845       }
2846       changed = true;
2847       break;
2848     }
2849     case OB_ARMATURE: {
2850       changed = BKE_pose_minmax(ob, min_r, max_r, use_hidden, false);
2851       break;
2852     }
2853     case OB_MBALL: {
2854       float ob_min[3], ob_max[3];
2855
2856       changed = BKE_mball_minmax_ex(ob->data, ob_min, ob_max, ob->obmat, 0);
2857       if (changed) {
2858         minmax_v3v3_v3(min_r, max_r, ob_min);
2859         minmax_v3v3_v3(min_r, max_r, ob_max);
2860       }
2861       break;
2862     }
2863   }
2864
2865   if (changed == false) {
2866     float size[3];
2867
2868     copy_v3_v3(size, ob->scale);
2869     if (ob->type == OB_EMPTY) {
2870       mul_v3_fl(size, ob->empty_drawsize);
2871     }
2872
2873     minmax_v3v3_v3(min_r, max_r, ob->obmat[3]);
2874
2875     copy_v3_v3(vec, ob->obmat[3]);
2876     add_v3_v3(vec, size);
2877     minmax_v3v3_v3(min_r, max_r, vec);
2878
2879     copy_v3_v3(vec, ob->obmat[3]);
2880     sub_v3_v3(vec, size);
2881     minmax_v3v3_v3(min_r, max_r, vec);
2882   }
2883 }
2884
2885 void BKE_object_empty_draw_type_set(Object *ob, const int value)
2886 {
2887   ob->empty_drawtype = value;
2888
2889   if (ob->type == OB_EMPTY && ob->empty_drawtype == OB_EMPTY_IMAGE) {
2890     if (!ob->iuser) {
2891       ob->iuser = MEM_callocN(sizeof(ImageUser), "image user");
2892       ob->iuser->ok = 1;
2893       ob->iuser->flag |= IMA_ANIM_ALWAYS;
2894       ob->iuser->frames = 100;
2895       ob->iuser->sfra = 1;
2896     }
2897   }
2898   else {
2899     if (ob->iuser) {
2900       MEM_freeN(ob->iuser);
2901       ob->iuser = NULL;
2902     }
2903   }
2904 }
2905
2906 bool BKE_object_empty_image_frame_is_visible_in_view3d(const Object *ob, const RegionView3D *rv3d)
2907 {
2908   const char visibility_flag = ob->empty_image_visibility_flag;
2909   if (rv3d->is_persp) {
2910     return (visibility_flag & OB_EMPTY_IMAGE_HIDE_PERSPECTIVE) == 0;
2911   }
2912   else {
2913     return (visibility_flag & OB_EMPTY_IMAGE_HIDE_ORTHOGRAPHIC) == 0;
2914   }
2915 }
2916
2917 bool BKE_object_empty_image_data_is_visible_in_view3d(const Object *ob, const RegionView3D *rv3d)
2918 {
2919   /* Caller is expected to check this. */
2920   BLI_assert(BKE_object_empty_image_frame_is_visible_in_view3d(ob, rv3d));
2921
2922   const char visibility_flag = ob->empty_image_visibility_flag;
2923
2924   if ((visibility_flag & (OB_EMPTY_IMAGE_HIDE_BACK | OB_EMPTY_IMAGE_HIDE_FRONT)) != 0) {
2925     float eps, dot;
2926     if (rv3d->is_persp) {
2927       /* Note, we could normalize the 'view_dir' then use 'eps'
2928        * however the issue with empty objects being visible when viewed from the side
2929        * is only noticeable in orthographic views. */
2930       float view_dir[3];
2931       sub_v3_v3v3(view_dir, rv3d->viewinv[3], ob->obmat[3]);
2932       dot = dot_v3v3(ob->obmat[2], view_dir);
2933       eps = 0.0f;
2934     }
2935     else {
2936       dot = dot_v3v3(ob->obmat[2], rv3d->viewinv[2]);
2937       eps = 1e-5f;
2938     }
2939     if (visibility_flag & OB_EMPTY_IMAGE_HIDE_BACK) {
2940       if (dot < eps) {
2941         return false;
2942       }
2943     }
2944     if (visibility_flag & OB_EMPTY_IMAGE_HIDE_FRONT) {
2945       if (dot > -eps) {
2946         return false;
2947       }
2948     }
2949   }
2950
2951   return true;
2952 }
2953
2954 bool BKE_object_minmax_dupli(Depsgraph *depsgraph,
2955                              Scene *scene,
2956                              Object *ob,
2957                              float r_min[3],
2958                              float r_max[3],
2959                              const bool use_hidden)
2960 {
2961   bool ok = false;
2962   if ((ob->transflag & OB_DUPLI) == 0) {
2963     return ok;
2964   }
2965   else {
2966     ListBase *lb;
2967     DupliObject *dob;
2968     lb = object_duplilist(depsgraph, scene, ob);
2969     for (dob = lb->first; dob; dob = dob->next) {
2970       if ((use_hidden == false) && (dob->no_draw != 0)) {
2971         /* pass */
2972       }
2973       else {
2974         BoundBox *bb = BKE_object_boundbox_get(dob->ob);
2975
2976         if (bb) {
2977           int i;
2978           for (i = 0; i < 8; i++) {
2979             float vec[3];
2980             mul_v3_m4v3(vec, dob->mat, bb->vec[i]);
2981             minmax_v3v3_v3(r_min, r_max, vec);
2982           }
2983
2984           ok = true;
2985         }
2986       }
2987     }
2988     free_object_duplilist(lb); /* does restore */
2989   }
2990
2991   return ok;
2992 }
2993
2994 void BKE_object_foreach_display_point(Object *ob,
2995                                       float obmat[4][4],
2996                                       void (*func_cb)(const float[3], void *),
2997                                       void *user_data)
2998 {
2999   float co[3];
3000
3001   if (ob->runtime.mesh_eval) {
3002     const Mesh *me = ob->runtime.mesh_eval;
3003     const MVert *mv = me->mvert;
3004     const int totvert = me->totvert;
3005     for (int i = 0; i < totvert; i++, mv++) {
3006       mul_v3_m4v3(co, obmat, mv->co);
3007       func_cb(co, user_data);
3008     }
3009   }
3010   else if (ob->runtime.curve_cache && ob->runtime.curve_cache->disp.first) {
3011     DispList *dl;
3012
3013     for (dl = ob->runtime.curve_cache->disp.first; dl; dl = dl->next) {
3014       const float *v3 = dl->verts;
3015       int totvert = dl->nr;
3016       int i;
3017
3018       for (i = 0; i < totvert; i++, v3 += 3) {
3019         mul_v3_m4v3(co, obmat, v3);
3020         func_cb(co, user_data);
3021       }
3022     }
3023   }
3024 }
3025
3026 void BKE_scene_foreach_display_point(Depsgraph *depsgraph,
3027                                      void (*func_cb)(const float[3], void *),
3028                                      void *user_data)
3029 {
3030   DEG_OBJECT_ITER_BEGIN (depsgraph,
3031                          ob,
3032                          DEG_ITER_OBJECT_FLAG_LINKED_DIRECTLY | DEG_ITER_OBJECT_FLAG_VISIBLE |
3033                              DEG_ITER_OBJECT_FLAG_DUPLI) {
3034     if ((ob->base_flag & BASE_SELECTED) != 0) {
3035       BKE_object_foreach_display_point(ob, ob->obmat, func_cb, user_data);
3036     }
3037   }
3038   DEG_OBJECT_ITER_END;
3039 }
3040
3041 /* copied from DNA_object_types.h */
3042 typedef struct ObTfmBack {
3043   float loc[3], dloc[3];
3044   /** scale and delta scale. */
3045   float scale[3], dscale[3];
3046   /** euler rotation. */
3047   float rot[3], drot[3];
3048   /** quaternion rotation. */
3049   float quat[4], dquat[4];
3050   /** axis angle rotation - axis part. */
3051   float rotAxis[3], drotAxis[3];
3052   /** axis angle rotation - angle part. */
3053   float rotAngle, drotAngle;
3054   /** final worldspace matrix with constraints & animsys applied. */
3055   float obmat[4][4];
3056   /** inverse result of parent, so that object doesn't 'stick' to parent. */
3057   float parentinv[4][4];
3058   /** inverse result of constraints. doesn't include effect of parent or object local transform. */
3059   float constinv[4][4];
3060   /** inverse matrix of 'obmat' for during render, temporally: ipokeys of transform. */
3061   float imat[4][4];
3062 } ObTfmBack;
3063
3064 void *BKE_object_tfm_backup(Object *ob)
3065 {
3066   ObTfmBack *obtfm = MEM_mallocN(sizeof(ObTfmBack), "ObTfmBack");
3067   copy_v3_v3(obtfm->loc, ob->loc);
3068   copy_v3_v3(obtfm->dloc, ob->dloc);
3069   copy_v3_v3(obtfm->scale, ob->scale);
3070   copy_v3_v3(obtfm->dscale, ob->dscale);
3071   copy_v3_v3(obtfm->rot, ob->rot);
3072   copy_v3_v3(obtfm->drot, ob->drot);
3073   copy_qt_qt(obtfm->quat, ob->quat);
3074   copy_qt_qt(obtfm->dquat, ob->dquat);
3075   copy_v3_v3(obtfm->rotAxis, ob->rotAxis);
3076   copy_v3_v3(obtfm->drotAxis, ob->drotAxis);
3077   obtfm->rotAngle = ob->rotAngle;
3078   obtfm->drotAngle = ob->drotAngle;
3079   copy_m4_m4(obtfm->obmat, ob->obmat);
3080   copy_m4_m4(obtfm->parentinv, ob->parentinv);
3081   copy_m4_m4(obtfm->constinv, ob->constinv);
3082   copy_m4_m4(obtfm->imat, ob->imat);
3083
3084   return (void *)obtfm;
3085 }
3086
3087 void BKE_object_tfm_restore(Object *ob, void *obtfm_pt)
3088 {
3089   ObTfmBack *obtfm = (ObTfmBack *)obtfm_pt;
3090   copy_v3_v3(ob->loc, obtfm->loc);
3091   copy_v3_v3(ob->dloc, obtfm->dloc);
3092   copy_v3_v3(ob->scale, obtfm->scale);
3093   copy_v3_v3(ob->dscale, obtfm->dscale);
3094   copy_v3_v3(ob->rot, obtfm->rot);
3095   copy_v3_v3(ob->drot, obtfm->drot);
3096   copy_qt_qt(ob->quat, obtfm->quat);
3097   copy_qt_qt(ob->dquat, obtfm->dquat);
3098   copy_v3_v3(ob->rotAxis, obtfm->rotAxis);
3099   copy_v3_v3(ob->drotAxis, obtfm->drotAxis);
3100   ob->rotAngle = obtfm->rotAngle;
3101   ob->drotAngle = obtfm->drotAngle;
3102   copy_m4_m4(ob->obmat, obtfm->obmat);
3103   copy_m4_m4(ob->parentinv, obtfm->parentinv);
3104   copy_m4_m4(ob->constinv, obtfm->constinv);
3105   copy_m4_m4(ob->imat, obtfm->imat);
3106 }
3107
3108 bool BKE_object_parent_loop_check(const Object *par, const Object *ob)
3109 {
3110   /* test if 'ob' is a parent somewhere in par's parents */
3111   if (par == NULL)
3112     return false;
3113   if (ob == par)
3114     return true;
3115   return BKE_object_parent_loop_check(par->parent, ob);
3116 }
3117
3118 static void object_handle_update_proxy(Depsgraph *depsgraph,
3119                                        Scene *scene,
3120                                        Object *object,
3121                                        const bool do_proxy_update)
3122 {
3123   /* The case when this is a collection proxy, object_update is called in collection.c */
3124   if (object->proxy == NULL) {
3125     return;
3126   }
3127   /* set pointer in library proxy target, for copying, but restore it */
3128   object->proxy->proxy_from = object;
3129   // printf("set proxy pointer for later collection stuff %s\n", ob->id.name);
3130
3131   /* the no-group proxy case, we call update */
3132   if (object->proxy_group == NULL) {
3133     if (do_proxy_update) {
3134       // printf("call update, lib ob %s proxy %s\n", ob->proxy->id.name, ob->id.name);
3135       BKE_object_handle_update(depsgraph, scene, object->proxy);
3136     }
3137   }
3138 }
3139
3140 /* proxy rule: lib_object->proxy_from == the one we borrow from, only set temporal and cleared here */
3141 /*           local_object->proxy      == pointer to library object, saved in files and read */
3142
3143 /* function below is polluted with proxy exceptions, cleanup will follow! */
3144
3145 /* the main object update call, for object matrix, constraints, keys and displist (modifiers) */
3146 /* requires flags to be set! */
3147 /* Ideally we shouldn't have to pass the rigid body world, but need bigger restructuring to avoid id */
3148 void BKE_object_handle_update_ex(Depsgraph *depsgraph,
3149                                  Scene *scene,
3150                                  Object *ob,
3151                                  RigidBodyWorld *rbw,
3152                                  const bool do_proxy_update)
3153 {
3154   const ID *object_data = ob->data;
3155   const bool recalc_object = (ob->id.recalc & ID_RECALC_ALL) != 0;
3156   const bool recalc_data = (object_data != NULL) ? ((object_data->recalc & ID_RECALC_ALL) != 0) :
3157                                                    0;
3158   if (!recalc_object && !recalc_data) {
3159     object_handle_update_proxy(depsgraph, scene, ob, do_proxy_update);
3160     return;
3161   }
3162   /* Speed optimization for animation lookups. */
3163   if (ob->pose != NULL) {
3164     BKE_pose_channels_hash_make(ob->pose);
3165     if (ob->pose->flag & POSE_CONSTRAINTS_NEED_UPDATE_FLAGS) {
3166       BKE_pose_update_constraint_flags(ob->pose);
3167     }
3168   }
3169   if (recalc_data) {
3170     if (ob->type == OB_ARMATURE) {
3171       /* this happens for reading old files and to match library armatures
3172        * with poses we do it ahead of BKE_object_where_is_calc to ensure animation
3173        * is evaluated on the rebuilt pose, otherwise we get incorrect poses
3174        * on file load */
3175       if (ob->pose == NULL || (ob->pose->flag & POSE_RECALC)) {
3176         /* No need to pass bmain here, we assume we do not need to rebuild DEG from here... */
3177         BKE_pose_rebuild(NULL, ob, ob->data, true);
3178       }
3179     }
3180   }
3181   /* XXX new animsys warning: depsgraph tag ID_RECALC_GEOMETRY should not skip drivers,
3182    * which is only in BKE_object_where_is_calc now */
3183   /* XXX: should this case be ID_RECALC_TRANSFORM instead? */
3184   if (recalc_object || recalc_data) {
3185     if (G.debug & G_DEBUG_DEPSGRAPH_EVAL) {
3186       printf("recalcob %s\n", ob->id.name + 2);
3187     }
3188     /* Handle proxy copy for target. */
3189     if (!BKE_object_eval_proxy_copy(depsgraph, ob)) {
3190       BKE_object_where_is_calc_ex(depsgraph, scene, rbw, ob, NULL);
3191     }
3192   }
3193
3194   if (recalc_data) {
3195     BKE_object_handle_data_update(depsgraph, scene, ob);
3196   }
3197
3198   ob->id.recalc &= ID_RECALC_ALL;
3199
3200   object_handle_update_proxy(depsgraph, scene, ob, do_proxy_update);
3201 }
3202
3203 /**
3204  * \warning "scene" here may not be the scene object actually resides in.
3205  * When dealing with background-sets, "scene" is actually the active scene.
3206  * e.g. "scene" <-- set 1 <-- set 2 ("ob" lives here) <-- set 3 <-- ... <-- set n
3207  * rigid bodies depend on their world so use #BKE_object_handle_update_ex()
3208  * to also pass along the current rigid body world.
3209  */
3210 void BKE_object_handle_update(Depsgraph *depsgraph, Scene *scene, Object *ob)
3211 {
3212   BKE_object_handle_update_ex(depsgraph, scene, ob, NULL, true);
3213 }
3214
3215 void BKE_object_sculpt_data_create(Object *ob)
3216 {
3217   BLI_assert((ob->sculpt == NULL) && (ob->mode & OB_MODE_ALL_SCULPT));
3218   ob->sculpt = MEM_callocN(sizeof(SculptSession), __func__);
3219   ob->sculpt->mode_type = ob->mode;
3220 }
3221
3222 void BKE_object_sculpt_modifiers_changed(Object *ob)
3223 {
3224   SculptSession *ss = ob->sculpt;
3225
3226   if (ss && ss->building_vp_handle == false) {
3227     if (!ss->cache) {
3228       /* we free pbvh on changes, except during sculpt since it can't deal with
3229        * changing PVBH node organization, we hope topology does not change in
3230        * the meantime .. weak */
3231       if (ss->pbvh) {
3232         BKE_pbvh_free(ss->pbvh);
3233         ss->pbvh = NULL;
3234       }
3235
3236       BKE_sculptsession_free_deformMats(ob->sculpt);
3237
3238       /* In vertex/weight paint, force maps to be rebuilt. */
3239       BKE_sculptsession_free_vwpaint_data(ob->sculpt);
3240     }
3241     else {
3242       PBVHNode **nodes;
3243       int n, totnode;
3244
3245       BKE_pbvh_search_gather(ss->pbvh, NULL, NULL, &nodes, &totnode);
3246
3247       for (n = 0; n < totnode; n++)
3248         BKE_pbvh_node_mark_update(nodes[n]);
3249
3250       MEM_freeN(nodes);
3251     }
3252   }
3253 }
3254
3255 int BKE_object_obdata_texspace_get(
3256     Object *ob, short **r_texflag, float **r_loc, float **r_size, float **r_rot)
3257 {
3258
3259   if (ob->data == NULL)
3260     return 0;
3261
3262   switch (GS(((ID *)ob->data)->name)) {
3263     case ID_ME: {
3264       BKE_mesh_texspace_get_reference((Mesh *)ob->data, r_texflag, r_loc, r_rot, r_size);
3265       break;
3266     }
3267     case ID_CU: {
3268       Curve *cu = ob->data;
3269       if (cu->bb == NULL || (cu->bb->flag & BOUNDBOX_DIRTY)) {
3270         BKE_curve_texspace_calc(cu);
3271       }
3272       if (r_texflag)
3273         *r_texflag = &cu->texflag;
3274       if (r_loc)
3275         *r_loc = cu->loc;
3276       if (r_size)
3277         *r_size = cu->size;
3278       if (r_rot)
3279         *r_rot = cu->rot;
3280       break;
3281     }
3282     case ID_MB: {
3283       MetaBall *mb = ob->data;
3284       if (r_texflag)
3285         *r_texflag = &mb->texflag;
3286       if (r_loc)
3287         *r_loc = mb->loc;
3288       if (r_size)
3289         *r_size = mb->size;
3290       if (r_rot)
3291         *r_rot = mb->rot;
3292       break;
3293     }
3294     default:
3295       return 0;
3296   }
3297   return 1;
3298 }
3299
3300 /** Get evaluated mesh for given (main, original) object and depsgraph. */
3301 Mesh *BKE_object_get_evaluated_mesh(const Depsgraph *depsgraph, Object *ob)
3302 {
3303   Object *ob_eval = DEG_get_evaluated_object(depsgraph, ob);
3304   return ob_eval->runtime.mesh_eval;
3305 }
3306
3307 /* Get object's mesh with all modifiers applied. */
3308 Mesh *BKE_object_get_final_mesh(Object *object)
3309 {
3310   if (object->runtime.mesh_eval != NULL) {
3311     BLI_assert((object->id.tag & LIB_TAG_COPIED_ON_WRITE) != 0);
3312     BLI_assert(object->runtime.mesh_eval == object->data);
3313     BLI_assert((object->runtime.mesh_eval->id.tag & LIB_TAG_COPIED_ON_WRITE_EVAL_RESULT) != 0);
3314     return object->runtime.mesh_eval;
3315   }
3316   /* Wasn't evaluated yet. */
3317   return object->data;
3318 }
3319
3320 /* Get mesh which is not affected by modifiers:
3321  * - For original objects it will be same as object->data, and it is a mesh
3322  *   which is in the corresponding bmain.
3323  * - For copied-on-write objects it will give pointer to a copied-on-write
3324  *   mesh which corresponds to original object's mesh.
3325  */
3326 Mesh *BKE_object_get_pre_modified_mesh(Object *object)
3327 {
3328   if (object->runtime.mesh_orig != NULL) {
3329     BLI_assert(object->id.tag & LIB_TAG_COPIED_ON_WRITE);
3330     BLI_assert(object->id.orig_id != NULL);
3331     BLI_assert(object->runtime.mesh_orig->id.orig_id == ((Object *)object->id.orig_id)->data);
3332     Mesh *result = object->runtime.mesh_orig;
3333     BLI_assert((result->id.tag & LIB_TAG_COPIED_ON_WRITE) != 0);
3334     BLI_assert((result->id.tag & LIB_TAG_COPIED_ON_WRITE_EVAL_RESULT) == 0);
3335     return result;
3336   }
3337   BLI_assert((object->id.tag & LIB_TAG_COPIED_ON_WRITE) == 0);
3338   return object->data;
3339 }
3340
3341 /* Get a mesh which corresponds to very very original mesh from bmain.
3342  * - For original objects it will be object->data.
3343  * - For evaluated objects it will be same mesh as corresponding original
3344  *   object uses as data.
3345  */
3346 Mesh *BKE_object_get_original_mesh(Object *object)
3347 {
3348   Mesh *result = NULL;
3349   if (object->id.orig_id == NULL) {
3350     BLI_assert((object->id.tag & LIB_TAG_COPIED_ON_WRITE) == 0);
3351     result = object->data;
3352   }
3353   else {
3354     BLI_assert((object->id.tag & LIB_TAG_COPIED_ON_WRITE) != 0);
3355     result = ((Object *)object->id.orig_id)->data;
3356   }
3357   BLI_assert(result != NULL);
3358   BLI_assert((result->id.tag & (LIB_TAG_COPIED_ON_WRITE | LIB_TAG_COPIED_ON_WRITE_EVAL_RESULT)) ==
3359              0);
3360   return result;
3361 }
3362
3363 static int pc_cmp(const void *a, const void *b)
3364 {
3365   const LinkData *ad = a, *bd = b;
3366   if (POINTER_AS_INT(ad->data) > POINTER_AS_INT(bd->data))
3367     return 1;
3368   else
3369     return 0;
3370 }
3371
3372 int BKE_object_insert_ptcache(Object *ob)
3373 {
3374   LinkData *link = NULL;
3375   int i = 0;
3376
3377   BLI_listbase_sort(&ob->pc_ids, pc_cmp);
3378
3379   for (link = ob->pc_ids.first, i = 0; link; link = link->next, i++) {
3380     int index = POINTER_AS_INT(link->data);
3381
3382     if (i < index)
3383       break;
3384   }
3385
3386   link = MEM_callocN(sizeof(LinkData), "PCLink");
3387   link->data = POINTER_FROM_INT(i);
3388   BLI_addtail(&ob->pc_ids, link);
3389
3390   return i;
3391 }
3392
3393 static int pc_findindex(ListBase *listbase, int index)
3394 {
3395   LinkData *link = NULL;
3396   int number = 0;
3397
3398   if (listbase == NULL)
3399     return -1;
3400
3401   link = listbase->first;
3402   while (link) {
3403     if (POINTER_AS_INT(link->data) == index)
3404       return number;
3405
3406     number++;
3407     link = link->next;
3408   }
3409
3410   return -1;
3411 }
3412
3413 void BKE_object_delete_ptcache(Object *ob, int index)
3414 {
3415   int list_index = pc_findindex(&ob->pc_ids, index);
3416   LinkData *link = BLI_findlink(&ob->pc_ids, list_index);
3417   BLI_freelinkN(&ob->pc_ids, link);
3418 }
3419
3420 /* shape key utility function */
3421
3422 /************************* Mesh ************************/
3423 static KeyBlock *insert_meshkey(Main *bmain, Object *ob, const char *name, const bool from_mix)
3424 {
3425   Mesh *me = ob->data;
3426   Key *key = me->key;
3427   KeyBlock *kb;
3428   int newkey = 0;
3429
3430   if (key == NULL) {
3431     key = me->key = BKE_key_add(bmain, (ID *)me);
3432     key->type = KEY_RELATIVE;
3433     newkey = 1;
3434   }
3435
3436   if (newkey || from_mix == false) {
3437     /* create from mesh */
3438     kb = BKE_keyblock_add_ctime(key, name, false);
3439     BKE_keyblock_convert_from_mesh(me, key, kb);
3440   }
3441   else {
3442     /* copy from current values */
3443     int totelem;
3444     float *data = BKE_key_evaluate_object(ob, &totelem);
3445
3446     /* create new block with prepared data */
3447     kb = BKE_keyblock_add_ctime(key, name, false);
3448     kb->data = data;
3449     kb->totelem = totelem;
3450   }
3451
3452   return kb;
3453 }
3454 /************************* Lattice ************************/
3455 static KeyBlock *insert_lattkey(Main *bmain, Object *ob, const char *name, const bool from_mix)
3456 {
3457   Lattice *lt = ob->data;
3458   Key *key = lt->key;
3459   KeyBlock *kb;
3460   int newkey = 0;
3461
3462   if (key == NULL) {
3463     key = lt->key = BKE_key_add(bmain, (ID *)lt);
3464     key->type = KEY_RELATIVE;
3465     newkey = 1;
3466   }
3467
3468   if (newkey || from_mix == false) {
3469     kb = BKE_keyblock_add_ctime(key, name, false);
3470     if (!newkey) {
3471       KeyBlock *basekb = (KeyBlock *)key->block.first;
3472       kb->data = MEM_dupallocN(basekb->data);
3473       kb->totelem = basekb->totelem;
3474     }
3475     else {
3476       BKE_keyblock_convert_from_lattice(lt, kb);
3477     }
3478   }
3479   else {
3480     /* copy from current values */
3481     int totelem;
3482     float *data = BKE_key_evaluate_object(ob, &totelem);
3483
3484     /* create new block with prepared data */
3485     kb = BKE_keyblock_add_ctime(key, name, false);
3486     kb->totelem = totelem;
3487     kb->data = data;
3488   }
3489
3490   return kb;
3491 }
3492 /************************* Curve ************************/
3493 static KeyBlock *insert_curvekey(Main *bmain, Object *ob, const char *name, const bool from_mix)
3494 {
3495   Curve *cu = ob->data;
3496   Key *key = cu->key;
3497   KeyBlock *kb;
3498   ListBase *lb = BKE_curve_nurbs_get(cu);
3499   int newkey = 0;
3500
3501   if (key == NULL) {
3502     key = cu->key = BKE_key_add(bmain, (ID *)cu);
3503     key->type = KEY_RELATIVE;
3504     newkey = 1;
3505   }
3506
3507   if (newkey || from_mix == false) {
3508     /* create from curve */
3509     kb = BKE_keyblock_add_ctime(key, name, false);
3510     if (!newkey) {
3511       KeyBlock *basekb = (KeyBlock *)key->block.first;
3512       kb->data = MEM_dupallocN(basekb->data);
3513       kb->totelem = basekb->totelem;
3514     }
3515     else {
3516       BKE_keyblock_convert_from_curve(cu, kb, lb);
3517     }
3518   }
3519   else {
3520     /* copy from current values */
3521     int totelem;
3522     float *data = BKE_key_evaluate_object(ob, &totelem);
3523
3524     /* create new block with prepared data */
3525     kb = BKE_keyblock_add_ctime(key, name, false);
3526     kb->totelem = totelem;
3527     kb->data = data;
3528   }
3529
3530   return kb;
3531 }
3532
3533 KeyBlock *BKE_object_shapekey_insert(Main *bmain,
3534                                      Object *ob,
3535                                      const char *name,
3536                                      const bool from_mix)
3537 {
3538   switch (ob->type) {
3539     case OB_MESH:
3540       return insert_meshkey(bmain, ob, name, from_mix);
3541     case OB_CURVE:
3542     case OB_SURF:
3543       return insert_curvekey(bmain, ob, name, from_mix);
3544     case OB_LATTICE:
3545       return insert_lattkey(bmain, ob, name, from_mix);
3546     default:
3547       return NULL;
3548   }
3549 }
3550
3551 bool BKE_object_shapekey_free(Main *bmain, Object *ob)
3552 {
3553   Key **key_p, *key;
3554
3555   key_p = BKE_key_from_object_p(ob);
3556   if (ELEM(NULL, key_p, *key_p)) {
3557     return false;
3558   }
3559
3560   key = *key_p;
3561   *key_p = NULL;
3562
3563   BKE_id_free_us(bmain, key);
3564
3565   return false;
3566 }
3567
3568 bool BKE_object_shapekey_remove(Main *bmain, Object *ob, KeyBlock *kb)
3569 {
3570   KeyBlock *rkb;
3571   Key *key = BKE_key_from_object(ob);
3572   short kb_index;
3573
3574   if (key == NULL) {
3575     return false;
3576   }
3577
3578   kb_index = BLI_findindex(&key->block, kb);
3579   BLI_assert(kb_index != -1);
3580
3581   for (rkb = key->block.first; rkb; rkb = rkb->next) {
3582     if (rkb->relative == kb_index) {
3583       /* remap to the 'Basis' */
3584       rkb->relative = 0;
3585     }
3586     else if (rkb->relative >= kb_index) {
3587       /* Fix positional shift of the keys when kb is deleted from the list */
3588       rkb->relative -= 1;
3589     }
3590   }
3591
3592   BLI_remlink(&key->block, kb);
3593   key->totkey--;
3594   if (key->refkey == kb) {
3595     key->refkey = key->block.first;
3596
3597     if (key->refkey) {
3598       /* apply new basis key on original data */
3599       switch (ob->type) {
3600         case OB_MESH:
3601           BKE_keyblock_convert_to_mesh(key->refkey, ob->data);
3602           break;
3603         case OB_CURVE:
3604         case OB_SURF:
3605           BKE_keyblock_convert_to_curve(key->refkey, ob->data, BKE_curve_nurbs_get(ob->data));
3606           break;
3607         case OB_LATTICE:
3608           BKE_keyblock_convert_to_lattice(key->refkey, ob->data);
3609           break;
3610       }
3611     }
3612   }
3613
3614   if (kb->data) {
3615     MEM_freeN(kb->data);
3616   }
3617   MEM_freeN(kb);
3618
3619   if (ob->shapenr > 1) {
3620     ob->shapenr--;
3621   }
3622
3623   if (key->totkey == 0) {
3624     BKE_object_shapekey_free(bmain, ob);
3625   }
3626
3627   return true;
3628 }
3629
3630 bool BKE_object_flag_test_recursive(const Object *ob, short flag)
3631 {
3632   if (ob->flag & flag) {
3633     return true;
3634   }
3635   else if (ob->parent) {
3636     return BKE_object_flag_test_recursive(ob->parent, flag);
3637   }
3638   else {
3639     return false;
3640   }
3641 }
3642
3643 bool BKE_object_is_child_recursive(const Object *ob_parent, const Object *ob_child)
3644 {
3645   for (ob_child = ob_child->parent; ob_child; ob_child = ob_child->parent) {
3646     if (ob_child == ob_parent) {
3647       return true;
3648     }
3649   }
3650   return false;
3651 }
3652
3653 /* most important if this is modified it should _always_ return True, in certain
3654  * cases false positives are hard to avoid (shape keys for example) */
3655 int BKE_object_is_modified(Scene *scene, Object *ob)
3656 {
3657   int flag = 0;
3658
3659   if (BKE_key_from_object(ob)) {
3660     flag |= eModifierMode_Render | eModifierMode_Realtime;
3661   }
3662   else {
3663     ModifierData *md;
3664     VirtualModifierData virtualModifierData;
3665     /* cloth */
3666     for (md = modifiers_getVirtualModifierList(ob, &virtualModifierData);
3667          md && (flag != (eModifierMode_Render | eModifierMode_Realtime));
3668          md = md->next) {
3669       if ((flag & eModifierMode_Render) == 0 &&
3670           modifier_isEnabled(scene, md, eModifierMode_Render))
3671         flag |= eModifierMode_Render;
3672
3673       if ((flag & eModifierMode_Realtime) == 0 &&
3674           modifier_isEnabled(scene, md, eModifierMode_Realtime))
3675         flag |= eModifierMode_Realtime;
3676     }
3677   }
3678
3679   return flag;
3680 }
3681
3682 /* Check of objects moves in time. */
3683 /* NOTE: This function is currently optimized for usage in combination
3684  * with mti->canDeform, so modifiers can quickly check if their target
3685  * objects moves (causing deformation motion blur) or not.
3686  *
3687  * This makes it possible to give some degree of false-positives here,
3688  * but it's currently an acceptable tradeoff between complexity and check
3689  * speed. In combination with checks of modifier stack and real life usage
3690  * percentage of false-positives shouldn't be that height.
3691  */
3692 static bool object_moves_in_time(Object *object)
3693 {
3694   AnimData *adt = object->adt;
3695   if (adt != NULL) {
3696     /* If object has any sort of animation data assume it is moving. */
3697     if (adt->action != NULL || !BLI_listbase_is_empty(&adt->nla_tracks) ||
3698         !BLI_listbase_is_empty(&adt->drivers) || !BLI_listbase_is_empty(&adt->overrides)) {
3699       return true;
3700     }
3701   }
3702   if (!BLI_listbase_is_empty(&object->constraints)) {
3703     return true;
3704   }
3705   if (object->parent != NULL) {
3706     /* TODO(sergey): Do recursive check here? */
3707     return true;
3708   }
3709   return false;
3710 }
3711
3712 static bool object_deforms_in_time(Object *object)
3713 {
3714   if (BKE_key_from_object(object) != NULL) {
3715     return true;
3716   }
3717   if (!BLI_listbase_is_empty(&object->modifiers)) {
3718     return true;
3719   }
3720   return object_moves_in_time(object);
3721 }
3722
3723 static bool constructive_modifier_is_deform_modified(ModifierData *md)
3724 {
3725   /* TODO(sergey): Consider generalizing this a bit so all modifier logic
3726    * is concentrated in MOD_{modifier}.c file,
3727    */
3728   if (md->type == eModifierType_Array) {
3729     ArrayModifierData *amd = (ArrayModifierData *)md;
3730     /* TODO(sergey): Check if curve is deformed. */
3731     return (amd->start_cap != NULL && object_moves_in_time(amd->start_cap)) ||
3732            (amd->end_cap != NULL && object_moves_in_time(amd->end_cap)) ||
3733            (amd->curve_ob != NULL && object_moves_in_time(amd->curve_ob)) ||
3734            (amd->offset_ob != NULL && object_moves_in_time(amd->offset_ob));
3735   }
3736   else if (md->type == eModifierType_Mirror) {
3737     MirrorModifierData *mmd = (MirrorModifierData *)md;
3738     return mmd->mirror_ob != NULL && object_moves_in_time(mmd->mirror_ob);
3739   }
3740   else if (md->type == eModifierType_Screw) {
3741     ScrewModifierData *smd = (ScrewModifierData *)md;
3742     return smd->ob_axis != NULL && object_moves_in_time(smd->ob_axis);
3743   }
3744   else if (md->type == eModifierType_MeshSequenceCache) {
3745     /* NOTE: Not ideal because it's unknown whether topology changes or not.
3746      * This will be detected later, so by assuming it's only deformation
3747      * going on here we allow to bake deform-only mesh to Alembic and have
3748      * proper motion blur after that.
3749      */
3750     return true;
3751   }
3752   return false;
3753 }
3754
3755 static bool modifiers_has_animation_check(Object *ob)
3756 {
3757   /* TODO(sergey): This is a bit code duplication with depsgraph, but
3758    * would be nicer to solve this as a part of new dependency graph
3759    * work, so we avoid conflicts and so.
3760    */
3761   if (ob->adt != NULL) {
3762     AnimData *adt = ob->adt;
3763     FCurve *fcu;
3764     if (adt->action != NULL) {
3765       for (fcu = adt->action->curves.first; fcu; fcu = fcu->next) {
3766         if (fcu->rna_path && strstr(fcu->rna_path, "modifiers[")) {
3767           return true;
3768         }
3769       }
3770     }
3771     for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
3772       if (fcu->rna_path && strstr(fcu->rna_path, "modifiers[")) {
3773         return true;
3774       }
3775     }
3776   }
3777   return false;
3778 }
3779
3780 /* test if object is affected by deforming modifiers (for motion blur). again
3781  * most important is to avoid false positives, this is to skip computations
3782  * and we can still if there was actual deformation afterwards */
3783 int BKE_object_is_deform_modified(Scene *scene, Object *ob)
3784 {
3785   ModifierData *md;
3786   VirtualModifierData virtualModifierData;
3787   int flag = 0;
3788   const bool is_modifier_animated = modifiers_has_animation_check(ob);
3789
3790   if (BKE_key_from_object(ob)) {
3791     flag |= eModifierMode_Realtime | eModifierMode_Render;
3792   }
3793
3794   if (ob->type == OB_CURVE) {
3795     Curve *cu = (Curve *)ob->data;