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