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