doxygen: add newline after \file
[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
21  * \ingroup bke
22  */
23
24
25 #include <string.h>
26 #include <stdlib.h>
27 #include <math.h>
28
29 #include "MEM_guardedalloc.h"
30
31 #include "DNA_world_types.h"
32 #include "DNA_scene_types.h"
33 #include "DNA_texture_types.h"
34
35 #include "BLI_utildefines.h"
36 #include "BLI_listbase.h"
37
38 #include "BKE_animsys.h"
39 #include "BKE_icons.h"
40 #include "BKE_library.h"
41 #include "BKE_main.h"
42 #include "BKE_node.h"
43 #include "BKE_world.h"
44
45 #include "DRW_engine.h"
46
47 #include "DEG_depsgraph.h"
48
49 #include "GPU_material.h"
50
51 /** Free (or release) any data used by this world (does not free the world itself). */
52 void BKE_world_free(World *wrld)
53 {
54         BKE_animdata_free((ID *)wrld, false);
55
56         DRW_drawdata_free((ID *)wrld);
57
58         /* is no lib link block, but world extension */
59         if (wrld->nodetree) {
60                 ntreeFreeNestedTree(wrld->nodetree);
61                 MEM_freeN(wrld->nodetree);
62                 wrld->nodetree = NULL;
63         }
64
65         GPU_material_free(&wrld->gpumaterial);
66
67         BKE_icon_id_delete((struct ID *)wrld);
68         BKE_previewimg_free(&wrld->preview);
69 }
70
71 void BKE_world_init(World *wrld)
72 {
73         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(wrld, id));
74
75         wrld->horr = 0.05f;
76         wrld->horg = 0.05f;
77         wrld->horb = 0.05f;
78
79         wrld->aodist = 10.0f;
80         wrld->aoenergy = 1.0f;
81
82         wrld->preview = NULL;
83         wrld->miststa = 5.0f;
84         wrld->mistdist = 25.0f;
85 }
86
87 World *BKE_world_add(Main *bmain, const char *name)
88 {
89         World *wrld;
90
91         wrld = BKE_libblock_alloc(bmain, ID_WO, name, 0);
92
93         BKE_world_init(wrld);
94
95         return wrld;
96 }
97
98 /**
99  * Only copy internal data of World 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_world_copy_data(Main *bmain, World *wrld_dst, const World *wrld_src, const int flag)
107 {
108         if (wrld_src->nodetree) {
109                 /* Note: nodetree is *not* in bmain, however this specific case is handled at lower level
110                  *       (see BKE_libblock_copy_ex()). */
111                 BKE_id_copy_ex(bmain, (ID *)wrld_src->nodetree, (ID **)&wrld_dst->nodetree, flag);
112         }
113
114         BLI_listbase_clear(&wrld_dst->gpumaterial);
115         BLI_listbase_clear((ListBase *)&wrld_dst->drawdata);
116
117         if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
118                 BKE_previewimg_id_copy(&wrld_dst->id, &wrld_src->id);
119         }
120         else {
121                 wrld_dst->preview = NULL;
122         }
123 }
124
125 World *BKE_world_copy(Main *bmain, const World *wrld)
126 {
127         World *wrld_copy;
128         BKE_id_copy(bmain, &wrld->id, (ID **)&wrld_copy);
129         return wrld_copy;
130 }
131
132 World *BKE_world_localize(World *wrld)
133 {
134         /* TODO(bastien): Replace with something like:
135          *
136          *   World *wrld_copy;
137          *   BKE_id_copy_ex(bmain, &wrld->id, (ID **)&wrld_copy,
138          *                  LIB_ID_COPY_NO_MAIN | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_USER_REFCOUNT,
139          *                  false);
140          *   return wrld_copy;
141          *
142          * NOTE: Only possible once nested node trees are fully converted to that too. */
143
144         World *wrldn;
145
146         wrldn = BKE_libblock_copy_for_localize(&wrld->id);
147
148         if (wrld->nodetree)
149                 wrldn->nodetree = ntreeLocalize(wrld->nodetree);
150
151         wrldn->preview = NULL;
152
153         BLI_listbase_clear(&wrldn->gpumaterial);
154         BLI_listbase_clear((ListBase *)&wrldn->drawdata);
155
156         wrldn->id.tag |= LIB_TAG_LOCALIZED;
157
158         return wrldn;
159 }
160
161 void BKE_world_make_local(Main *bmain, World *wrld, const bool lib_local)
162 {
163         BKE_id_make_local_generic(bmain, &wrld->id, true, lib_local);
164 }
165
166 void BKE_world_eval(struct Depsgraph *depsgraph, World *world)
167 {
168         DEG_debug_print_eval(depsgraph, __func__, world->id.name, world);
169         GPU_material_free(&world->gpumaterial);
170 }