Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / intern / world.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/world.c
29  *  \ingroup bke
30  */
31
32
33 #include <string.h>
34 #include <stdlib.h>
35 #include <math.h>
36
37 #include "MEM_guardedalloc.h"
38
39 #include "DNA_world_types.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_texture_types.h"
42
43 #include "BLI_utildefines.h"
44 #include "BLI_listbase.h"
45
46 #include "BKE_animsys.h"
47 #include "BKE_icons.h"
48 #include "BKE_library.h"
49 #include "BKE_main.h"
50 #include "BKE_node.h"
51 #include "BKE_world.h"
52
53 #include "DRW_engine.h"
54
55 #include "DEG_depsgraph.h"
56
57 #include "GPU_material.h"
58
59 /** Free (or release) any data used by this world (does not free the world itself). */
60 void BKE_world_free(World *wrld)
61 {
62         BKE_animdata_free((ID *)wrld, false);
63
64         DRW_drawdata_free((ID *)wrld);
65
66         /* is no lib link block, but world extension */
67         if (wrld->nodetree) {
68                 ntreeFreeNestedTree(wrld->nodetree);
69                 MEM_freeN(wrld->nodetree);
70                 wrld->nodetree = NULL;
71         }
72
73         GPU_material_free(&wrld->gpumaterial);
74
75         BKE_icon_id_delete((struct ID *)wrld);
76         BKE_previewimg_free(&wrld->preview);
77 }
78
79 void BKE_world_init(World *wrld)
80 {
81         BLI_assert(MEMCMP_STRUCT_OFS_IS_ZERO(wrld, id));
82
83         wrld->horr = 0.05f;
84         wrld->horg = 0.05f;
85         wrld->horb = 0.05f;
86
87         wrld->aodist = 10.0f;
88         wrld->aoenergy = 1.0f;
89
90         wrld->preview = NULL;
91         wrld->miststa = 5.0f;
92         wrld->mistdist = 25.0f;
93 }
94
95 World *BKE_world_add(Main *bmain, const char *name)
96 {
97         World *wrld;
98
99         wrld = BKE_libblock_alloc(bmain, ID_WO, name, 0);
100
101         BKE_world_init(wrld);
102
103         return wrld;
104 }
105
106 /**
107  * Only copy internal data of World ID from source to already allocated/initialized destination.
108  * You probably nerver want to use that directly, use id_copy or BKE_id_copy_ex for typical needs.
109  *
110  * WARNING! This function will not handle ID user count!
111  *
112  * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
113  */
114 void BKE_world_copy_data(Main *bmain, World *wrld_dst, const World *wrld_src, const int flag)
115 {
116         if (wrld_src->nodetree) {
117                 /* Note: nodetree is *not* in bmain, however this specific case is handled at lower level
118                  *       (see BKE_libblock_copy_ex()). */
119                 BKE_id_copy_ex(bmain, (ID *)wrld_src->nodetree, (ID **)&wrld_dst->nodetree, flag, false);
120         }
121
122         BLI_listbase_clear(&wrld_dst->gpumaterial);
123         BLI_listbase_clear((ListBase *)&wrld_dst->drawdata);
124
125         if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0) {
126                 BKE_previewimg_id_copy(&wrld_dst->id, &wrld_src->id);
127         }
128         else {
129                 wrld_dst->preview = NULL;
130         }
131 }
132
133 World *BKE_world_copy(Main *bmain, const World *wrld)
134 {
135         World *wrld_copy;
136         BKE_id_copy_ex(bmain, &wrld->id, (ID **)&wrld_copy, 0, false);
137         return wrld_copy;
138 }
139
140 World *BKE_world_localize(World *wrld)
141 {
142         /* TODO(bastien): Replace with something like:
143          *
144          *   World *wrld_copy;
145          *   BKE_id_copy_ex(bmain, &wrld->id, (ID **)&wrld_copy,
146          *                  LIB_ID_COPY_NO_MAIN | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_USER_REFCOUNT,
147          *                  false);
148          *   return wrld_copy;
149          *
150          * NOTE: Only possible once nested node trees are fully converted to that too. */
151
152         World *wrldn;
153
154         wrldn = BKE_libblock_copy_for_localize(&wrld->id);
155
156         if (wrld->nodetree)
157                 wrldn->nodetree = ntreeLocalize(wrld->nodetree);
158
159         wrldn->preview = NULL;
160
161         BLI_listbase_clear(&wrldn->gpumaterial);
162         BLI_listbase_clear((ListBase *)&wrldn->drawdata);
163
164         wrldn->id.tag |= LIB_TAG_LOCALIZED;
165
166         return wrldn;
167 }
168
169 void BKE_world_make_local(Main *bmain, World *wrld, const bool lib_local)
170 {
171         BKE_id_make_local_generic(bmain, &wrld->id, true, lib_local);
172 }
173
174 void BKE_world_eval(struct Depsgraph *depsgraph, World *world)
175 {
176         DEG_debug_print_eval(depsgraph, __func__, world->id.name, world);
177         GPU_material_free(&world->gpumaterial);
178 }