Merge branch 'master' into blender2.8
[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         la->contact_dist = 1.0f;
110         la->contact_bias = 0.03f;
111         la->contact_spread = 0.2f;
112         la->contact_thickness = 0.5f;
113         
114         curvemapping_initialize(la->curfalloff);
115 }
116
117 Lamp *BKE_lamp_add(Main *bmain, const char *name)
118 {
119         Lamp *la;
120
121         la =  BKE_libblock_alloc(bmain, ID_LA, name, 0);
122
123         BKE_lamp_init(la);
124
125         return la;
126 }
127
128 /**
129  * Only copy internal data of Lamp ID from source to already allocated/initialized destination.
130  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
131  *
132  * WARNING! This function will not handle ID user count!
133  *
134  * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
135  */
136 void BKE_lamp_copy_data(Main *bmain, Lamp *la_dst, const Lamp *la_src, const int flag)
137 {
138         for (int a = 0; a < MAX_MTEX; a++) {
139                 if (la_dst->mtex[a]) {
140                         la_dst->mtex[a] = MEM_mallocN(sizeof(*la_dst->mtex[a]), __func__);
141                         *la_dst->mtex[a] = *la_src->mtex[a];
142                 }
143         }
144
145         la_dst->curfalloff = curvemapping_copy(la_src->curfalloff);
146
147         if (la_src->nodetree) {
148                 /* Note: nodetree is *not* in bmain, however this specific case is handled at lower level
149                  *       (see BKE_libblock_copy_ex()). */
150                 BKE_id_copy_ex(bmain, (ID *)la_src->nodetree, (ID **)&la_dst->nodetree, flag, false);
151         }
152
153         if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
154                 BKE_previewimg_id_copy(&la_dst->id, &la_src->id);
155         }
156         else {
157                 la_dst->preview = NULL;
158         }
159 }
160
161 Lamp *BKE_lamp_copy(Main *bmain, const Lamp *la)
162 {
163         Lamp *la_copy;
164         BKE_id_copy_ex(bmain, &la->id, (ID **)&la_copy, 0, false);
165         return la_copy;
166 }
167
168 Lamp *BKE_lamp_localize(Lamp *la)
169 {
170         /* TODO replace with something like
171          *      Lamp *la_copy;
172          *      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);
173          *      return la_copy;
174          *
175          * ... Once f*** nodes are fully converted to that too :( */
176
177         Lamp *lan;
178         int a;
179         
180         lan = BKE_libblock_copy_nolib(&la->id, false);
181
182         for (a = 0; a < MAX_MTEX; a++) {
183                 if (lan->mtex[a]) {
184                         lan->mtex[a] = MEM_mallocN(sizeof(MTex), __func__);
185                         memcpy(lan->mtex[a], la->mtex[a], sizeof(MTex));
186                 }
187         }
188         
189         lan->curfalloff = curvemapping_copy(la->curfalloff);
190
191         if (la->nodetree)
192                 lan->nodetree = ntreeLocalize(la->nodetree);
193         
194         lan->preview = NULL;
195
196         return lan;
197 }
198
199 void BKE_lamp_make_local(Main *bmain, Lamp *la, const bool lib_local)
200 {
201         BKE_id_make_local_generic(bmain, &la->id, true, lib_local);
202 }
203
204 void BKE_lamp_free(Lamp *la)
205 {
206         int a;
207
208         for (a = 0; a < MAX_MTEX; a++) {
209                 MEM_SAFE_FREE(la->mtex[a]);
210         }
211         
212         BKE_animdata_free((ID *)la, false);
213
214         curvemapping_free(la->curfalloff);
215
216         /* is no lib link block, but lamp extension */
217         if (la->nodetree) {
218                 ntreeFreeTree(la->nodetree);
219                 MEM_freeN(la->nodetree);
220                 la->nodetree = NULL;
221         }
222         
223         BKE_previewimg_free(&la->preview);
224         BKE_icon_id_delete(&la->id);
225         la->id.icon_id = 0;
226 }