Extract common modifier parameters into ModifierEvalContext struct
[blender.git] / source / blender / modifiers / intern / MOD_meshsequencecache.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  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/modifiers/intern/MOD_meshsequencecache.c
24  *  \ingroup modifiers
25  */
26
27 #include "DNA_cachefile_types.h"
28 #include "DNA_mesh_types.h"
29 #include "DNA_modifier_types.h"
30 #include "DNA_object_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BKE_cachefile.h"
34 #include "BKE_DerivedMesh.h"
35 #include "BKE_cdderivedmesh.h"
36 #include "BKE_library.h"
37 #include "BKE_library_query.h"
38 #include "BKE_scene.h"
39
40 #include "DEG_depsgraph_build.h"
41
42 #include "MOD_modifiertypes.h"
43
44 #ifdef WITH_ALEMBIC
45 #       include "ABC_alembic.h"
46 #       include "BKE_global.h"
47 #endif
48
49 static void initData(ModifierData *md)
50 {
51         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *)md;
52
53         mcmd->cache_file = NULL;
54         mcmd->object_path[0] = '\0';
55         mcmd->read_flag = MOD_MESHSEQ_READ_ALL;
56 }
57
58 static void copyData(ModifierData *md, ModifierData *target)
59 {
60 #if 0
61         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *)md;
62 #endif
63         MeshSeqCacheModifierData *tmcmd = (MeshSeqCacheModifierData *)target;
64
65         modifier_copyData_generic(md, target);
66
67         if (tmcmd->cache_file) {
68                 id_us_plus(&tmcmd->cache_file->id);
69                 tmcmd->reader = NULL;
70         }
71 }
72
73 static void freeData(ModifierData *md)
74 {
75         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
76
77         if (mcmd->reader) {
78 #ifdef WITH_ALEMBIC
79                 CacheReader_free(mcmd->reader);
80 #endif
81                 mcmd->reader = NULL;
82         }
83 }
84
85 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
86 {
87         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
88
89         /* leave it up to the modifier to check the file is valid on calculation */
90         return (mcmd->cache_file == NULL) || (mcmd->object_path[0] == '\0');
91 }
92
93 static DerivedMesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx,
94                                   DerivedMesh *dm)
95 {
96 #ifdef WITH_ALEMBIC
97         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
98
99         /* Only used to check whether we are operating on org data or not... */
100         Mesh *me = (ctx->object->type == OB_MESH) ? ctx->object->data : NULL;
101         DerivedMesh *org_dm = dm;
102
103         Scene *scene = md->scene;
104         const float frame = BKE_scene_frame_get(scene);
105         const float time = BKE_cachefile_time_offset(mcmd->cache_file, frame, FPS);
106         const char *err_str = NULL;
107
108         CacheFile *cache_file = mcmd->cache_file;
109
110         BKE_cachefile_ensure_handle(G.main, cache_file);
111
112         if (!mcmd->reader) {
113                 mcmd->reader = CacheReader_open_alembic_object(cache_file->handle,
114                                                                NULL,
115                                                                ctx->object,
116                                                                mcmd->object_path);
117                 if (!mcmd->reader) {
118                         modifier_setError(md, "Could not create Alembic reader for file %s", cache_file->filepath);
119                         return dm;
120                 }
121         }
122
123         if (me != NULL) {
124                 MVert *mvert = dm->getVertArray(dm);
125                 MEdge *medge = dm->getEdgeArray(dm);
126                 MPoly *mpoly = dm->getPolyArray(dm);
127                 if ((me->mvert == mvert) || (me->medge == medge) || (me->mpoly == mpoly)) {
128                         /* We need to duplicate data here, otherwise we'll modify org mesh, see T51701. */
129                         dm = CDDM_copy(dm);
130                 }
131         }
132
133         DerivedMesh *result = ABC_read_mesh(mcmd->reader,
134                                             ctx->object,
135                                             dm,
136                                             time,
137                                             &err_str,
138                                             mcmd->read_flag);
139
140         if (err_str) {
141                 modifier_setError(md, "%s", err_str);
142         }
143
144         if (!ELEM(result, NULL, dm) && (dm != org_dm)) {
145                 dm->release(dm);
146                 dm = org_dm;
147         }
148
149         return result ? result : dm;
150 #else
151         return dm;
152         UNUSED_VARS(ctx, md);
153 #endif
154 }
155
156 static bool dependsOnTime(ModifierData *md)
157 {
158         UNUSED_VARS(md);
159         return true;
160 }
161
162 static void foreachIDLink(ModifierData *md, Object *ob,
163                           IDWalkFunc walk, void *userData)
164 {
165         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
166
167         walk(userData, ob, (ID **)&mcmd->cache_file, IDWALK_CB_USER);
168 }
169
170
171 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
172 {
173         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
174
175         if (mcmd->cache_file != NULL) {
176                 DEG_add_object_cache_relation(ctx->node, mcmd->cache_file, DEG_OB_COMP_CACHE, "Mesh Cache File");
177         }
178 }
179
180 ModifierTypeInfo modifierType_MeshSequenceCache = {
181         /* name */              "Mesh Sequence Cache",
182         /* structName */        "MeshSeqCacheModifierData",
183         /* structSize */        sizeof(MeshSeqCacheModifierData),
184         /* type */              eModifierTypeType_Constructive,
185         /* flags */             eModifierTypeFlag_AcceptsMesh |
186                                 eModifierTypeFlag_AcceptsCVs,
187
188         /* copyData */          copyData,
189
190         /* deformVerts_DM */    NULL,
191         /* deformMatrices_DM */ NULL,
192         /* deformVertsEM_DM */  NULL,
193         /* deformMatricesEM_DM*/NULL,
194         /* applyModifier_DM */  applyModifier,
195         /* applyModifierEM_DM */NULL,
196
197         /* deformVerts */       NULL,
198         /* deformMatrices */    NULL,
199         /* deformVertsEM */     NULL,
200         /* deformMatricesEM */  NULL,
201         /* applyModifier */     NULL,
202         /* applyModifierEM */   NULL,
203
204         /* initData */          initData,
205         /* requiredDataMask */  NULL,
206         /* freeData */          freeData,
207         /* isDisabled */        isDisabled,
208         /* updateDepsgraph */   updateDepsgraph,
209         /* dependsOnTime */     dependsOnTime,
210         /* dependsOnNormals */  NULL,
211         /* foreachObjectLink */ NULL,
212         /* foreachIDLink */     foreachIDLink,
213         /* foreachTexLink */    NULL,
214 };