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