Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / intern / shader_fx.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) 2018, Blender Foundation
19  * This is a new part of Blender
20  *
21  * Contributor(s): Antonio Vazquez
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/shader_fx.c
27  *  \ingroup bke
28  */
29
30
31 #include <stdio.h>
32
33 #include "MEM_guardedalloc.h"
34
35 #include "BLI_blenlib.h"
36 #include "BLI_utildefines.h"
37 #include "BLI_math_vector.h"
38 #include "BLI_string_utils.h"
39
40 #include "BLT_translation.h"
41
42 #include "DNA_meshdata_types.h"
43 #include "DNA_scene_types.h"
44 #include "DNA_object_types.h"
45 #include "DNA_gpencil_types.h"
46 #include "DNA_shader_fx_types.h"
47
48 #include "BKE_global.h"
49 #include "BKE_library.h"
50 #include "BKE_library_query.h"
51 #include "BKE_gpencil.h"
52 #include "BKE_shader_fx.h"
53 #include "BKE_object.h"
54
55 #include "DEG_depsgraph.h"
56 #include "DEG_depsgraph_query.h"
57
58 #include "FX_shader_types.h"
59
60 static ShaderFxTypeInfo *shader_fx_types[NUM_SHADER_FX_TYPES] = { NULL };
61
62 /* *************************************************** */
63 /* Methods - Evaluation Loops, etc. */
64
65 /* check if exist grease pencil effects */
66 bool BKE_shaderfx_has_gpencil(Object *ob)
67 {
68         ShaderFxData *fx;
69         for (fx = ob->shader_fx.first; fx; fx = fx->next) {
70                 const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
71                 if (fxi->type == eShaderFxType_GpencilType) {
72                         return true;
73                 }
74         }
75         return false;
76 }
77
78 void BKE_shaderfx_init(void)
79 {
80         /* Initialize shaders */
81         shaderfx_type_init(shader_fx_types); /* FX_shader_util.c */
82 }
83
84 ShaderFxData *BKE_shaderfx_new(int type)
85 {
86         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(type);
87         ShaderFxData *fx = MEM_callocN(fxi->struct_size, fxi->struct_name);
88
89         /* note, this name must be made unique later */
90         BLI_strncpy(fx->name, DATA_(fxi->name), sizeof(fx->name));
91
92         fx->type = type;
93         fx->mode = eShaderFxMode_Realtime | eShaderFxMode_Render | eShaderFxMode_Expanded;
94         fx->flag = eShaderFxFlag_StaticOverride_Local;
95
96         if (fxi->flags & eShaderFxTypeFlag_EnableInEditmode)
97                 fx->mode |= eShaderFxMode_Editmode;
98
99         if (fxi->initData) fxi->initData(fx);
100
101         return fx;
102 }
103
104 static void shaderfx_free_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
105 {
106         ID *id = *idpoin;
107         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
108                 id_us_min(id);
109         }
110 }
111
112 void BKE_shaderfx_free_ex(ShaderFxData *fx, const int flag)
113 {
114         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
115
116         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
117                 if (fxi->foreachIDLink) {
118                         fxi->foreachIDLink(fx, NULL, shaderfx_free_data_id_us_cb, NULL);
119                 }
120                 else if (fxi->foreachObjectLink) {
121                         fxi->foreachObjectLink(fx, NULL, (ShaderFxObjectWalkFunc)shaderfx_free_data_id_us_cb, NULL);
122                 }
123         }
124
125         if (fxi->freeData) fxi->freeData(fx);
126         if (fx->error) MEM_freeN(fx->error);
127
128         MEM_freeN(fx);
129 }
130
131 void BKE_shaderfx_free(ShaderFxData *fx)
132 {
133         BKE_shaderfx_free_ex(fx, 0);
134 }
135
136 /* check unique name */
137 bool BKE_shaderfx_unique_name(ListBase *shaders, ShaderFxData *fx)
138 {
139         if (shaders && fx) {
140                 const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
141                 return BLI_uniquename(shaders, fx, DATA_(fxi->name), '.', offsetof(ShaderFxData, name), sizeof(fx->name));
142         }
143         return false;
144 }
145
146 bool BKE_shaderfx_dependsOnTime(ShaderFxData *fx)
147 {
148         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
149
150         return fxi->dependsOnTime && fxi->dependsOnTime(fx);
151 }
152
153 const ShaderFxTypeInfo *BKE_shaderfxType_getInfo(ShaderFxType type)
154 {
155         /* type unsigned, no need to check < 0 */
156         if (type < NUM_SHADER_FX_TYPES && shader_fx_types[type]->name[0] != '\0') {
157                 return shader_fx_types[type];
158         }
159         else {
160                 return NULL;
161         }
162 }
163
164 void BKE_shaderfx_copyData_generic(const ShaderFxData *fx_src, ShaderFxData *fx_dst)
165 {
166         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx_src->type);
167
168         /* fx_dst may have already be fully initialized with some extra allocated data,
169          * we need to free it now to avoid memleak. */
170         if (fxi->freeData) {
171                 fxi->freeData(fx_dst);
172         }
173
174         const size_t data_size = sizeof(ShaderFxData);
175         const char *fx_src_data = ((const char *)fx_src) + data_size;
176         char       *fx_dst_data = ((char *)fx_dst) + data_size;
177         BLI_assert(data_size <= (size_t)fxi->struct_size);
178         memcpy(fx_dst_data, fx_src_data, (size_t)fxi->struct_size - data_size);
179 }
180
181 static void shaderfx_copy_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
182 {
183         ID *id = *idpoin;
184         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
185                 id_us_plus(id);
186         }
187 }
188
189 void BKE_shaderfx_copyData_ex(ShaderFxData *fx, ShaderFxData *target, const int flag)
190 {
191         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
192
193         target->mode = fx->mode;
194         target->flag = fx->flag;
195
196         if (fxi->copyData) {
197                 fxi->copyData(fx, target);
198         }
199
200         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
201                 if (fxi->foreachIDLink) {
202                         fxi->foreachIDLink(target, NULL, shaderfx_copy_data_id_us_cb, NULL);
203                 }
204                 else if (fxi->foreachObjectLink) {
205                         fxi->foreachObjectLink(target, NULL, (ShaderFxObjectWalkFunc)shaderfx_copy_data_id_us_cb, NULL);
206                 }
207         }
208 }
209
210 void BKE_shaderfx_copyData(ShaderFxData *fx, ShaderFxData *target)
211 {
212         BKE_shaderfx_copyData_ex(fx, target, 0);
213 }
214
215 ShaderFxData *BKE_shaderfx_findByType(Object *ob, ShaderFxType type)
216 {
217         ShaderFxData *fx = ob->shader_fx.first;
218
219         for (; fx; fx = fx->next)
220                 if (fx->type == type)
221                         break;
222
223         return fx;
224 }
225
226 void BKE_shaderfx_foreachIDLink(Object *ob, ShaderFxIDWalkFunc walk, void *userData)
227 {
228         ShaderFxData *fx = ob->shader_fx.first;
229
230         for (; fx; fx = fx->next) {
231                 const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
232
233                 if (fxi->foreachIDLink) fxi->foreachIDLink(fx, ob, walk, userData);
234                 else if (fxi->foreachObjectLink) {
235                         /* each Object can masquerade as an ID, so this should be OK */
236                         ShaderFxObjectWalkFunc fp = (ShaderFxObjectWalkFunc)walk;
237                         fxi->foreachObjectLink(fx, ob, fp, userData);
238                 }
239         }
240 }
241
242 ShaderFxData *BKE_shaderfx_findByName(Object *ob, const char *name)
243 {
244         return BLI_findstring(&(ob->shader_fx), name, offsetof(ShaderFxData, name));
245 }