Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / object_dupli.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_dupli.c
29  *  \ingroup bke
30  */
31
32 #include <limits.h>
33 #include <stdlib.h>
34 #include <stddef.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_listbase.h"
39 #include "BLI_string_utf8.h"
40
41 #include "BLI_math.h"
42 #include "BLI_rand.h"
43
44 #include "DNA_anim_types.h"
45 #include "DNA_collection_types.h"
46 #include "DNA_mesh_types.h"
47 #include "DNA_meshdata_types.h"
48 #include "DNA_scene_types.h"
49 #include "DNA_vfont_types.h"
50
51 #include "BKE_animsys.h"
52 #include "BKE_collection.h"
53 #include "BKE_font.h"
54 #include "BKE_global.h"
55 #include "BKE_idprop.h"
56 #include "BKE_lattice.h"
57 #include "BKE_main.h"
58 #include "BKE_mesh.h"
59 #include "BKE_mesh_iterators.h"
60 #include "BKE_mesh_runtime.h"
61 #include "BKE_object.h"
62 #include "BKE_particle.h"
63 #include "BKE_scene.h"
64 #include "BKE_editmesh.h"
65 #include "BKE_anim.h"
66
67 #include "DEG_depsgraph.h"
68 #include "DEG_depsgraph_query.h"
69
70 #include "BLI_strict_flags.h"
71 #include "BLI_hash.h"
72
73 /* Dupli-Geometry */
74
75 typedef struct DupliContext {
76         Depsgraph *depsgraph;
77         Collection *collection; /* XXX child objects are selected from this group if set, could be nicer */
78         Object *obedit; /* Only to check if the object is in edit-mode. */
79
80         Scene *scene;
81         ViewLayer *view_layer;
82         Object *object;
83         float space_mat[4][4];
84
85         int persistent_id[MAX_DUPLI_RECUR];
86         int level;
87
88         const struct DupliGenerator *gen;
89
90         /* result containers */
91         ListBase *duplilist; /* legacy doubly-linked list */
92 } DupliContext;
93
94 typedef struct DupliGenerator {
95         short type;                             /* dupli type */
96         void (*make_duplis)(const DupliContext *ctx);
97 } DupliGenerator;
98
99 static const DupliGenerator *get_dupli_generator(const DupliContext *ctx);
100
101 /* create initial context for root object */
102 static void init_context(
103         DupliContext *r_ctx, Depsgraph *depsgraph,
104         Scene *scene, Object *ob, float space_mat[4][4])
105 {
106         r_ctx->depsgraph = depsgraph;
107         r_ctx->scene = scene;
108         r_ctx->view_layer = DEG_get_evaluated_view_layer(depsgraph);
109         r_ctx->collection = NULL;
110
111         r_ctx->object = ob;
112         r_ctx->obedit = OBEDIT_FROM_OBACT(ob);
113         if (space_mat)
114                 copy_m4_m4(r_ctx->space_mat, space_mat);
115         else
116                 unit_m4(r_ctx->space_mat);
117         r_ctx->level = 0;
118
119         r_ctx->gen = get_dupli_generator(r_ctx);
120
121         r_ctx->duplilist = NULL;
122 }
123
124 /* create sub-context for recursive duplis */
125 static void copy_dupli_context(DupliContext *r_ctx, const DupliContext *ctx, Object *ob, float mat[4][4], int index)
126 {
127         *r_ctx = *ctx;
128
129         /* XXX annoying, previously was done by passing an ID* argument, this at least is more explicit */
130         if (ctx->gen->type == OB_DUPLICOLLECTION)
131                 r_ctx->collection = ctx->object->dup_group;
132
133         r_ctx->object = ob;
134         if (mat)
135                 mul_m4_m4m4(r_ctx->space_mat, (float (*)[4])ctx->space_mat, mat);
136         r_ctx->persistent_id[r_ctx->level] = index;
137         ++r_ctx->level;
138
139         r_ctx->gen = get_dupli_generator(r_ctx);
140 }
141
142 /* generate a dupli instance
143  * mat is transform of the object relative to current context (including object obmat)
144  */
145 static DupliObject *make_dupli(const DupliContext *ctx,
146                                Object *ob, float mat[4][4], int index)
147 {
148         DupliObject *dob;
149         int i;
150
151         /* add a DupliObject instance to the result container */
152         if (ctx->duplilist) {
153                 dob = MEM_callocN(sizeof(DupliObject), "dupli object");
154                 BLI_addtail(ctx->duplilist, dob);
155         }
156         else {
157                 return NULL;
158         }
159
160         dob->ob = ob;
161         mul_m4_m4m4(dob->mat, (float (*)[4])ctx->space_mat, mat);
162         dob->type = ctx->gen->type;
163
164         /* set persistent id, which is an array with a persistent index for each level
165          * (particle number, vertex number, ..). by comparing this we can find the same
166          * dupli object between frames, which is needed for motion blur. last level
167          * goes first in the array. */
168         dob->persistent_id[0] = index;
169         for (i = 1; i < ctx->level + 1; i++)
170                 dob->persistent_id[i] = ctx->persistent_id[ctx->level - i];
171         /* fill rest of values with INT_MAX which index will never have as value */
172         for (; i < MAX_DUPLI_RECUR; i++)
173                 dob->persistent_id[i] = INT_MAX;
174
175         /* metaballs never draw in duplis, they are instead merged into one by the basis
176          * mball outside of the group. this does mean that if that mball is not in the
177          * scene, they will not show up at all, limitation that should be solved once. */
178         if (ob->type == OB_MBALL)
179                 dob->no_draw = true;
180
181         /* random number */
182         /* the logic here is designed to match Cycles */
183         dob->random_id = BLI_hash_string(dob->ob->id.name + 2);
184
185         if (dob->persistent_id[0] != INT_MAX) {
186                 for (i = 0; i < MAX_DUPLI_RECUR * 2; i++) {
187                         dob->random_id = BLI_hash_int_2d(dob->random_id, (unsigned int)dob->persistent_id[i]);
188                 }
189         }
190         else {
191                 dob->random_id = BLI_hash_int_2d(dob->random_id, 0);
192         }
193
194         if (ctx->object != ob) {
195                 dob->random_id ^= BLI_hash_int(BLI_hash_string(ctx->object->id.name + 2));
196         }
197
198         return dob;
199 }
200
201 /* recursive dupli objects
202  * space_mat is the local dupli space (excluding dupli object obmat!)
203  */
204 static void make_recursive_duplis(const DupliContext *ctx, Object *ob, float space_mat[4][4], int index)
205 {
206         /* simple preventing of too deep nested collections with MAX_DUPLI_RECUR */
207         if (ctx->level < MAX_DUPLI_RECUR) {
208                 DupliContext rctx;
209                 copy_dupli_context(&rctx, ctx, ob, space_mat, index);
210                 if (rctx.gen) {
211                         rctx.gen->make_duplis(&rctx);
212                 }
213         }
214 }
215
216 /* ---- Child Duplis ---- */
217
218 typedef void (*MakeChildDuplisFunc)(const DupliContext *ctx, void *userdata, Object *child);
219
220 static bool is_child(const Object *ob, const Object *parent)
221 {
222         const Object *ob_parent = ob->parent;
223         while (ob_parent) {
224                 if (ob_parent == parent)
225                         return true;
226                 ob_parent = ob_parent->parent;
227         }
228         return false;
229 }
230
231 /* create duplis from every child in scene or collection */
232 static void make_child_duplis(const DupliContext *ctx, void *userdata, MakeChildDuplisFunc make_child_duplis_cb)
233 {
234         Object *parent = ctx->object;
235
236         if (ctx->collection) {
237                 eEvaluationMode mode = DEG_get_mode(ctx->depsgraph);
238                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(ctx->collection, ob, mode)
239                 {
240                         if ((ob != ctx->obedit) && is_child(ob, parent)) {
241                                 DupliContext pctx;
242                                 copy_dupli_context(&pctx, ctx, ctx->object, NULL, _base_id);
243
244                                 /* mballs have a different dupli handling */
245                                 if (ob->type != OB_MBALL) {
246                                         ob->flag |= OB_DONE;  /* doesn't render */
247                                 }
248                                 make_child_duplis_cb(&pctx, userdata, ob);
249                         }
250                 }
251                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
252         }
253         else {
254                 int baseid = 0;
255                 ViewLayer *view_layer = ctx->view_layer;
256                 for (Base *base = view_layer->object_bases.first; base; base = base->next, baseid++) {
257                         Object *ob = base->object;
258                         if ((ob != ctx->obedit) && is_child(ob, parent)) {
259                                 DupliContext pctx;
260                                 copy_dupli_context(&pctx, ctx, ctx->object, NULL, baseid);
261
262                                 /* mballs have a different dupli handling */
263                                 if (ob->type != OB_MBALL)
264                                         ob->flag |= OB_DONE;  /* doesn't render */
265
266                                 make_child_duplis_cb(&pctx, userdata, ob);
267                         }
268                 }
269         }
270 }
271
272
273 /*---- Implementations ----*/
274
275 /* OB_DUPLICOLLECTION */
276 static void make_duplis_collection(const DupliContext *ctx)
277 {
278         Object *ob = ctx->object;
279         Collection *collection;
280         float collection_mat[4][4];
281
282         if (ob->dup_group == NULL) return;
283         collection = ob->dup_group;
284
285         /* combine collection offset and obmat */
286         unit_m4(collection_mat);
287         sub_v3_v3(collection_mat[3], collection->dupli_ofs);
288         mul_m4_m4m4(collection_mat, ob->obmat, collection_mat);
289         /* don't access 'ob->obmat' from now on. */
290
291         eEvaluationMode mode = DEG_get_mode(ctx->depsgraph);
292         FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(collection, cob, mode)
293         {
294                 if (cob != ob) {
295                         float mat[4][4];
296
297                         /* collection dupli offset, should apply after everything else */
298                         mul_m4_m4m4(mat, collection_mat, cob->obmat);
299
300                         make_dupli(ctx, cob, mat, _base_id);
301
302                         /* recursion */
303                         make_recursive_duplis(ctx, cob, collection_mat, _base_id);
304                 }
305         }
306         FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
307 }
308
309 static const DupliGenerator gen_dupli_collection = {
310     OB_DUPLICOLLECTION,             /* type */
311     make_duplis_collection          /* make_duplis */
312 };
313
314 /* OB_DUPLIFRAMES */
315 static void make_duplis_frames(const DupliContext *ctx)
316 {
317         Depsgraph *depsgraph = ctx->depsgraph;
318         Scene *scene = ctx->scene;
319         Object *ob = ctx->object;
320         Object copyob;
321         int dupend = ob->dupend;
322
323         /* dupliframes not supported inside collections */
324         if (ctx->collection)
325                 return;
326         /* if we don't have any data/settings which will lead to object movement,
327          * don't waste time trying, as it will all look the same...
328          */
329         if (ob->parent == NULL && BLI_listbase_is_empty(&ob->constraints) && ob->adt == NULL)
330                 return;
331
332         /* make a copy of the object's original data (before any dupli-data overwrites it)
333          * as we'll need this to keep track of unkeyed data
334          * - this doesn't take into account other data that can be reached from the object,
335          *   for example it's shapekeys or bones, hence the need for an update flush at the end
336          */
337         copyob = *ob;
338
339         /* duplicate over the required range */
340         const int dupli_transflag = (ob->transflag & OB_DUPLINOSPEED);
341         for (int frame = ob->dupsta; frame <= dupend; frame++) {
342                 int ok = 1;
343
344                 /* - dupoff = how often a frames within the range shouldn't be made into duplis
345                  * - dupon = the length of each "skipping" block in frames
346                  */
347                 if (ob->dupoff) {
348                         ok = frame - ob->dupsta;
349                         ok = ok % (ob->dupon + ob->dupoff);
350                         ok = (ok < ob->dupon);
351                 }
352
353                 if (ok) {
354                         /* WARNING: doing animation updates in this way is not terribly accurate, as the dependencies
355                          * and/or other objects which may affect this object's transforms are not updated either.
356                          * However, this has always been the way that this worked (i.e. pre 2.5), so I guess that it'll be fine!
357                          */
358                         /* ob-eval will do drivers, so we don't need to do them */
359                         BKE_animsys_evaluate_animdata(depsgraph, scene, &ob->id, ob->adt, (float)frame, ADT_RECALC_ANIM);
360                         BKE_object_where_is_calc_time_for_dupli(depsgraph, scene, ob, (float)frame, dupli_transflag);
361
362                         make_dupli(ctx, ob, ob->obmat, frame);
363                 }
364         }
365
366         /* ob-eval will do drivers, so we don't need to do them */
367         const float original_ctime = DEG_get_ctime(depsgraph);
368         BKE_animsys_evaluate_animdata(depsgraph, scene, &ob->id, ob->adt, original_ctime, ADT_RECALC_ANIM);
369         BKE_object_where_is_calc_time(depsgraph, scene, ob, original_ctime);
370
371         /* but, to make sure unkeyed object transforms are still sane,
372          * let's copy object's original data back over
373          */
374         *ob = copyob;
375 }
376
377 static const DupliGenerator gen_dupli_frames = {
378     OB_DUPLIFRAMES,                 /* type */
379     make_duplis_frames              /* make_duplis */
380 };
381
382 /* OB_DUPLIVERTS */
383 typedef struct VertexDupliData {
384         Mesh *me_eval;
385         BMEditMesh *edit_btmesh;
386         int totvert;
387         float (*orco)[3];
388         bool use_rotation;
389
390         const DupliContext *ctx;
391         Object *inst_ob; /* object to instantiate (argument for vertex map callback) */
392         float child_imat[4][4];
393 } VertexDupliData;
394
395 static void get_duplivert_transform(const float co[3], const float nor_f[3], const short nor_s[3],
396                                     bool use_rotation, short axis, short upflag, float mat[4][4])
397 {
398         float quat[4];
399         const float size[3] = {1.0f, 1.0f, 1.0f};
400
401         if (use_rotation) {
402                 float nor[3];
403                 /* construct rotation matrix from normals */
404                 if (nor_f) {
405                         nor[0] = -nor_f[0];
406                         nor[1] = -nor_f[1];
407                         nor[2] = -nor_f[2];
408                 }
409                 else if (nor_s) {
410                         nor[0] = (float)-nor_s[0];
411                         nor[1] = (float)-nor_s[1];
412                         nor[2] = (float)-nor_s[2];
413                 }
414                 vec_to_quat(quat, nor, axis, upflag);
415         }
416         else
417                 unit_qt(quat);
418
419         loc_quat_size_to_mat4(mat, co, quat, size);
420 }
421
422 static void vertex_dupli__mapFunc(void *userData, int index, const float co[3],
423                                   const float nor_f[3], const short nor_s[3])
424 {
425         const VertexDupliData *vdd = userData;
426         Object *inst_ob = vdd->inst_ob;
427         DupliObject *dob;
428         float obmat[4][4], space_mat[4][4];
429
430         /* obmat is transform to vertex */
431         get_duplivert_transform(co, nor_f, nor_s, vdd->use_rotation, inst_ob->trackflag, inst_ob->upflag, obmat);
432         /* make offset relative to inst_ob using relative child transform */
433         mul_mat3_m4_v3((float (*)[4])vdd->child_imat, obmat[3]);
434         /* apply obmat _after_ the local vertex transform */
435         mul_m4_m4m4(obmat, inst_ob->obmat, obmat);
436
437         /* space matrix is constructed by removing obmat transform,
438          * this yields the worldspace transform for recursive duplis
439          */
440         mul_m4_m4m4(space_mat, obmat, inst_ob->imat);
441
442         dob = make_dupli(vdd->ctx, vdd->inst_ob, obmat, index);
443
444         if (vdd->orco)
445                 copy_v3_v3(dob->orco, vdd->orco[index]);
446
447         /* recursion */
448         make_recursive_duplis(vdd->ctx, vdd->inst_ob, space_mat, index);
449 }
450
451 static void make_child_duplis_verts(const DupliContext *ctx, void *userdata, Object *child)
452 {
453         VertexDupliData *vdd = userdata;
454         Mesh *me_eval = vdd->me_eval;
455
456         vdd->inst_ob = child;
457         invert_m4_m4(child->imat, child->obmat);
458         /* relative transform from parent to child space */
459         mul_m4_m4m4(vdd->child_imat, child->imat, ctx->object->obmat);
460
461         BKE_mesh_foreach_mapped_vert(me_eval, vertex_dupli__mapFunc, vdd,
462                                      vdd->use_rotation ? MESH_FOREACH_USE_NORMAL : 0);
463 }
464
465 static void make_duplis_verts(const DupliContext *ctx)
466 {
467         Scene *scene = ctx->scene;
468         Object *parent = ctx->object;
469         bool use_texcoords = (DEG_get_mode(ctx->depsgraph) == DAG_EVAL_RENDER);
470         VertexDupliData vdd;
471
472         vdd.ctx = ctx;
473         vdd.use_rotation = parent->transflag & OB_DUPLIROT;
474
475         /* gather mesh info */
476         {
477                 CustomDataMask dm_mask = (use_texcoords ? CD_MASK_BAREMESH | CD_MASK_ORCO : CD_MASK_BAREMESH);
478                 vdd.edit_btmesh = BKE_editmesh_from_object(parent);
479
480                 /* We do not need any render-smecific handling anymore, depsgraph takes care of that. */
481                 if (vdd.edit_btmesh != NULL) {
482                         /* XXX TODO replace with equivalent of editbmesh_get_eval_cage when available. */
483                         vdd.me_eval = mesh_get_eval_deform(ctx->depsgraph, scene, parent, dm_mask);
484                 }
485                 else {
486                         vdd.me_eval = mesh_get_eval_final(ctx->depsgraph, scene, parent, dm_mask);
487                 }
488
489                 if (use_texcoords) {
490                         vdd.orco = CustomData_get_layer(&vdd.me_eval->vdata, CD_ORCO);
491                 }
492                 else {
493                         vdd.orco = NULL;
494                 }
495
496                 vdd.totvert = vdd.me_eval->totvert;
497         }
498
499         make_child_duplis(ctx, &vdd, make_child_duplis_verts);
500
501         vdd.me_eval = NULL;
502 }
503
504 static const DupliGenerator gen_dupli_verts = {
505     OB_DUPLIVERTS,                  /* type */
506     make_duplis_verts               /* make_duplis */
507 };
508
509 /* OB_DUPLIVERTS - FONT */
510 static Object *find_family_object(Main *bmain, const char *family, size_t family_len, unsigned int ch, GHash *family_gh)
511 {
512         Object **ob_pt;
513         Object *ob;
514         void *ch_key = POINTER_FROM_UINT(ch);
515
516         if ((ob_pt = (Object **)BLI_ghash_lookup_p(family_gh, ch_key))) {
517                 ob = *ob_pt;
518         }
519         else {
520                 char ch_utf8[7];
521                 size_t ch_utf8_len;
522
523                 ch_utf8_len = BLI_str_utf8_from_unicode(ch, ch_utf8);
524                 ch_utf8[ch_utf8_len] = '\0';
525                 ch_utf8_len += 1;  /* compare with null terminator */
526
527                 for (ob = bmain->object.first; ob; ob = ob->id.next) {
528                         if (STREQLEN(ob->id.name + 2 + family_len, ch_utf8, ch_utf8_len)) {
529                                 if (STREQLEN(ob->id.name + 2, family, family_len)) {
530                                         break;
531                                 }
532                         }
533                 }
534
535                 /* inserted value can be NULL, just to save searches in future */
536                 BLI_ghash_insert(family_gh, ch_key, ob);
537         }
538
539         return ob;
540 }
541
542 static void make_duplis_font(const DupliContext *ctx)
543 {
544         Object *par = ctx->object;
545         GHash *family_gh;
546         Object *ob;
547         Curve *cu;
548         struct CharTrans *ct, *chartransdata = NULL;
549         float vec[3], obmat[4][4], pmat[4][4], fsize, xof, yof;
550         int text_len, a;
551         size_t family_len;
552         const wchar_t *text = NULL;
553         bool text_free = false;
554
555         /* font dupliverts not supported inside collections */
556         if (ctx->collection)
557                 return;
558
559         copy_m4_m4(pmat, par->obmat);
560
561         /* in par the family name is stored, use this to find the other objects */
562
563         BKE_vfont_to_curve_ex(par, par->data, FO_DUPLI, NULL,
564                               &text, &text_len, &text_free, &chartransdata);
565
566         if (text == NULL || chartransdata == NULL) {
567                 return;
568         }
569
570         cu = par->data;
571         fsize = cu->fsize;
572         xof = cu->xof;
573         yof = cu->yof;
574
575         ct = chartransdata;
576
577         /* cache result */
578         family_len = strlen(cu->family);
579         family_gh = BLI_ghash_int_new_ex(__func__, 256);
580
581         /* advance matching BLI_strncpy_wchar_from_utf8 */
582         for (a = 0; a < text_len; a++, ct++) {
583
584                 /* XXX That G.main is *really* ugly, but not sure what to do here...
585                  * Definitively don't think it would be safe to put back Main *bmain pointer in DupliContext as done in 2.7x? */
586                 ob = find_family_object(G.main, cu->family, family_len, (unsigned int)text[a], family_gh);
587                 if (ob) {
588                         vec[0] = fsize * (ct->xof - xof);
589                         vec[1] = fsize * (ct->yof - yof);
590                         vec[2] = 0.0;
591
592                         mul_m4_v3(pmat, vec);
593
594                         copy_m4_m4(obmat, par->obmat);
595
596                         if (UNLIKELY(ct->rot != 0.0f)) {
597                                 float rmat[4][4];
598
599                                 zero_v3(obmat[3]);
600                                 axis_angle_to_mat4_single(rmat, 'Z', -ct->rot);
601                                 mul_m4_m4m4(obmat, obmat, rmat);
602                         }
603
604                         copy_v3_v3(obmat[3], vec);
605
606                         make_dupli(ctx, ob, obmat, a);
607                 }
608         }
609
610         if (text_free) {
611                 MEM_freeN((void *)text);
612         }
613
614         BLI_ghash_free(family_gh, NULL, NULL);
615
616         MEM_freeN(chartransdata);
617 }
618
619 static const DupliGenerator gen_dupli_verts_font = {
620     OB_DUPLIVERTS,                  /* type */
621     make_duplis_font                /* make_duplis */
622 };
623
624 /* OB_DUPLIFACES */
625 typedef struct FaceDupliData {
626         Mesh *me_eval;
627         int totface;
628         MPoly *mpoly;
629         MLoop *mloop;
630         MVert *mvert;
631         float (*orco)[3];
632         MLoopUV *mloopuv;
633         bool use_scale;
634 } FaceDupliData;
635
636 static void get_dupliface_transform(MPoly *mpoly, MLoop *mloop, MVert *mvert,
637                                     bool use_scale, float scale_fac, float mat[4][4])
638 {
639         float loc[3], quat[4], scale, size[3];
640         float f_no[3];
641
642         /* location */
643         BKE_mesh_calc_poly_center(mpoly, mloop, mvert, loc);
644         /* rotation */
645         {
646                 const float *v1, *v2, *v3;
647                 BKE_mesh_calc_poly_normal(mpoly, mloop, mvert, f_no);
648                 v1 = mvert[mloop[0].v].co;
649                 v2 = mvert[mloop[1].v].co;
650                 v3 = mvert[mloop[2].v].co;
651                 tri_to_quat_ex(quat, v1, v2, v3, f_no);
652         }
653         /* scale */
654         if (use_scale) {
655                 float area = BKE_mesh_calc_poly_area(mpoly, mloop, mvert);
656                 scale = sqrtf(area) * scale_fac;
657         }
658         else
659                 scale = 1.0f;
660         size[0] = size[1] = size[2] = scale;
661
662         loc_quat_size_to_mat4(mat, loc, quat, size);
663 }
664
665 static void make_child_duplis_faces(const DupliContext *ctx, void *userdata, Object *inst_ob)
666 {
667         FaceDupliData *fdd = userdata;
668         MPoly *mpoly = fdd->mpoly, *mp;
669         MLoop *mloop = fdd->mloop;
670         MVert *mvert = fdd->mvert;
671         float (*orco)[3] = fdd->orco;
672         MLoopUV *mloopuv = fdd->mloopuv;
673         int a, totface = fdd->totface;
674         bool use_texcoords = (DEG_get_mode(ctx->depsgraph) == DAG_EVAL_RENDER);
675         float child_imat[4][4];
676         DupliObject *dob;
677
678         invert_m4_m4(inst_ob->imat, inst_ob->obmat);
679         /* relative transform from parent to child space */
680         mul_m4_m4m4(child_imat, inst_ob->imat, ctx->object->obmat);
681
682         for (a = 0, mp = mpoly; a < totface; a++, mp++) {
683                 MLoop *loopstart = mloop + mp->loopstart;
684                 float space_mat[4][4], obmat[4][4];
685
686                 if (UNLIKELY(mp->totloop < 3))
687                         continue;
688
689                 /* obmat is transform to face */
690                 get_dupliface_transform(mp, loopstart, mvert, fdd->use_scale, ctx->object->dupfacesca, obmat);
691                 /* make offset relative to inst_ob using relative child transform */
692                 mul_mat3_m4_v3(child_imat, obmat[3]);
693
694                 /* XXX ugly hack to ensure same behavior as in master
695                  * this should not be needed, parentinv is not consistent
696                  * outside of parenting.
697                  */
698                 {
699                         float imat[3][3];
700                         copy_m3_m4(imat, inst_ob->parentinv);
701                         mul_m4_m3m4(obmat, imat, obmat);
702                 }
703
704                 /* apply obmat _after_ the local face transform */
705                 mul_m4_m4m4(obmat, inst_ob->obmat, obmat);
706
707                 /* space matrix is constructed by removing obmat transform,
708                  * this yields the worldspace transform for recursive duplis
709                  */
710                 mul_m4_m4m4(space_mat, obmat, inst_ob->imat);
711
712                 dob = make_dupli(ctx, inst_ob, obmat, a);
713                 if (use_texcoords) {
714                         float w = 1.0f / (float)mp->totloop;
715
716                         if (orco) {
717                                 int j;
718                                 for (j = 0; j < mp->totloop; j++) {
719                                         madd_v3_v3fl(dob->orco, orco[loopstart[j].v], w);
720                                 }
721                         }
722
723                         if (mloopuv) {
724                                 int j;
725                                 for (j = 0; j < mp->totloop; j++) {
726                                         madd_v2_v2fl(dob->uv, mloopuv[mp->loopstart + j].uv, w);
727                                 }
728                         }
729                 }
730
731                 /* recursion */
732                 make_recursive_duplis(ctx, inst_ob, space_mat, a);
733         }
734 }
735
736 static void make_duplis_faces(const DupliContext *ctx)
737 {
738         Scene *scene = ctx->scene;
739         Object *parent = ctx->object;
740         bool use_texcoords = (DEG_get_mode(ctx->depsgraph) == DAG_EVAL_RENDER);
741         FaceDupliData fdd;
742
743         fdd.use_scale = ((parent->transflag & OB_DUPLIFACES_SCALE) != 0);
744
745         /* gather mesh info */
746         {
747                 BMEditMesh *em = BKE_editmesh_from_object(parent);
748                 CustomDataMask dm_mask = (use_texcoords ? CD_MASK_BAREMESH | CD_MASK_ORCO | CD_MASK_MLOOPUV : CD_MASK_BAREMESH);
749
750                 /* We do not need any render-smecific handling anymore, depsgraph takes care of that. */
751                 if (em != NULL) {
752                         /* XXX TODO replace with equivalent of editbmesh_get_eval_cage when available. */
753                         fdd.me_eval = mesh_get_eval_deform(ctx->depsgraph, scene, parent, dm_mask);
754                 }
755                 else {
756                         fdd.me_eval = mesh_get_eval_final(ctx->depsgraph, scene, parent, dm_mask);
757                 }
758
759                 if (use_texcoords) {
760                         fdd.orco = CustomData_get_layer(&fdd.me_eval->vdata, CD_ORCO);
761                         const int uv_idx = CustomData_get_render_layer(&fdd.me_eval->ldata, CD_MLOOPUV);
762                         fdd.mloopuv = CustomData_get_layer_n(&fdd.me_eval->ldata, CD_MLOOPUV, uv_idx);
763                 }
764                 else {
765                         fdd.orco = NULL;
766                         fdd.mloopuv = NULL;
767                 }
768
769                 fdd.totface = fdd.me_eval->totpoly;
770                 fdd.mpoly = fdd.me_eval->mpoly;
771                 fdd.mloop = fdd.me_eval->mloop;
772                 fdd.mvert = fdd.me_eval->mvert;
773         }
774
775         make_child_duplis(ctx, &fdd, make_child_duplis_faces);
776
777         fdd.me_eval = NULL;
778 }
779
780 static const DupliGenerator gen_dupli_faces = {
781     OB_DUPLIFACES,                  /* type */
782     make_duplis_faces               /* make_duplis */
783 };
784
785 /* OB_DUPLIPARTS */
786 static void make_duplis_particle_system(const DupliContext *ctx, ParticleSystem *psys)
787 {
788         Scene *scene = ctx->scene;
789         Object *par = ctx->object;
790         eEvaluationMode mode = DEG_get_mode(ctx->depsgraph);
791         bool for_render = mode == DAG_EVAL_RENDER;
792         bool use_texcoords = for_render;
793
794         Object *ob = NULL, **oblist = NULL, obcopy, *obcopylist = NULL;
795         DupliObject *dob;
796         ParticleDupliWeight *dw;
797         ParticleSettings *part;
798         ParticleData *pa;
799         ChildParticle *cpa = NULL;
800         ParticleKey state;
801         ParticleCacheKey *cache;
802         float ctime, pa_time, scale = 1.0f;
803         float tmat[4][4], mat[4][4], pamat[4][4], vec[3], size = 0.0;
804         float (*obmat)[4];
805         int a, b, hair = 0;
806         int totpart, totchild;
807
808         int no_draw_flag = PARS_UNEXIST;
809
810         if (psys == NULL) return;
811
812         part = psys->part;
813
814         if (part == NULL)
815                 return;
816
817         if (!psys_check_enabled(par, psys, for_render))
818                 return;
819
820         if (!for_render)
821                 no_draw_flag |= PARS_NO_DISP;
822
823         ctime = DEG_get_ctime(ctx->depsgraph); /* NOTE: in old animsys, used parent object's timeoffset... */
824
825         totpart = psys->totpart;
826         totchild = psys->totchild;
827
828         if ((for_render || part->draw_as == PART_DRAW_REND) && ELEM(part->ren_as, PART_DRAW_OB, PART_DRAW_GR)) {
829                 ParticleSimulationData sim = {NULL};
830                 sim.depsgraph = ctx->depsgraph;
831                 sim.scene = scene;
832                 sim.ob = par;
833                 sim.psys = psys;
834                 sim.psmd = psys_get_modifier(par, psys);
835                 /* make sure emitter imat is in global coordinates instead of render view coordinates */
836                 invert_m4_m4(par->imat, par->obmat);
837
838                 /* first check for loops (particle system object used as dupli object) */
839                 if (part->ren_as == PART_DRAW_OB) {
840                         if (ELEM(part->dup_ob, NULL, par))
841                                 return;
842                 }
843                 else { /*PART_DRAW_GR */
844                         if (part->dup_group == NULL)
845                                 return;
846
847                         const ListBase dup_collection_objects = BKE_collection_object_cache_get(part->dup_group);
848                         if (BLI_listbase_is_empty(&dup_collection_objects))
849                                 return;
850
851                         if (BLI_findptr(&dup_collection_objects, par, offsetof(Base, object))) {
852                                 return;
853                         }
854                 }
855
856                 /* if we have a hair particle system, use the path cache */
857                 if (part->type == PART_HAIR) {
858                         if (psys->flag & PSYS_HAIR_DONE)
859                                 hair = (totchild == 0 || psys->childcache) && psys->pathcache;
860                         if (!hair)
861                                 return;
862
863                         /* we use cache, update totchild according to cached data */
864                         totchild = psys->totchildcache;
865                         totpart = psys->totcached;
866                 }
867
868                 RNG *rng = BLI_rng_new_srandom(31415926u + (unsigned int)psys->seed);
869
870                 psys->lattice_deform_data = psys_create_lattice_deform_data(&sim);
871
872                 /* gather list of objects or single object */
873                 int totcollection = 0;
874
875                 if (part->ren_as == PART_DRAW_GR) {
876                         if (part->draw & PART_DRAW_COUNT_GR) {
877                                 psys_find_group_weights(part);
878
879                                 for (dw = part->dupliweights.first; dw; dw = dw->next) {
880                                         FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(part->dup_group, object, mode)
881                                         {
882                                                 if (dw->ob == object) {
883                                                         totcollection += dw->count;
884                                                         break;
885                                                 }
886                                         }
887                                         FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
888                                 }
889                         }
890                         else {
891                                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(part->dup_group, object, mode)
892                                 {
893                                         (void) object;
894                                         totcollection++;
895                                 }
896                                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
897                         }
898
899                         /* we also copy the actual objects to restore afterwards, since
900                          * BKE_object_where_is_calc_time will change the object which breaks transform */
901                         oblist = MEM_callocN((size_t)totcollection * sizeof(Object *), "dupcollection object list");
902                         obcopylist = MEM_callocN((size_t)totcollection * sizeof(Object), "dupcollection copy list");
903
904                         if (part->draw & PART_DRAW_COUNT_GR) {
905                                 a = 0;
906                                 for (dw = part->dupliweights.first; dw; dw = dw->next) {
907                                         FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(part->dup_group, object, mode)
908                                         {
909                                                 if (dw->ob == object) {
910                                                         for (b = 0; b < dw->count; b++, a++) {
911                                                                 oblist[a] = dw->ob;
912                                                                 obcopylist[a] = *dw->ob;
913                                                         }
914                                                         break;
915                                                 }
916                                         }
917                                         FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
918                                 }
919                         }
920                         else {
921                                 a = 0;
922                                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(part->dup_group, object, mode)
923                                 {
924                                         oblist[a] = object;
925                                         obcopylist[a] = *object;
926                                         a++;
927                                 }
928                                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
929                         }
930                 }
931                 else {
932                         ob = part->dup_ob;
933                         obcopy = *ob;
934                 }
935
936                 if (totchild == 0 || part->draw & PART_DRAW_PARENT)
937                         a = 0;
938                 else
939                         a = totpart;
940
941                 for (pa = psys->particles; a < totpart + totchild; a++, pa++) {
942                         if (a < totpart) {
943                                 /* handle parent particle */
944                                 if (pa->flag & no_draw_flag)
945                                         continue;
946
947                                 /* pa_num = pa->num; */ /* UNUSED */
948                                 pa_time = pa->time;
949                                 size = pa->size;
950                         }
951                         else {
952                                 /* handle child particle */
953                                 cpa = &psys->child[a - totpart];
954
955                                 /* pa_num = a; */ /* UNUSED */
956                                 pa_time = psys->particles[cpa->parent].time;
957                                 size = psys_get_child_size(psys, cpa, ctime, NULL);
958                         }
959
960                         /* some hair paths might be non-existent so they can't be used for duplication */
961                         if (hair && psys->pathcache &&
962                             ((a < totpart && psys->pathcache[a]->segments < 0) ||
963                              (a >= totpart && psys->childcache[a - totpart]->segments < 0)))
964                         {
965                                 continue;
966                         }
967
968                         if (part->ren_as == PART_DRAW_GR) {
969                                 /* prevent divide by zero below [#28336] */
970                                 if (totcollection == 0)
971                                         continue;
972
973                                 /* for collections, pick the object based on settings */
974                                 if (part->draw & PART_DRAW_RAND_GR)
975                                         b = BLI_rng_get_int(rng) % totcollection;
976                                 else
977                                         b = a % totcollection;
978
979                                 ob = oblist[b];
980                                 obmat = oblist[b]->obmat;
981                         }
982                         else {
983                                 obmat = ob->obmat;
984                         }
985
986                         if (hair) {
987                                 /* hair we handle separate and compute transform based on hair keys */
988                                 if (a < totpart) {
989                                         cache = psys->pathcache[a];
990                                         psys_get_dupli_path_transform(&sim, pa, NULL, cache, pamat, &scale);
991                                 }
992                                 else {
993                                         cache = psys->childcache[a - totpart];
994                                         psys_get_dupli_path_transform(&sim, NULL, cpa, cache, pamat, &scale);
995                                 }
996
997                                 copy_v3_v3(pamat[3], cache->co);
998                                 pamat[3][3] = 1.0f;
999
1000                         }
1001                         else {
1002                                 /* first key */
1003                                 state.time = ctime;
1004                                 if (psys_get_particle_state(&sim, a, &state, 0) == 0) {
1005                                         continue;
1006                                 }
1007                                 else {
1008                                         float tquat[4];
1009                                         normalize_qt_qt(tquat, state.rot);
1010                                         quat_to_mat4(pamat, tquat);
1011                                         copy_v3_v3(pamat[3], state.co);
1012                                         pamat[3][3] = 1.0f;
1013                                 }
1014                         }
1015
1016                         if (part->ren_as == PART_DRAW_GR && psys->part->draw & PART_DRAW_WHOLE_GR) {
1017                                 b = 0;
1018                                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(part->dup_group, object, mode)
1019                                 {
1020                                         copy_m4_m4(tmat, oblist[b]->obmat);
1021
1022                                         /* apply particle scale */
1023                                         mul_mat3_m4_fl(tmat, size * scale);
1024                                         mul_v3_fl(tmat[3], size * scale);
1025
1026                                         /* collection dupli offset, should apply after everything else */
1027                                         if (!is_zero_v3(part->dup_group->dupli_ofs)) {
1028                                                 sub_v3_v3(tmat[3], part->dup_group->dupli_ofs);
1029                                         }
1030
1031                                         /* individual particle transform */
1032                                         mul_m4_m4m4(mat, pamat, tmat);
1033
1034                                         dob = make_dupli(ctx, object, mat, a);
1035                                         dob->particle_system = psys;
1036
1037                                         if (use_texcoords) {
1038                                                 psys_get_dupli_texture(psys, part, sim.psmd, pa, cpa, dob->uv, dob->orco);
1039                                         }
1040
1041                                         b++;
1042                                 }
1043                                 FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END;
1044                         }
1045                         else {
1046                                 /* to give ipos in object correct offset */
1047                                 BKE_object_where_is_calc_time(ctx->depsgraph, scene, ob, ctime - pa_time);
1048
1049                                 copy_v3_v3(vec, obmat[3]);
1050                                 obmat[3][0] = obmat[3][1] = obmat[3][2] = 0.0f;
1051
1052                                 /* particle rotation uses x-axis as the aligned axis, so pre-rotate the object accordingly */
1053                                 if ((part->draw & PART_DRAW_ROTATE_OB) == 0) {
1054                                         float xvec[3], q[4], size_mat[4][4], original_size[3];
1055
1056                                         mat4_to_size(original_size, obmat);
1057                                         size_to_mat4(size_mat, original_size);
1058
1059                                         xvec[0] = -1.f;
1060                                         xvec[1] = xvec[2] = 0;
1061                                         vec_to_quat(q, xvec, ob->trackflag, ob->upflag);
1062                                         quat_to_mat4(obmat, q);
1063                                         obmat[3][3] = 1.0f;
1064
1065                                         /* add scaling if requested */
1066                                         if ((part->draw & PART_DRAW_NO_SCALE_OB) == 0)
1067                                                 mul_m4_m4m4(obmat, obmat, size_mat);
1068                                 }
1069                                 else if (part->draw & PART_DRAW_NO_SCALE_OB) {
1070                                         /* remove scaling */
1071                                         float size_mat[4][4], original_size[3];
1072
1073                                         mat4_to_size(original_size, obmat);
1074                                         size_to_mat4(size_mat, original_size);
1075                                         invert_m4(size_mat);
1076
1077                                         mul_m4_m4m4(obmat, obmat, size_mat);
1078                                 }
1079
1080                                 mul_m4_m4m4(tmat, pamat, obmat);
1081                                 mul_mat3_m4_fl(tmat, size * scale);
1082
1083                                 copy_m4_m4(mat, tmat);
1084
1085                                 if (part->draw & PART_DRAW_GLOBAL_OB)
1086                                         add_v3_v3v3(mat[3], mat[3], vec);
1087
1088                                 dob = make_dupli(ctx, ob, mat, a);
1089                                 dob->particle_system = psys;
1090                                 if (use_texcoords)
1091                                         psys_get_dupli_texture(psys, part, sim.psmd, pa, cpa, dob->uv, dob->orco);
1092                         }
1093                 }
1094
1095                 /* restore objects since they were changed in BKE_object_where_is_calc_time */
1096                 if (part->ren_as == PART_DRAW_GR) {
1097                         for (a = 0; a < totcollection; a++)
1098                                 *(oblist[a]) = obcopylist[a];
1099                 }
1100                 else
1101                         *ob = obcopy;
1102
1103                 BLI_rng_free(rng);
1104         }
1105
1106         /* clean up */
1107         if (oblist)
1108                 MEM_freeN(oblist);
1109         if (obcopylist)
1110                 MEM_freeN(obcopylist);
1111
1112         if (psys->lattice_deform_data) {
1113                 end_latt_deform(psys->lattice_deform_data);
1114                 psys->lattice_deform_data = NULL;
1115         }
1116 }
1117
1118 static void make_duplis_particles(const DupliContext *ctx)
1119 {
1120         ParticleSystem *psys;
1121         int psysid;
1122
1123         /* particle system take up one level in id, the particles another */
1124         for (psys = ctx->object->particlesystem.first, psysid = 0; psys; psys = psys->next, psysid++) {
1125                 /* particles create one more level for persistent psys index */
1126                 DupliContext pctx;
1127                 copy_dupli_context(&pctx, ctx, ctx->object, NULL, psysid);
1128                 make_duplis_particle_system(&pctx, psys);
1129         }
1130 }
1131
1132 static const DupliGenerator gen_dupli_particles = {
1133     OB_DUPLIPARTS,                  /* type */
1134     make_duplis_particles           /* make_duplis */
1135 };
1136
1137 /* ------------- */
1138
1139 /* select dupli generator from given context */
1140 static const DupliGenerator *get_dupli_generator(const DupliContext *ctx)
1141 {
1142         int transflag = ctx->object->transflag;
1143         int restrictflag = ctx->object->restrictflag;
1144
1145         if ((transflag & OB_DUPLI) == 0)
1146                 return NULL;
1147
1148         /* Should the dupli's be generated for this object? - Respect restrict flags */
1149         if (DEG_get_mode(ctx->depsgraph) == DAG_EVAL_RENDER ? (restrictflag & OB_RESTRICT_RENDER) : (restrictflag & OB_RESTRICT_VIEW))
1150                 return NULL;
1151
1152         if (transflag & OB_DUPLIPARTS) {
1153                 return &gen_dupli_particles;
1154         }
1155         else if (transflag & OB_DUPLIVERTS) {
1156                 if (ctx->object->type == OB_MESH) {
1157                         return &gen_dupli_verts;
1158                 }
1159                 else if (ctx->object->type == OB_FONT) {
1160                         return &gen_dupli_verts_font;
1161                 }
1162         }
1163         else if (transflag & OB_DUPLIFACES) {
1164                 if (ctx->object->type == OB_MESH)
1165                         return &gen_dupli_faces;
1166         }
1167         else if (transflag & OB_DUPLIFRAMES) {
1168                 return &gen_dupli_frames;
1169         }
1170         else if (transflag & OB_DUPLICOLLECTION) {
1171                 return &gen_dupli_collection;
1172         }
1173
1174         return NULL;
1175 }
1176
1177
1178 /* ---- ListBase dupli container implementation ---- */
1179
1180 /* Returns a list of DupliObject */
1181 ListBase *object_duplilist(Depsgraph *depsgraph, Scene *sce, Object *ob)
1182 {
1183         ListBase *duplilist = MEM_callocN(sizeof(ListBase), "duplilist");
1184         DupliContext ctx;
1185         init_context(&ctx, depsgraph, sce, ob, NULL);
1186         if (ctx.gen) {
1187                 ctx.duplilist = duplilist;
1188                 ctx.gen->make_duplis(&ctx);
1189         }
1190
1191         return duplilist;
1192 }
1193
1194 void free_object_duplilist(ListBase *lb)
1195 {
1196         BLI_freelistN(lb);
1197         MEM_freeN(lb);
1198 }
1199
1200 int count_duplilist(Object *ob)
1201 {
1202         if (ob->transflag & OB_DUPLI) {
1203                 if (ob->transflag & OB_DUPLIVERTS) {
1204                         if (ob->type == OB_MESH) {
1205                                 if (ob->transflag & OB_DUPLIVERTS) {
1206                                         ParticleSystem *psys = ob->particlesystem.first;
1207                                         int pdup = 0;
1208
1209                                         for (; psys; psys = psys->next)
1210                                                 pdup += psys->totpart;
1211
1212                                         if (pdup == 0) {
1213                                                 Mesh *me = ob->data;
1214                                                 return me->totvert;
1215                                         }
1216                                         else
1217                                                 return pdup;
1218                                 }
1219                         }
1220                 }
1221                 else if (ob->transflag & OB_DUPLIFRAMES) {
1222                         int tot = ob->dupend - ob->dupsta;
1223                         tot /= (ob->dupon + ob->dupoff);
1224                         return tot * ob->dupon;
1225                 }
1226         }
1227         return 1;
1228 }