Cleanup: remove redundant, invalid info from headers
[blender.git] / source / blender / blenkernel / intern / world.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 blender/blenkernel/intern/world.c
21  *  \ingroup bke
22  */
23
24
25 #include <string.h>
26 #include <stdlib.h>
27 #include <math.h>
28 #include "MEM_guardedalloc.h"
29
30 #include "DNA_world_types.h"
31 #include "DNA_scene_types.h"
32 #include "DNA_texture_types.h"
33
34 #include "BLI_utildefines.h"
35 #include "BLI_listbase.h"
36
37 #include "BKE_animsys.h"
38 #include "BKE_icons.h"
39 #include "BKE_library.h"
40 #include "BKE_library_query.h"
41 #include "BKE_library_remap.h"
42 #include "BKE_main.h"
43 #include "BKE_node.h"
44 #include "BKE_world.h"
45
46 #include "GPU_material.h"
47
48 /** Free (or release) any data used by this world (does not free the world itself). */
49 void BKE_world_free(World *wrld)
50 {
51         int a;
52
53         BKE_animdata_free((ID *)wrld, false);
54
55         for (a = 0; a < MAX_MTEX; a++) {
56                 MEM_SAFE_FREE(wrld->mtex[a]);
57         }
58
59         /* is no lib link block, but world extension */
60         if (wrld->nodetree) {
61                 ntreeFreeTree(wrld->nodetree);
62                 MEM_freeN(wrld->nodetree);
63                 wrld->nodetree = NULL;
64         }
65
66         GPU_material_free(&wrld->gpumaterial);
67
68         BKE_icon_id_delete((struct ID *)wrld);
69         BKE_previewimg_free(&wrld->preview);
70 }
71
72 void BKE_world_init(World *wrld)
73 {
74         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(wrld, id));
75
76         wrld->horr = 0.05f;
77         wrld->horg = 0.05f;
78         wrld->horb = 0.05f;
79         wrld->zenr = 0.01f;
80         wrld->zeng = 0.01f;
81         wrld->zenb = 0.01f;
82         wrld->skytype = 0;
83
84         wrld->exp = 0.0f;
85         wrld->exposure = wrld->range = 1.0f;
86
87         wrld->aodist = 10.0f;
88         wrld->aosamp = 5;
89         wrld->aoenergy = 1.0f;
90         wrld->ao_env_energy = 1.0f;
91         wrld->ao_indirect_energy = 1.0f;
92         wrld->ao_indirect_bounces = 1;
93         wrld->aobias = 0.05f;
94         wrld->ao_samp_method = WO_AOSAMP_HAMMERSLEY;
95         wrld->ao_approx_error = 0.25f;
96
97         wrld->preview = NULL;
98         wrld->miststa = 5.0f;
99         wrld->mistdist = 25.0f;
100 }
101
102 World *BKE_world_add(Main *bmain, const char *name)
103 {
104         World *wrld;
105
106         wrld = BKE_libblock_alloc(bmain, ID_WO, name, 0);
107
108         BKE_world_init(wrld);
109
110         return wrld;
111 }
112
113 /**
114  * Only copy internal data of World ID from source to already allocated/initialized destination.
115  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
116  *
117  * WARNING! This function will not handle ID user count!
118  *
119  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
120  */
121 void BKE_world_copy_data(Main *bmain, World *wrld_dst, const World *wrld_src, const int flag)
122 {
123         for (int a = 0; a < MAX_MTEX; a++) {
124                 if (wrld_src->mtex[a]) {
125                         wrld_dst->mtex[a] = MEM_dupallocN(wrld_src->mtex[a]);
126                 }
127         }
128
129         if (wrld_src->nodetree) {
130                 /* Note: nodetree is *not* in bmain, however this specific case is handled at lower level
131                  *       (see BKE_libblock_copy_ex()). */
132                 BKE_id_copy_ex(bmain, (ID *)wrld_src->nodetree, (ID **)&wrld_dst->nodetree, flag, false);
133         }
134
135         BLI_listbase_clear(&wrld_dst->gpumaterial);
136
137         if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
138                 BKE_previewimg_id_copy(&wrld_dst->id, &wrld_src->id);
139         }
140         else {
141                 wrld_dst->preview = NULL;
142         }
143 }
144
145 World *BKE_world_copy(Main *bmain, const World *wrld)
146 {
147         World *wrld_copy;
148         BKE_id_copy_ex(bmain, &wrld->id, (ID **)&wrld_copy, 0, false);
149         return wrld_copy;
150 }
151
152 World *BKE_world_localize(World *wrld)
153 {
154         /* TODO(bastien): Replace with something like:
155          *
156          *   World *wrld_copy;
157          *   BKE_id_copy_ex(bmain, &wrld->id, (ID **)&wrld_copy,
158          *                  LIB_ID_COPY_NO_MAIN | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_USER_REFCOUNT,
159          *                  false);
160          *   return wrld_copy;
161          *
162          * NOTE: Only possible once nested node trees are fully converted to that too. */
163
164         World *wrldn;
165         int a;
166
167         wrldn = BKE_libblock_copy_nolib(&wrld->id, false);
168
169         for (a = 0; a < MAX_MTEX; a++) {
170                 if (wrld->mtex[a]) {
171                         wrldn->mtex[a] = MEM_mallocN(sizeof(MTex), __func__);
172                         memcpy(wrldn->mtex[a], wrld->mtex[a], sizeof(MTex));
173                 }
174         }
175
176         if (wrld->nodetree)
177                 wrldn->nodetree = ntreeLocalize(wrld->nodetree);
178
179         wrldn->preview = NULL;
180
181         BLI_listbase_clear(&wrldn->gpumaterial);
182
183         return wrldn;
184 }
185
186 void BKE_world_make_local(Main *bmain, World *wrld, const bool lib_local)
187 {
188         BKE_id_make_local_generic(bmain, &wrld->id, true, lib_local);
189 }