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