a9c85376a487bad54379c4218a43c1b861d2d6e9
[blender.git] / source / blender / blenkernel / intern / lamp.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/lamp.c
29  *  \ingroup bke
30  */
31
32 #include <stdlib.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_anim_types.h"
37 #include "DNA_lamp_types.h"
38 #include "DNA_material_types.h"
39 #include "DNA_node_types.h"
40 #include "DNA_object_types.h"
41 #include "DNA_scene_types.h"
42 #include "DNA_texture_types.h"
43
44 #include "BLI_math.h"
45 #include "BLI_utildefines.h"
46
47 #include "BKE_animsys.h"
48 #include "BKE_colortools.h"
49 #include "BKE_icons.h"
50 #include "BKE_global.h"
51 #include "BKE_lamp.h"
52 #include "BKE_library.h"
53 #include "BKE_library_query.h"
54 #include "BKE_library_remap.h"
55 #include "BKE_main.h"
56 #include "BKE_node.h"
57
58 void BKE_lamp_init(Lamp *la)
59 {
60         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(la, id));
61
62         la->r = la->g = la->b = la->k = 1.0f;
63         la->haint = la->energy = 1.0f;
64         la->dist = 25.0f;
65         la->spotsize = DEG2RADF(45.0f);
66         la->spotblend = 0.15f;
67         la->att2 = 1.0f;
68         la->mode = LA_SHAD_BUF;
69         la->bufsize = 512;
70         la->clipsta = 0.5f;
71         la->clipend = 40.0f;
72         la->bleedexp = 2.5f;
73         la->samp = 3;
74         la->bias = 1.0f;
75         la->soft = 3.0f;
76         la->compressthresh = 0.05f;
77         la->ray_samp = la->ray_sampy = la->ray_sampz = 1;
78         la->area_size = la->area_sizey = la->area_sizez = 0.1f;
79         la->buffers = 1;
80         la->buftype = LA_SHADBUF_HALFWAY;
81         la->ray_samp_method = LA_SAMP_HALTON;
82         la->adapt_thresh = 0.001f;
83         la->preview = NULL;
84         la->falloff_type = LA_FALLOFF_INVSQUARE;
85         la->coeff_const = 1.0f;
86         la->coeff_lin = 0.0f;
87         la->coeff_quad = 0.0f;
88         la->curfalloff = curvemapping_add(1, 0.0f, 1.0f, 1.0f, 0.0f);
89         la->sun_effect_type = 0;
90         la->horizon_brightness = 1.0;
91         la->spread = 1.0;
92         la->sun_brightness = 1.0;
93         la->sun_size = 1.0;
94         la->backscattered_light = 1.0f;
95         la->atm_turbidity = 2.0f;
96         la->atm_inscattering_factor = 1.0f;
97         la->atm_extinction_factor = 1.0f;
98         la->atm_distance_factor = 1.0f;
99         la->sun_intensity = 1.0f;
100         la->skyblendtype = MA_RAMP_ADD;
101         la->skyblendfac = 1.0f;
102         la->sky_colorspace = BLI_XYZ_CIE;
103         la->sky_exposure = 1.0f;
104         la->shadow_frustum_size = 10.0f;
105         la->cascade_max_dist = 1000.0f;
106         la->cascade_count = 4;
107         la->cascade_exponent = 0.8f;
108         la->cascade_fade = 0.1f;
109         
110         curvemapping_initialize(la->curfalloff);
111 }
112
113 Lamp *BKE_lamp_add(Main *bmain, const char *name)
114 {
115         Lamp *la;
116
117         la =  BKE_libblock_alloc(bmain, ID_LA, name, 0);
118
119         BKE_lamp_init(la);
120
121         return la;
122 }
123
124 /**
125  * Only copy internal data of Lamp ID from source to already allocated/initialized destination.
126  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
127  *
128  * WARNING! This function will not handle ID user count!
129  *
130  * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
131  */
132 void BKE_lamp_copy_data(Main *bmain, Lamp *la_dst, const Lamp *la_src, const int flag)
133 {
134         for (int a = 0; a < MAX_MTEX; a++) {
135                 if (la_dst->mtex[a]) {
136                         la_dst->mtex[a] = MEM_mallocN(sizeof(*la_dst->mtex[a]), __func__);
137                         *la_dst->mtex[a] = *la_src->mtex[a];
138                 }
139         }
140
141         la_dst->curfalloff = curvemapping_copy(la_src->curfalloff);
142
143         if (la_src->nodetree) {
144                 BKE_id_copy_ex(bmain, (ID *)la_src->nodetree, (ID **)&la_dst->nodetree, flag, false);
145         }
146
147         if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
148                 BKE_previewimg_id_copy(&la_dst->id, &la_src->id);
149         }
150         else {
151                 la_dst->preview = NULL;
152         }
153 }
154
155 Lamp *BKE_lamp_copy(Main *bmain, const Lamp *la)
156 {
157         Lamp *la_copy;
158         BKE_id_copy_ex(bmain, &la->id, (ID **)&la_copy, 0, false);
159         return la_copy;
160 }
161
162 Lamp *localize_lamp(Lamp *la)
163 {
164         /* TODO replace with something like
165          *      Lamp *la_copy;
166          *      BKE_id_copy_ex(bmain, &la->id, (ID **)&la_copy, LIB_ID_COPY_NO_MAIN | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_USER_REFCOUNT, false);
167          *      return la_copy;
168          *
169          * ... Once f*** nodes are fully converted to that too :( */
170
171         Lamp *lan;
172         int a;
173         
174         lan = BKE_libblock_copy_nolib(&la->id, false);
175
176         for (a = 0; a < MAX_MTEX; a++) {
177                 if (lan->mtex[a]) {
178                         lan->mtex[a] = MEM_mallocN(sizeof(MTex), "localize_lamp");
179                         memcpy(lan->mtex[a], la->mtex[a], sizeof(MTex));
180                 }
181         }
182         
183         lan->curfalloff = curvemapping_copy(la->curfalloff);
184
185         if (la->nodetree)
186                 lan->nodetree = ntreeLocalize(la->nodetree);
187         
188         lan->preview = NULL;
189
190         return lan;
191 }
192
193 void BKE_lamp_make_local(Main *bmain, Lamp *la, const bool lib_local)
194 {
195         BKE_id_make_local_generic(bmain, &la->id, true, lib_local);
196 }
197
198 void BKE_lamp_free(Lamp *la)
199 {
200         int a;
201
202         for (a = 0; a < MAX_MTEX; a++) {
203                 MEM_SAFE_FREE(la->mtex[a]);
204         }
205         
206         BKE_animdata_free((ID *)la, false);
207
208         curvemapping_free(la->curfalloff);
209
210         /* is no lib link block, but lamp extension */
211         if (la->nodetree) {
212                 ntreeFreeTree(la->nodetree);
213                 MEM_freeN(la->nodetree);
214                 la->nodetree = NULL;
215         }
216         
217         BKE_previewimg_free(&la->preview);
218         BKE_icon_id_delete(&la->id);
219         la->id.icon_id = 0;
220 }
221
222 /* Calculate all drivers for lamps, see material_drivers_update for why this is a bad hack */
223
224 static void lamp_node_drivers_update(Scene *scene, bNodeTree *ntree, float ctime)
225 {
226         bNode *node;
227
228         /* nodetree itself */
229         if (ntree->adt && ntree->adt->drivers.first)
230                 BKE_animsys_evaluate_animdata(scene, &ntree->id, ntree->adt, ctime, ADT_RECALC_DRIVERS);
231         
232         /* nodes */
233         for (node = ntree->nodes.first; node; node = node->next)
234                 if (node->id && node->type == NODE_GROUP)
235                         lamp_node_drivers_update(scene, (bNodeTree *)node->id, ctime);
236 }
237
238 void lamp_drivers_update(Scene *scene, Lamp *la, float ctime)
239 {
240         /* Prevent infinite recursion by checking (and tagging the lamp) as having been visited already
241          * (see BKE_scene_update_tagged()). This assumes la->id.tag & LIB_TAG_DOIT isn't set by anything else
242          * in the meantime... [#32017] */
243         if (la->id.tag & LIB_TAG_DOIT)
244                 return;
245
246         la->id.tag |= LIB_TAG_DOIT;
247         
248         /* lamp itself */
249         if (la->adt && la->adt->drivers.first)
250                 BKE_animsys_evaluate_animdata(scene, &la->id, la->adt, ctime, ADT_RECALC_DRIVERS);
251         
252         /* nodes */
253         if (la->nodetree)
254                 lamp_node_drivers_update(scene, la->nodetree, ctime);
255
256         la->id.tag &= ~LIB_TAG_DOIT;
257 }
258