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