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