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