doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / intern / lamp.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) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #include <stdlib.h>
25
26 #include "MEM_guardedalloc.h"
27
28 #include "DNA_anim_types.h"
29 #include "DNA_lamp_types.h"
30 #include "DNA_material_types.h"
31 #include "DNA_node_types.h"
32 #include "DNA_object_types.h"
33 #include "DNA_scene_types.h"
34 #include "DNA_texture_types.h"
35
36 #include "BLI_math.h"
37 #include "BLI_utildefines.h"
38
39 #include "BKE_animsys.h"
40 #include "BKE_colortools.h"
41 #include "BKE_icons.h"
42 #include "BKE_lamp.h"
43 #include "BKE_library.h"
44 #include "BKE_main.h"
45 #include "BKE_node.h"
46
47 void BKE_lamp_init(Lamp *la)
48 {
49         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(la, id));
50
51         la->r = la->g = la->b = la->k = 1.0f;
52         la->energy = 10.0f;
53         la->dist = 25.0f;
54         la->spotsize = DEG2RADF(45.0f);
55         la->spotblend = 0.15f;
56         la->att2 = 1.0f;
57         la->mode = LA_SHADOW;
58         la->bufsize = 512;
59         la->clipsta = 0.5f;
60         la->clipend = 40.0f;
61         la->bleedexp = 2.5f;
62         la->samp = 3;
63         la->bias = 1.0f;
64         la->soft = 3.0f;
65         la->area_size = la->area_sizey = la->area_sizez = 0.25f;
66         la->buffers = 1;
67         la->preview = NULL;
68         la->falloff_type = LA_FALLOFF_INVSQUARE;
69         la->coeff_const = 1.0f;
70         la->coeff_lin = 0.0f;
71         la->coeff_quad = 0.0f;
72         la->curfalloff = curvemapping_add(1, 0.0f, 1.0f, 1.0f, 0.0f);
73         la->cascade_max_dist = 200.0f;
74         la->cascade_count = 4;
75         la->cascade_exponent = 0.8f;
76         la->cascade_fade = 0.1f;
77         la->contact_dist = 0.2f;
78         la->contact_bias = 0.03f;
79         la->contact_spread = 0.2f;
80         la->contact_thickness = 0.2f;
81         la->spec_fac = 1.0f;
82         la->att_dist = 40.0f;
83
84         curvemapping_initialize(la->curfalloff);
85 }
86
87 Lamp *BKE_lamp_add(Main *bmain, const char *name)
88 {
89         Lamp *la;
90
91         la =  BKE_libblock_alloc(bmain, ID_LA, name, 0);
92
93         BKE_lamp_init(la);
94
95         return la;
96 }
97
98 /**
99  * Only copy internal data of Lamp ID from source to already allocated/initialized destination.
100  * You probably never want to use that directly, use BKE_id_copy or BKE_id_copy_ex for typical needs.
101  *
102  * WARNING! This function will not handle ID user count!
103  *
104  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
105  */
106 void BKE_lamp_copy_data(Main *bmain, Lamp *la_dst, const Lamp *la_src, const int flag)
107 {
108         la_dst->curfalloff = curvemapping_copy(la_src->curfalloff);
109
110         if (la_src->nodetree) {
111                 /* Note: nodetree is *not* in bmain, however this specific case is handled at lower level
112                  *       (see BKE_libblock_copy_ex()). */
113                 BKE_id_copy_ex(bmain, (ID *)la_src->nodetree, (ID **)&la_dst->nodetree, flag);
114         }
115
116         if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
117                 BKE_previewimg_id_copy(&la_dst->id, &la_src->id);
118         }
119         else {
120                 la_dst->preview = NULL;
121         }
122 }
123
124 Lamp *BKE_lamp_copy(Main *bmain, const Lamp *la)
125 {
126         Lamp *la_copy;
127         BKE_id_copy(bmain, &la->id, (ID **)&la_copy);
128         return la_copy;
129 }
130
131 Lamp *BKE_lamp_localize(Lamp *la)
132 {
133         /* TODO(bastien): Replace with something like:
134          *
135          *   Lamp *la_copy;
136          *   BKE_id_copy_ex(bmain, &la->id, (ID **)&la_copy,
137          *                  LIB_ID_COPY_NO_MAIN | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_USER_REFCOUNT,
138          *                  false);
139          *   return la_copy;
140          *
141          * NOTE: Only possible once nested node trees are fully converted to that too. */
142
143         Lamp *lan = BKE_libblock_copy_for_localize(&la->id);
144
145         lan->curfalloff = curvemapping_copy(la->curfalloff);
146
147         if (la->nodetree)
148                 lan->nodetree = ntreeLocalize(la->nodetree);
149
150         lan->preview = NULL;
151
152         lan->id.tag |= LIB_TAG_LOCALIZED;
153
154         return lan;
155 }
156
157 void BKE_lamp_make_local(Main *bmain, Lamp *la, const bool lib_local)
158 {
159         BKE_id_make_local_generic(bmain, &la->id, true, lib_local);
160 }
161
162 void BKE_lamp_free(Lamp *la)
163 {
164         BKE_animdata_free((ID *)la, false);
165
166         curvemapping_free(la->curfalloff);
167
168         /* is no lib link block, but lamp extension */
169         if (la->nodetree) {
170                 ntreeFreeNestedTree(la->nodetree);
171                 MEM_freeN(la->nodetree);
172                 la->nodetree = NULL;
173         }
174
175         BKE_previewimg_free(&la->preview);
176         BKE_icon_id_delete(&la->id);
177         la->id.icon_id = 0;
178 }