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