Cleanup: style, use braces for blenkernel
[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 #include <string.h>
25 #include <stdlib.h>
26 #include <math.h>
27
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_main.h"
41 #include "BKE_node.h"
42 #include "BKE_world.h"
43
44 #include "DRW_engine.h"
45
46 #include "DEG_depsgraph.h"
47
48 #include "GPU_material.h"
49
50 /** Free (or release) any data used by this world (does not free the world itself). */
51 void BKE_world_free(World *wrld)
52 {
53   BKE_animdata_free((ID *)wrld, false);
54
55   DRW_drawdata_free((ID *)wrld);
56
57   /* is no lib link block, but world extension */
58   if (wrld->nodetree) {
59     ntreeFreeNestedTree(wrld->nodetree);
60     MEM_freeN(wrld->nodetree);
61     wrld->nodetree = NULL;
62   }
63
64   GPU_material_free(&wrld->gpumaterial);
65
66   BKE_icon_id_delete((struct ID *)wrld);
67   BKE_previewimg_free(&wrld->preview);
68 }
69
70 void BKE_world_init(World *wrld)
71 {
72   BLI_assert(MEMCMP_STRUCT_AFTER_IS_ZERO(wrld, id));
73
74   wrld->horr = 0.05f;
75   wrld->horg = 0.05f;
76   wrld->horb = 0.05f;
77
78   wrld->aodist = 10.0f;
79   wrld->aoenergy = 1.0f;
80
81   wrld->preview = NULL;
82   wrld->miststa = 5.0f;
83   wrld->mistdist = 25.0f;
84 }
85
86 World *BKE_world_add(Main *bmain, const char *name)
87 {
88   World *wrld;
89
90   wrld = BKE_libblock_alloc(bmain, ID_WO, name, 0);
91
92   BKE_world_init(wrld);
93
94   return wrld;
95 }
96
97 /**
98  * Only copy internal data of World 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_world_copy_data(Main *bmain, World *wrld_dst, const World *wrld_src, const int flag)
106 {
107   if (wrld_src->nodetree) {
108     /* Note: nodetree is *not* in bmain, however this specific case is handled at lower level
109      *       (see BKE_libblock_copy_ex()). */
110     BKE_id_copy_ex(bmain, (ID *)wrld_src->nodetree, (ID **)&wrld_dst->nodetree, flag);
111   }
112
113   BLI_listbase_clear(&wrld_dst->gpumaterial);
114   BLI_listbase_clear((ListBase *)&wrld_dst->drawdata);
115
116   if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
117     BKE_previewimg_id_copy(&wrld_dst->id, &wrld_src->id);
118   }
119   else {
120     wrld_dst->preview = NULL;
121   }
122 }
123
124 World *BKE_world_copy(Main *bmain, const World *wrld)
125 {
126   World *wrld_copy;
127   BKE_id_copy(bmain, &wrld->id, (ID **)&wrld_copy);
128   return wrld_copy;
129 }
130
131 World *BKE_world_localize(World *wrld)
132 {
133   /* TODO(bastien): Replace with something like:
134    *
135    *   World *wrld_copy;
136    *   BKE_id_copy_ex(bmain, &wrld->id, (ID **)&wrld_copy,
137    *                  LIB_ID_COPY_NO_MAIN | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_USER_REFCOUNT,
138    *                  false);
139    *   return wrld_copy;
140    *
141    * NOTE: Only possible once nested node trees are fully converted to that too. */
142
143   World *wrldn;
144
145   wrldn = BKE_libblock_copy_for_localize(&wrld->id);
146
147   if (wrld->nodetree) {
148     wrldn->nodetree = ntreeLocalize(wrld->nodetree);
149   }
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 }