Merging r50113 through r50118 from trunk into soc-2011-tomato
[blender.git] / intern / cycles / blender / blender_util.h
1 /*
2  * Copyright 2011, Blender Foundation.
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
19 #ifndef __BLENDER_UTIL_H__
20 #define __BLENDER_UTIL_H__
21
22 #include "util_map.h"
23 #include "util_path.h"
24 #include "util_set.h"
25 #include "util_transform.h"
26 #include "util_types.h"
27 #include "util_vector.h"
28
29 /* Hacks to hook into Blender API
30  * todo: clean this up ... */
31
32 extern "C" {
33
34 struct RenderEngine;
35 struct RenderResult;
36
37 ID *rna_Object_to_mesh(void *_self, void *reports, void *scene, int apply_modifiers, int settings);
38 void rna_Main_meshes_remove(void *bmain, void *reports, void *mesh);
39 void rna_Object_create_duplilist(void *ob, void *reports, void *sce);
40 void rna_Object_free_duplilist(void *ob, void *reports);
41 void rna_RenderLayer_rect_set(PointerRNA *ptr, const float *values);
42 void rna_RenderPass_rect_set(PointerRNA *ptr, const float *values);
43 struct RenderResult *RE_engine_begin_result(struct RenderEngine *engine, int x, int y, int w, int h, const char *layername);
44 void RE_engine_update_result(struct RenderEngine *engine, struct RenderResult *result);
45 void RE_engine_end_result(struct RenderEngine *engine, struct RenderResult *result, int cancel);
46 int RE_engine_test_break(struct RenderEngine *engine);
47 void RE_engine_update_stats(struct RenderEngine *engine, const char *stats, const char *info);
48 void RE_engine_update_progress(struct RenderEngine *engine, float progress);
49 void engine_tag_redraw(void *engine);
50 void engine_tag_update(void *engine);
51 int rna_Object_is_modified(void *ob, void *scene, int settings);
52 int rna_Object_is_deform_modified(void *ob, void *scene, int settings);
53 void BLI_timestr(double _time, char *str);
54 void rna_ColorRamp_eval(void *coba, float position, float color[4]);
55 void rna_Scene_frame_set(void *scene, int frame, float subframe);
56 void BKE_image_user_frame_calc(void *iuser, int cfra, int fieldnr);
57 void BKE_image_user_file_path(void *iuser, void *ima, char *path);
58 }
59
60 CCL_NAMESPACE_BEGIN
61
62 static inline BL::Mesh object_to_mesh(BL::Object self, BL::Scene scene, bool apply_modifiers, bool render)
63 {
64         ID *data = rna_Object_to_mesh(self.ptr.data, NULL, scene.ptr.data, apply_modifiers, (render)? 2: 1);
65         PointerRNA ptr;
66         RNA_id_pointer_create(data, &ptr);
67         return BL::Mesh(ptr);
68 }
69
70 static inline void colorramp_to_array(BL::ColorRamp ramp, float4 *data, int size)
71 {
72         for(int i = 0; i < size; i++) {
73                 float color[4];
74
75                 rna_ColorRamp_eval(ramp.ptr.data, i/(float)(size-1), color);
76                 data[i] = make_float4(color[0], color[1], color[2], color[3]);
77         }
78 }
79
80 static inline void object_remove_mesh(BL::BlendData data, BL::Mesh mesh)
81 {
82         rna_Main_meshes_remove(data.ptr.data, NULL, mesh.ptr.data);
83 }
84
85 static inline void object_create_duplilist(BL::Object self, BL::Scene scene)
86 {
87         rna_Object_create_duplilist(self.ptr.data, NULL, scene.ptr.data);
88 }
89
90 static inline void object_free_duplilist(BL::Object self)
91 {
92         rna_Object_free_duplilist(self.ptr.data, NULL);
93 }
94
95 static inline bool BKE_object_is_modified(BL::Object self, BL::Scene scene, bool preview)
96 {
97         return rna_Object_is_modified(self.ptr.data, scene.ptr.data, (preview)? (1<<0): (1<<1))? true: false;
98 }
99
100 static inline bool BKE_object_is_deform_modified(BL::Object self, BL::Scene scene, bool preview)
101 {
102         return rna_Object_is_deform_modified(self.ptr.data, scene.ptr.data, (preview)? (1<<0): (1<<1))? true: false;
103 }
104
105 static inline string image_user_file_path(BL::ImageUser iuser, BL::Image ima, int cfra)
106 {
107         char filepath[1024];
108         BKE_image_user_frame_calc(iuser.ptr.data, cfra, 0);
109         BKE_image_user_file_path(iuser.ptr.data, ima.ptr.data, filepath);
110         return string(filepath);
111 }
112
113 static inline void scene_frame_set(BL::Scene scene, int frame)
114 {
115         rna_Scene_frame_set(scene.ptr.data, frame, 0.0f);
116 }
117
118 /* Utilities */
119
120 static inline Transform get_transform(BL::Array<float, 16> array)
121 {
122         Transform tfm;
123
124         /* we assume both types to be just 16 floats, and transpose because blender
125          * use column major matrix order while we use row major */
126         memcpy(&tfm, &array, sizeof(float)*16);
127         tfm = transform_transpose(tfm);
128
129         return tfm;
130 }
131
132 static inline float2 get_float2(BL::Array<float, 2> array)
133 {
134         return make_float2(array[0], array[1]);
135 }
136
137 static inline float3 get_float3(BL::Array<float, 2> array)
138 {
139         return make_float3(array[0], array[1], 0.0f);
140 }
141
142 static inline float3 get_float3(BL::Array<float, 3> array)
143 {
144         return make_float3(array[0], array[1], array[2]);
145 }
146
147 static inline float3 get_float3(BL::Array<float, 4> array)
148 {
149         return make_float3(array[0], array[1], array[2]);
150 }
151
152 static inline int4 get_int4(BL::Array<int, 4> array)
153 {
154         return make_int4(array[0], array[1], array[2], array[3]);
155 }
156
157 static inline uint get_layer(BL::Array<int, 20> array)
158 {
159         uint layer = 0;
160
161         for(uint i = 0; i < 20; i++)
162                 if(array[i])
163                         layer |= (1 << i);
164         
165         return layer;
166 }
167
168 static inline uint get_layer(BL::Array<int, 20> array, BL::Array<int, 8> local_array, bool is_light = false)
169 {
170         uint layer = 0;
171
172         for(uint i = 0; i < 20; i++)
173                 if(array[i])
174                         layer |= (1 << i);
175
176         if(is_light) {
177                 /* consider lamps on all local view layers */
178                 for(uint i = 0; i < 8; i++)
179                         layer |= (1 << (20+i));
180         }
181         else {
182                 for(uint i = 0; i < 8; i++)
183                         if(local_array[i])
184                                 layer |= (1 << (20+i));
185         }
186         
187         return layer;
188 }
189
190 #if 0
191 static inline float3 get_float3(PointerRNA& ptr, const char *name)
192 {
193         float3 f;
194         RNA_float_get_array(&ptr, name, &f.x);
195         return f;
196 }
197 #endif
198
199 static inline bool get_boolean(PointerRNA& ptr, const char *name)
200 {
201         return RNA_boolean_get(&ptr, name)? true: false;
202 }
203
204 static inline float get_float(PointerRNA& ptr, const char *name)
205 {
206         return RNA_float_get(&ptr, name);
207 }
208
209 static inline int get_int(PointerRNA& ptr, const char *name)
210 {
211         return RNA_int_get(&ptr, name);
212 }
213
214 static inline int get_enum(PointerRNA& ptr, const char *name)
215 {
216         return RNA_enum_get(&ptr, name);
217 }
218
219 static inline string get_enum_identifier(PointerRNA& ptr, const char *name)
220 {
221         PropertyRNA *prop = RNA_struct_find_property(&ptr, name);
222         const char *identifier = "";
223         int value = RNA_property_enum_get(&ptr, prop);
224
225         RNA_property_enum_identifier(NULL, &ptr, prop, value, &identifier);
226
227         return string(identifier);
228 }
229
230 /* Relative Paths */
231
232 static inline string blender_absolute_path(BL::BlendData b_data, BL::ID b_id, const string& path)
233 {
234         if(path.size() >= 2 && path[0] == '/' && path[1] == '/') {
235                 string dirname;
236                 
237                 if(b_id.library())
238                         dirname = blender_absolute_path(b_data, b_id.library(), b_id.library().filepath());
239                 else
240                         dirname = b_data.filepath();
241
242                 return path_join(path_dirname(dirname), path.substr(2));
243         }
244
245         return path;
246 }
247
248 /* ID Map
249  *
250  * Utility class to keep in sync with blender data.
251  * Used for objects, meshes, lights and shaders. */
252
253 template<typename K, typename T>
254 class id_map {
255 public:
256         id_map(vector<T*> *scene_data_)
257         {
258                 scene_data = scene_data_;
259         }
260
261         T *find(BL::ID id)
262         {
263                 return find(id.ptr.id.data);
264         }
265
266         T *find(const K& key)
267         {
268                 if(b_map.find(key) != b_map.end()) {
269                         T *data = b_map[key];
270                         return data;
271                 }
272
273                 return NULL;
274         }
275
276         void set_recalc(BL::ID id)
277         {
278                 b_recalc.insert(id.ptr.data);
279         }
280
281         bool has_recalc()
282         {
283                 return !(b_recalc.empty());
284         }
285
286         void pre_sync()
287         {
288                 used_set.clear();
289         }
290
291         bool sync(T **r_data, BL::ID id)
292         {
293                 return sync(r_data, id, id, id.ptr.id.data);
294         }
295
296         bool sync(T **r_data, BL::ID id, BL::ID parent, const K& key)
297         {
298                 T *data = find(key);
299                 bool recalc;
300
301                 if(!data) {
302                         /* add data if it didn't exist yet */
303                         data = new T();
304                         scene_data->push_back(data);
305                         b_map[key] = data;
306                         recalc = true;
307                 }
308                 else {
309                         recalc = (b_recalc.find(id.ptr.data) != b_recalc.end());
310                         if(parent.ptr.data)
311                                 recalc = recalc || (b_recalc.find(parent.ptr.data) != b_recalc.end());
312                 }
313
314                 used(data);
315
316                 *r_data = data;
317                 return recalc;
318         }
319
320         void used(T *data)
321         {
322                 /* tag data as still in use */
323                 used_set.insert(data);
324         }
325
326         void set_default(T *data)
327         {
328                 b_map[NULL] = data;
329         }
330
331         bool post_sync(bool do_delete = true)
332         {
333                 /* remove unused data */
334                 vector<T*> new_scene_data;
335                 typename vector<T*>::iterator it;
336                 bool deleted = false;
337
338                 for(it = scene_data->begin(); it != scene_data->end(); it++) {
339                         T *data = *it;
340
341                         if(do_delete && used_set.find(data) == used_set.end()) {
342                                 delete data;
343                                 deleted = true;
344                         }
345                         else
346                                 new_scene_data.push_back(data);
347                 }
348
349                 *scene_data = new_scene_data;
350
351                 /* update mapping */
352                 map<K, T*> new_map;
353                 typedef pair<const K, T*> TMapPair;
354                 typename map<K, T*>::iterator jt;
355
356                 for(jt = b_map.begin(); jt != b_map.end(); jt++) {
357                         TMapPair& pair = *jt;
358
359                         if(used_set.find(pair.second) != used_set.end())
360                                 new_map[pair.first] = pair.second;
361                 }
362
363                 used_set.clear();
364                 b_recalc.clear();
365                 b_map = new_map;
366
367                 return deleted;
368         }
369
370 protected:
371         vector<T*> *scene_data;
372         map<K, T*> b_map;
373         set<T*> used_set;
374         set<void*> b_recalc;
375 };
376
377 /* Object Key */
378
379 struct ObjectKey {
380         void *parent;
381         int index;
382         void *ob;
383
384         ObjectKey(void *parent_, int index_, void *ob_)
385         : parent(parent_), index(index_), ob(ob_) {}
386
387         bool operator<(const ObjectKey& k) const
388         { return (parent < k.parent || (parent == k.parent && (index < k.index || (index == k.index && ob < k.ob)))); }
389 };
390
391 CCL_NAMESPACE_END
392
393 #endif /* __BLENDER_UTIL_H__ */
394