Merging trunk up to r39145.
[blender-staging.git] / source / blender / collada / EffectExporter.cpp
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Chingiz Dyussenov, Arystanbek Dyussenov, Jan Diederich, Tod Liverseed,
21  *                 Nathan Letwory
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/collada/EffectExporter.cpp
27  *  \ingroup collada
28  */
29
30
31 #include <map>
32
33 #include "COLLADASWEffectProfile.h"
34
35 #include "EffectExporter.h"
36 #include "MaterialExporter.h"
37
38 #include "DNA_mesh_types.h"
39 #include "DNA_texture_types.h"
40
41 #include "BKE_customdata.h"
42
43 #include "collada_internal.h"
44 #include "collada_utils.h"
45
46 // OB_MESH is assumed
47 static std::string getActiveUVLayerName(Object *ob)
48 {
49         Mesh *me = (Mesh*)ob->data;
50
51         int num_layers = CustomData_number_of_layers(&me->fdata, CD_MTFACE);
52         if (num_layers)
53                 return std::string(bc_CustomData_get_active_layer_name(&me->fdata, CD_MTFACE));
54                 
55         return "";
56 }
57
58 EffectsExporter::EffectsExporter(COLLADASW::StreamWriter *sw) : COLLADASW::LibraryEffects(sw){}
59
60 bool EffectsExporter::hasEffects(Scene *sce)
61 {
62         Base *base = (Base *)sce->base.first;
63         
64         while(base) {
65                 Object *ob= base->object;
66                 int a;
67                 for(a = 0; a < ob->totcol; a++)
68                 {
69                         Material *ma = give_current_material(ob, a+1);
70
71                         // no material, but check all of the slots
72                         if (!ma) continue;
73
74                         return true;
75                 }
76                 base= base->next;
77         }
78         return false;
79 }
80
81 void EffectsExporter::exportEffects(Scene *sce, bool export_selected)
82 {
83         if(hasEffects(sce)) {
84                 openLibrary();
85                 MaterialFunctor mf;
86                 mf.forEachMaterialInScene<EffectsExporter>(sce, *this, export_selected);
87
88                 closeLibrary();
89         }
90 }
91
92 void EffectsExporter::writeBlinn(COLLADASW::EffectProfile &ep, Material *ma)
93 {
94         COLLADASW::ColorOrTexture cot;
95         ep.setShaderType(COLLADASW::EffectProfile::BLINN);
96         // shininess
97         ep.setShininess(ma->har, false , "shininess");
98         // specular
99         cot = getcol(ma->specr, ma->specg, ma->specb, 1.0f);
100         ep.setSpecular(cot, false , "specular" );
101 }
102
103 void EffectsExporter::writeLambert(COLLADASW::EffectProfile &ep, Material *ma)
104 {
105         COLLADASW::ColorOrTexture cot;
106         ep.setShaderType(COLLADASW::EffectProfile::LAMBERT);
107 }
108
109 void EffectsExporter::writePhong(COLLADASW::EffectProfile &ep, Material *ma)
110 {
111         COLLADASW::ColorOrTexture cot;
112         ep.setShaderType(COLLADASW::EffectProfile::PHONG);
113         // shininess
114         ep.setShininess(ma->har , false , "shininess" );
115         // specular
116         cot = getcol(ma->specr, ma->specg, ma->specb, 1.0f);
117         ep.setSpecular(cot, false , "specular" );
118 }
119
120 void EffectsExporter::operator()(Material *ma, Object *ob)
121 {
122         // create a list of indices to textures of type TEX_IMAGE
123         std::vector<int> tex_indices;
124         createTextureIndices(ma, tex_indices);
125
126         openEffect(translate_id(id_name(ma)) + "-effect");
127         
128         COLLADASW::EffectProfile ep(mSW);
129         ep.setProfileType(COLLADASW::EffectProfile::COMMON);
130         ep.openProfile();
131         // set shader type - one of three blinn, phong or lambert
132         if(ma->spec>0.0f) {
133                 if (ma->spec_shader == MA_SPEC_BLINN) {
134                         writeBlinn(ep, ma);
135                 }
136                 else {
137                         // \todo figure out handling of all spec+diff shader combos blender has, for now write phong
138                         // for now set phong in case spec shader is not blinn
139                         writePhong(ep, ma);
140                 }
141         } else {
142                 if(ma->diff_shader == MA_DIFF_LAMBERT) {
143                         writeLambert(ep, ma);
144                 }
145                 else {
146                 // \todo figure out handling of all spec+diff shader combos blender has, for now write phong
147                 writePhong(ep, ma);
148                 }
149         }
150         
151         // index of refraction
152         if (ma->mode & MA_RAYTRANSP) {
153                 ep.setIndexOfRefraction(ma->ang, false , "index_of_refraction");
154         }
155         else {
156                 ep.setIndexOfRefraction(1.0f, false , "index_of_refraction");
157         }
158
159         COLLADASW::ColorOrTexture cot;
160
161         // transparency
162         if (ma->mode & MA_TRANSP) {
163                 // Tod: because we are in A_ONE mode transparency is calculated like this:
164                 ep.setTransparency(ma->alpha, false , "transparency");
165                 // cot = getcol(1.0f, 1.0f, 1.0f, 1.0f);
166                 // ep.setTransparent(cot);
167         }
168
169         // emission
170         cot=getcol(ma->emit, ma->emit, ma->emit, 1.0f);
171         ep.setEmission(cot, false , "emission");
172
173         // diffuse multiplied by diffuse intensity
174         cot = getcol(ma->r * ma->ref, ma->g * ma->ref, ma->b * ma->ref, 1.0f);
175         ep.setDiffuse(cot, false , "diffuse");
176
177         // ambient
178         cot = getcol(ma->ambr, ma->ambg, ma->ambb, 1.0f);
179         ep.setAmbient(cot, false , "ambient");
180
181         // reflective, reflectivity
182         if (ma->mode & MA_RAYMIRROR) {
183                 cot = getcol(ma->mirr, ma->mirg, ma->mirb, 1.0f);
184                 ep.setReflective(cot);
185                 ep.setReflectivity(ma->ray_mirror);
186         }
187         // else {
188         //      cot = getcol(ma->specr, ma->specg, ma->specb, 1.0f);
189         //      ep.setReflective(cot);
190         //      ep.setReflectivity(ma->spec);
191         // }
192
193         // specular
194         if (ep.getShaderType() != COLLADASW::EffectProfile::LAMBERT) {
195                 cot = getcol(ma->specr * ma->spec, ma->specg * ma->spec, ma->specb * ma->spec, 1.0f);
196                 ep.setSpecular(cot, false , "specular");
197         }       
198
199         // XXX make this more readable if possible
200
201         // create <sampler> and <surface> for each image
202         COLLADASW::Sampler samplers[MAX_MTEX];
203         //COLLADASW::Surface surfaces[MAX_MTEX];
204         //void *samp_surf[MAX_MTEX][2];
205         void *samp_surf[MAX_MTEX][1];
206         
207         // image to index to samp_surf map
208         // samp_surf[index] stores 2 pointers, sampler and surface
209         std::map<std::string, int> im_samp_map;
210
211         unsigned int a, b;
212         for (a = 0, b = 0; a < tex_indices.size(); a++) {
213                 MTex *t = ma->mtex[tex_indices[a]];
214                 Image *ima = t->tex->ima;
215                 
216                 // Image not set for texture
217                 if(!ima) continue;
218                 
219                 std::string key(id_name(ima));
220                 key = translate_id(key);
221
222                 // create only one <sampler>/<surface> pair for each unique image
223                 if (im_samp_map.find(key) == im_samp_map.end()) {
224                         // //<newparam> <surface> <init_from>
225                         // COLLADASW::Surface surface(COLLADASW::Surface::SURFACE_TYPE_2D,
226                         //                                                 key + COLLADASW::Surface::SURFACE_SID_SUFFIX);
227                         // COLLADASW::SurfaceInitOption sio(COLLADASW::SurfaceInitOption::INIT_FROM);
228                         // sio.setImageReference(key);
229                         // surface.setInitOption(sio);
230
231                         // COLLADASW::NewParamSurface surface(mSW);
232                         // surface->setParamType(COLLADASW::CSW_SURFACE_TYPE_2D);
233                         
234                         //<newparam> <sampler> <source>
235                         COLLADASW::Sampler sampler(COLLADASW::Sampler::SAMPLER_TYPE_2D,
236                                                                            key + COLLADASW::Sampler::SAMPLER_SID_SUFFIX,
237                                                                            key + COLLADASW::Sampler::SURFACE_SID_SUFFIX);
238                         sampler.setImageId(key);
239                         // copy values to arrays since they will live longer
240                         samplers[a] = sampler;
241                         //surfaces[a] = surface;
242                         
243                         // store pointers so they can be used later when we create <texture>s
244                         samp_surf[b][0] = &samplers[a];
245                         //samp_surf[b][1] = &surfaces[a];
246                         
247                         im_samp_map[key] = b;
248                         b++;
249                 }
250         }
251
252         // used as fallback when MTex->uvname is "" (this is pretty common)
253         // it is indeed the correct value to use in that case
254         std::string active_uv(getActiveUVLayerName(ob));
255
256         // write textures
257         // XXX very slow
258         for (a = 0; a < tex_indices.size(); a++) {
259                 MTex *t = ma->mtex[tex_indices[a]];
260                 Image *ima = t->tex->ima;
261                 
262                 // Image not set for texture
263                 if(!ima) continue;
264
265                 // we assume map input is always TEXCO_UV
266
267                 std::string key(id_name(ima));
268                 key = translate_id(key);
269                 int i = im_samp_map[key];
270                 COLLADASW::Sampler *sampler = (COLLADASW::Sampler*)samp_surf[i][0];
271                 //COLLADASW::Surface *surface = (COLLADASW::Surface*)samp_surf[i][1];
272
273                 std::string uvname = strlen(t->uvname) ? t->uvname : active_uv;
274
275                 // color
276                 if (t->mapto & (MAP_COL | MAP_COLSPEC)) {
277                         ep.setDiffuse(createTexture(ima, uvname, sampler), false , "diffuse");
278                 }
279                 // ambient
280                 if (t->mapto & MAP_AMB) {
281                         ep.setAmbient(createTexture(ima, uvname, sampler), false , "ambient");
282                 }
283                 // specular
284                 if (t->mapto & MAP_SPEC) {
285                         ep.setSpecular(createTexture(ima, uvname, sampler), false , "specular");
286                 }
287                 // emission
288                 if (t->mapto & MAP_EMIT) {
289                         ep.setEmission(createTexture(ima, uvname, sampler), false , "emission");
290                 }
291                 // reflective
292                 if (t->mapto & MAP_REF) {
293                         ep.setReflective(createTexture(ima, uvname, sampler));
294                 }
295                 // alpha
296                 if (t->mapto & MAP_ALPHA) {
297                         ep.setTransparent(createTexture(ima, uvname, sampler));
298                 }
299                 // extension:
300                 // Normal map --> Must be stored with <extra> tag as different technique, 
301                 // since COLLADA doesn't support normal maps, even in current COLLADA 1.5.
302                 if (t->mapto & MAP_NORM) {
303                         COLLADASW::Texture texture(key);
304                         texture.setTexcoord(uvname);
305                         texture.setSampler(*sampler);
306                         // technique FCOLLADA, with the <bump> tag, is most likely the best understood,
307                         // most widespread de-facto standard.
308                         texture.setProfileName("FCOLLADA");
309                         texture.setChildElementName("bump");
310                         ep.addExtraTechniqueColorOrTexture(COLLADASW::ColorOrTexture(texture));
311                 }
312         }
313         // performs the actual writing
314         ep.addProfileElements();
315         bool twoSided = false;
316         if (ob->type == OB_MESH && ob->data) {
317                 Mesh *me = (Mesh*)ob->data;
318                 if (me->flag & ME_TWOSIDED)
319                         twoSided = true;
320         }
321         if (twoSided)
322                 ep.addExtraTechniqueParameter("GOOGLEEARTH", "double_sided", 1);
323         ep.addExtraTechniques(mSW);
324
325         ep.closeProfile();
326         if (twoSided)
327                 mSW->appendTextBlock("<extra><technique profile=\"MAX3D\"><double_sided>1</double_sided></technique></extra>");
328         closeEffect();  
329 }
330
331 COLLADASW::ColorOrTexture EffectsExporter::createTexture(Image *ima,
332                                                                                 std::string& uv_layer_name,
333                                                                                 COLLADASW::Sampler *sampler
334                                                                                 /*COLLADASW::Surface *surface*/)
335 {
336         
337         COLLADASW::Texture texture(translate_id(id_name(ima)));
338         texture.setTexcoord(uv_layer_name);
339         //texture.setSurface(*surface);
340         texture.setSampler(*sampler);
341         
342         COLLADASW::ColorOrTexture cot(texture);
343         return cot;
344 }
345
346 COLLADASW::ColorOrTexture EffectsExporter::getcol(float r, float g, float b, float a)
347 {
348         COLLADASW::Color color(r,g,b,a);
349         COLLADASW::ColorOrTexture cot(color);
350         return cot;
351 }
352
353 //returns the array of mtex indices which have image 
354 //need this for exporting textures
355 void EffectsExporter::createTextureIndices(Material *ma, std::vector<int> &indices)
356 {
357         indices.clear();
358
359         for (int a = 0; a < MAX_MTEX; a++) {
360                 if (ma->mtex[a] &&
361                         ma->mtex[a]->tex &&
362                         ma->mtex[a]->tex->type == TEX_IMAGE &&
363                         ma->mtex[a]->texco == TEXCO_UV){
364                         indices.push_back(a);
365                 }
366         }
367 }