Merge branch 'blender2.7'
[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 \ingroup bke
21  */
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         if (fxi->initData) fxi->initData(fx);
92
93         return fx;
94 }
95
96 static void shaderfx_free_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
97 {
98         ID *id = *idpoin;
99         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
100                 id_us_min(id);
101         }
102 }
103
104 void BKE_shaderfx_free_ex(ShaderFxData *fx, const int flag)
105 {
106         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
107
108         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
109                 if (fxi->foreachIDLink) {
110                         fxi->foreachIDLink(fx, NULL, shaderfx_free_data_id_us_cb, NULL);
111                 }
112                 else if (fxi->foreachObjectLink) {
113                         fxi->foreachObjectLink(fx, NULL, (ShaderFxObjectWalkFunc)shaderfx_free_data_id_us_cb, NULL);
114                 }
115         }
116
117         if (fxi->freeData) fxi->freeData(fx);
118         if (fx->error) MEM_freeN(fx->error);
119
120         MEM_freeN(fx);
121 }
122
123 void BKE_shaderfx_free(ShaderFxData *fx)
124 {
125         BKE_shaderfx_free_ex(fx, 0);
126 }
127
128 /* check unique name */
129 bool BKE_shaderfx_unique_name(ListBase *shaders, ShaderFxData *fx)
130 {
131         if (shaders && fx) {
132                 const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
133                 return BLI_uniquename(shaders, fx, DATA_(fxi->name), '.', offsetof(ShaderFxData, name), sizeof(fx->name));
134         }
135         return false;
136 }
137
138 bool BKE_shaderfx_dependsOnTime(ShaderFxData *fx)
139 {
140         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
141
142         return fxi->dependsOnTime && fxi->dependsOnTime(fx);
143 }
144
145 const ShaderFxTypeInfo *BKE_shaderfxType_getInfo(ShaderFxType type)
146 {
147         /* type unsigned, no need to check < 0 */
148         if (type < NUM_SHADER_FX_TYPES && shader_fx_types[type]->name[0] != '\0') {
149                 return shader_fx_types[type];
150         }
151         else {
152                 return NULL;
153         }
154 }
155
156 void BKE_shaderfx_copyData_generic(const ShaderFxData *fx_src, ShaderFxData *fx_dst)
157 {
158         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx_src->type);
159
160         /* fx_dst may have already be fully initialized with some extra allocated data,
161          * we need to free it now to avoid memleak. */
162         if (fxi->freeData) {
163                 fxi->freeData(fx_dst);
164         }
165
166         const size_t data_size = sizeof(ShaderFxData);
167         const char *fx_src_data = ((const char *)fx_src) + data_size;
168         char       *fx_dst_data = ((char *)fx_dst) + data_size;
169         BLI_assert(data_size <= (size_t)fxi->struct_size);
170         memcpy(fx_dst_data, fx_src_data, (size_t)fxi->struct_size - data_size);
171 }
172
173 static void shaderfx_copy_data_id_us_cb(void *UNUSED(userData), Object *UNUSED(ob), ID **idpoin, int cb_flag)
174 {
175         ID *id = *idpoin;
176         if (id != NULL && (cb_flag & IDWALK_CB_USER) != 0) {
177                 id_us_plus(id);
178         }
179 }
180
181 void BKE_shaderfx_copyData_ex(ShaderFxData *fx, ShaderFxData *target, const int flag)
182 {
183         const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
184
185         target->mode = fx->mode;
186         target->flag = fx->flag;
187
188         if (fxi->copyData) {
189                 fxi->copyData(fx, target);
190         }
191
192         if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) {
193                 if (fxi->foreachIDLink) {
194                         fxi->foreachIDLink(target, NULL, shaderfx_copy_data_id_us_cb, NULL);
195                 }
196                 else if (fxi->foreachObjectLink) {
197                         fxi->foreachObjectLink(target, NULL, (ShaderFxObjectWalkFunc)shaderfx_copy_data_id_us_cb, NULL);
198                 }
199         }
200 }
201
202 void BKE_shaderfx_copyData(ShaderFxData *fx, ShaderFxData *target)
203 {
204         BKE_shaderfx_copyData_ex(fx, target, 0);
205 }
206
207 ShaderFxData *BKE_shaderfx_findByType(Object *ob, ShaderFxType type)
208 {
209         ShaderFxData *fx = ob->shader_fx.first;
210
211         for (; fx; fx = fx->next)
212                 if (fx->type == type)
213                         break;
214
215         return fx;
216 }
217
218 void BKE_shaderfx_foreachIDLink(Object *ob, ShaderFxIDWalkFunc walk, void *userData)
219 {
220         ShaderFxData *fx = ob->shader_fx.first;
221
222         for (; fx; fx = fx->next) {
223                 const ShaderFxTypeInfo *fxi = BKE_shaderfxType_getInfo(fx->type);
224
225                 if (fxi->foreachIDLink) fxi->foreachIDLink(fx, ob, walk, userData);
226                 else if (fxi->foreachObjectLink) {
227                         /* each Object can masquerade as an ID, so this should be OK */
228                         ShaderFxObjectWalkFunc fp = (ShaderFxObjectWalkFunc)walk;
229                         fxi->foreachObjectLink(fx, ob, fp, userData);
230                 }
231         }
232 }
233
234 ShaderFxData *BKE_shaderfx_findByName(Object *ob, const char *name)
235 {
236         return BLI_findstring(&(ob->shader_fx), name, offsetof(ShaderFxData, name));
237 }