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