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