Cleanup: style, use braces for blenkernel
[blender.git] / source / blender / blenkernel / intern / shader_fx.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2018, Blender Foundation
17  * This is a new part of Blender
18  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #include <stdio.h>
25
26 #include "MEM_guardedalloc.h"
27
28 #include "BLI_blenlib.h"
29 #include "BLI_utildefines.h"
30 #include "BLI_math_vector.h"
31 #include "BLI_string_utils.h"
32
33 #include "BLT_translation.h"
34
35 #include "DNA_meshdata_types.h"
36 #include "DNA_scene_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_gpencil_types.h"
39 #include "DNA_shader_fx_types.h"
40
41 #include "BKE_library.h"
42 #include "BKE_library_query.h"
43 #include "BKE_gpencil.h"
44 #include "BKE_shader_fx.h"
45 #include "BKE_object.h"
46
47 #include "DEG_depsgraph.h"
48 #include "DEG_depsgraph_query.h"
49
50 #include "FX_shader_types.h"
51
52 static ShaderFxTypeInfo *shader_fx_types[NUM_SHADER_FX_TYPES] = {NULL};
53
54 /* *************************************************** */
55 /* Methods - Evaluation Loops, etc. */
56
57 /* check if exist grease pencil effects */
58 bool BKE_shaderfx_has_gpencil(Object *ob)
59 {
60   ShaderFxData *fx;
61   for (fx = ob->shader_fx.first; fx; fx = fx->next) {
62     const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
63     if (fxi->type == eShaderFxType_GpencilType) {
64       return true;
65     }
66   }
67   return false;
68 }
69
70 void BKE_shaderfx_init(void)
71 {
72   /* Initialize shaders */
73   shaderfx_type_init(shader_fx_types); /* FX_shader_util.c */
74 }
75
76 ShaderFxData *BKE_shaderfx_new(int type)
77 {
78   const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(type);
79   ShaderFxData *fx = MEM_callocN(fxi->struct_size, fxi->struct_name);
80
81   /* note, this name must be made unique later */
82   BLI_strncpy(fx->name, DATA_(fxi->name), sizeof(fx->name));
83
84   fx->type = type;
85   fx->mode = eShaderFxMode_Realtime | eShaderFxMode_Render | eShaderFxMode_Expanded;
86   fx->flag = eShaderFxFlag_StaticOverride_Local;
87
88   if (fxi->flags & eShaderFxTypeFlag_EnableInEditmode) {
89     fx->mode |= eShaderFxMode_Editmode;
90   }
91
92   if (fxi->initData) {
93     fxi->initData(fx);
94   }
95
96   return fx;
97 }
98
99 static void shaderfx_free_data_id_us_cb(void *UNUSED(userData),
100                                         Object *UNUSED(ob),
101                                         ID **idpoin,
102                                         int cb_flag)
103 {
104   ID *id = *idpoin;
105   if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
106     id_us_min(id);
107   }
108 }
109
110 void BKE_shaderfx_free_ex(ShaderFxData *fx, const int flag)
111 {
112   const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
113
114   if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
115     if (fxi->foreachIDLink) {
116       fxi->foreachIDLink(fx, NULL, shaderfx_free_data_id_us_cb, NULL);
117     }
118     else if (fxi->foreachObjectLink) {
119       fxi->foreachObjectLink(fx, NULL, (ShaderFxObjectWalkFunc)shaderfx_free_data_id_us_cb, NULL);
120     }
121   }
122
123   if (fxi->freeData) {
124     fxi->freeData(fx);
125   }
126   if (fx->error) {
127     MEM_freeN(fx->error);
128   }
129
130   MEM_freeN(fx);
131 }
132
133 void BKE_shaderfx_free(ShaderFxData *fx)
134 {
135   BKE_shaderfx_free_ex(fx, 0);
136 }
137
138 /* check unique name */
139 bool BKE_shaderfx_unique_name(ListBase *shaders, ShaderFxData *fx)
140 {
141   if (shaders && fx) {
142     const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
143     return BLI_uniquename(
144         shaders, fx, DATA_(fxi->name), '.', offsetof(ShaderFxData, name), sizeof(fx->name));
145   }
146   return false;
147 }
148
149 bool BKE_shaderfx_dependsOnTime(ShaderFxData *fx)
150 {
151   const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
152
153   return fxi->dependsOnTime && fxi->dependsOnTime(fx);
154 }
155
156 const ShaderFxTypeInfo *BKE_shaderfxType_getInfo(ShaderFxType type)
157 {
158   /* type unsigned, no need to check < 0 */
159   if (type < NUM_SHADER_FX_TYPES && shader_fx_types[type]->name[0] != '\0') {
160     return shader_fx_types[type];
161   }
162   else {
163     return NULL;
164   }
165 }
166
167 void BKE_shaderfx_copyData_generic(const ShaderFxData *fx_src, ShaderFxData *fx_dst)
168 {
169   const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx_src->type);
170
171   /* fx_dst may have already be fully initialized with some extra allocated data,
172    * we need to free it now to avoid memleak. */
173   if (fxi->freeData) {
174     fxi->freeData(fx_dst);
175   }
176
177   const size_t data_size = sizeof(ShaderFxData);
178   const char *fx_src_data = ((const char *)fx_src) + data_size;
179   char *fx_dst_data = ((char *)fx_dst) + data_size;
180   BLI_assert(data_size <= (size_t)fxi->struct_size);
181   memcpy(fx_dst_data, fx_src_data, (size_t)fxi->struct_size - data_size);
182 }
183
184 static void shaderfx_copy_data_id_us_cb(void *UNUSED(userData),
185                                         Object *UNUSED(ob),
186                                         ID **idpoin,
187                                         int cb_flag)
188 {
189   ID *id = *idpoin;
190   if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
191     id_us_plus(id);
192   }
193 }
194
195 void BKE_shaderfx_copyData_ex(ShaderFxData *fx, ShaderFxData *target, const int flag)
196 {
197   const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
198
199   target->mode = fx->mode;
200   target->flag = fx->flag;
201
202   if (fxi->copyData) {
203     fxi->copyData(fx, target);
204   }
205
206   if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
207     if (fxi->foreachIDLink) {
208       fxi->foreachIDLink(target, NULL, shaderfx_copy_data_id_us_cb, NULL);
209     }
210     else if (fxi->foreachObjectLink) {
211       fxi->foreachObjectLink(
212           target, NULL, (ShaderFxObjectWalkFunc)shaderfx_copy_data_id_us_cb, NULL);
213     }
214   }
215 }
216
217 void BKE_shaderfx_copyData(ShaderFxData *fx, ShaderFxData *target)
218 {
219   BKE_shaderfx_copyData_ex(fx, target, 0);
220 }
221
222 ShaderFxData *BKE_shaderfx_findByType(Object *ob, ShaderFxType type)
223 {
224   ShaderFxData *fx = ob->shader_fx.first;
225
226   for (; fx; fx = fx->next) {
227     if (fx->type == type) {
228       break;
229     }
230   }
231
232   return fx;
233 }
234
235 void BKE_shaderfx_foreachIDLink(Object *ob, ShaderFxIDWalkFunc walk, void *userData)
236 {
237   ShaderFxData *fx = ob->shader_fx.first;
238
239   for (; fx; fx = fx->next) {
240     const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
241
242     if (fxi->foreachIDLink) {
243       fxi->foreachIDLink(fx, ob, walk, userData);
244     }
245     else if (fxi->foreachObjectLink) {
246       /* each Object can masquerade as an ID, so this should be OK */
247       ShaderFxObjectWalkFunc fp = (ShaderFxObjectWalkFunc)walk;
248       fxi->foreachObjectLink(fx, ob, fp, userData);
249     }
250   }
251 }
252
253 ShaderFxData *BKE_shaderfx_findByName(Object *ob, const char *name)
254 {
255   return BLI_findstring(&(ob->shader_fx), name, offsetof(ShaderFxData, name));
256 }