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