style cleanup: follow style guide for formatting of if/for/while loops, and else...
[blender.git] / source / blender / collada / EffectExporter.cpp
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  * Contributor(s): Chingiz Dyussenov, Arystanbek Dyussenov, Jan Diederich, Tod Liverseed,
19  *                 Nathan Letwory
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file blender/collada/EffectExporter.cpp
25  *  \ingroup collada
26  */
27
28
29 #include <map>
30
31 #include "COLLADASWEffectProfile.h"
32
33 #include "EffectExporter.h"
34 #include "MaterialExporter.h"
35
36 #include "DNA_mesh_types.h"
37 #include "DNA_texture_types.h"
38 #include "DNA_world_types.h"
39
40 #include "BKE_customdata.h"
41
42 #include "collada_internal.h"
43 #include "collada_utils.h"
44
45 // OB_MESH is assumed
46 static std::string getActiveUVLayerName(Object *ob)
47 {
48         Mesh *me = (Mesh*)ob->data;
49
50         int num_layers = CustomData_number_of_layers(&me->fdata, CD_MTFACE);
51         if (num_layers)
52                 return std::string(bc_CustomData_get_active_layer_name(&me->fdata, CD_MTFACE));
53                 
54         return "";
55 }
56
57 EffectsExporter::EffectsExporter(COLLADASW::StreamWriter *sw, const ExportSettings *export_settings) : COLLADASW::LibraryEffects(sw), export_settings(export_settings) {}
58
59 bool EffectsExporter::hasEffects(Scene *sce)
60 {
61         Base *base = (Base *)sce->base.first;
62         
63         while(base) {
64                 Object *ob= base->object;
65                 int a;
66                 for(a = 0; a < ob->totcol; a++)
67                 {
68                         Material *ma = give_current_material(ob, a+1);
69
70                         // no material, but check all of the slots
71                         if (!ma) continue;
72
73                         return true;
74                 }
75                 base= base->next;
76         }
77         return false;
78 }
79
80 void EffectsExporter::exportEffects(Scene *sce)
81 {
82         if(hasEffects(sce)) {
83                 this->scene = sce;
84                 openLibrary();
85                 MaterialFunctor mf;
86                 mf.forEachMaterialInScene<EffectsExporter>(sce, *this, this->export_settings->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         }
142         else {
143                 if(ma->diff_shader == MA_DIFF_LAMBERT) {
144                         writeLambert(ep, ma);
145                 }
146                 else {
147                 // \todo figure out handling of all spec+diff shader combos blender has, for now write phong
148                 writePhong(ep, ma);
149                 }
150         }
151         
152         // index of refraction
153         if (ma->mode & MA_RAYTRANSP) {
154                 ep.setIndexOfRefraction(ma->ang, false , "index_of_refraction");
155         }
156         else {
157                 ep.setIndexOfRefraction(1.0f, false , "index_of_refraction");
158         }
159
160         COLLADASW::ColorOrTexture cot;
161
162         // transparency
163         if (ma->mode & MA_TRANSP) {
164                 // Tod: because we are in A_ONE mode transparency is calculated like this:
165                 ep.setTransparency(ma->alpha, false , "transparency");
166                 // cot = getcol(1.0f, 1.0f, 1.0f, 1.0f);
167                 // ep.setTransparent(cot);
168         }
169
170         // emission
171         cot=getcol(ma->emit, ma->emit, ma->emit, 1.0f);
172         ep.setEmission(cot, false , "emission");
173
174         // diffuse multiplied by diffuse intensity
175         cot = getcol(ma->r * ma->ref, ma->g * ma->ref, ma->b * ma->ref, 1.0f);
176         ep.setDiffuse(cot, false , "diffuse");
177
178         // ambient
179         /* ma->ambX is calculated only on render, so lets do it here manually and not rely on ma->ambX. */
180         if(this->scene->world)
181                 cot = getcol(this->scene->world->ambr*ma->amb, this->scene->world->ambg*ma->amb, this->scene->world->ambb*ma->amb, 1.0f);
182         else
183                 cot = getcol(ma->amb, ma->amb, ma->amb, 1.0f);
184
185         ep.setAmbient(cot, false , "ambient");
186
187         // reflective, reflectivity
188         if (ma->mode & MA_RAYMIRROR) {
189                 cot = getcol(ma->mirr, ma->mirg, ma->mirb, 1.0f);
190                 ep.setReflective(cot);
191                 ep.setReflectivity(ma->ray_mirror);
192         }
193         // else {
194         //      cot = getcol(ma->specr, ma->specg, ma->specb, 1.0f);
195         //      ep.setReflective(cot);
196         //      ep.setReflectivity(ma->spec);
197         // }
198
199         // specular
200         if (ep.getShaderType() != COLLADASW::EffectProfile::LAMBERT) {
201                 cot = getcol(ma->specr * ma->spec, ma->specg * ma->spec, ma->specb * ma->spec, 1.0f);
202                 ep.setSpecular(cot, false , "specular");
203         }       
204
205         // XXX make this more readable if possible
206
207         // create <sampler> and <surface> for each image
208         COLLADASW::Sampler samplers[MAX_MTEX];
209         //COLLADASW::Surface surfaces[MAX_MTEX];
210         //void *samp_surf[MAX_MTEX][2];
211         void *samp_surf[MAX_MTEX][1];
212         
213         // image to index to samp_surf map
214         // samp_surf[index] stores 2 pointers, sampler and surface
215         std::map<std::string, int> im_samp_map;
216
217         unsigned int a, b;
218         for (a = 0, b = 0; a < tex_indices.size(); a++) {
219                 MTex *t = ma->mtex[tex_indices[a]];
220                 Image *ima = t->tex->ima;
221                 
222                 // Image not set for texture
223                 if(!ima) continue;
224                 
225                 std::string key(id_name(ima));
226                 key = translate_id(key);
227
228                 // create only one <sampler>/<surface> pair for each unique image
229                 if (im_samp_map.find(key) == im_samp_map.end()) {
230                         // //<newparam> <surface> <init_from>
231                         // COLLADASW::Surface surface(COLLADASW::Surface::SURFACE_TYPE_2D,
232                         //                                                 key + COLLADASW::Surface::SURFACE_SID_SUFFIX);
233                         // COLLADASW::SurfaceInitOption sio(COLLADASW::SurfaceInitOption::INIT_FROM);
234                         // sio.setImageReference(key);
235                         // surface.setInitOption(sio);
236
237                         // COLLADASW::NewParamSurface surface(mSW);
238                         // surface->setParamType(COLLADASW::CSW_SURFACE_TYPE_2D);
239                         
240                         //<newparam> <sampler> <source>
241                         COLLADASW::Sampler sampler(COLLADASW::Sampler::SAMPLER_TYPE_2D,
242                                                                            key + COLLADASW::Sampler::SAMPLER_SID_SUFFIX,
243                                                                            key + COLLADASW::Sampler::SURFACE_SID_SUFFIX);
244                         sampler.setImageId(key);
245                         // copy values to arrays since they will live longer
246                         samplers[a] = sampler;
247                         //surfaces[a] = surface;
248                         
249                         // store pointers so they can be used later when we create <texture>s
250                         samp_surf[b][0] = &samplers[a];
251                         //samp_surf[b][1] = &surfaces[a];
252                         
253                         im_samp_map[key] = b;
254                         b++;
255                 }
256         }
257
258         // used as fallback when MTex->uvname is "" (this is pretty common)
259         // it is indeed the correct value to use in that case
260         std::string active_uv(getActiveUVLayerName(ob));
261
262         // write textures
263         // XXX very slow
264         for (a = 0; a < tex_indices.size(); a++) {
265                 MTex *t = ma->mtex[tex_indices[a]];
266                 Image *ima = t->tex->ima;
267                 
268                 // Image not set for texture
269                 if(!ima) continue;
270
271                 // we assume map input is always TEXCO_UV
272
273                 std::string key(id_name(ima));
274                 key = translate_id(key);
275                 int i = im_samp_map[key];
276                 COLLADASW::Sampler *sampler = (COLLADASW::Sampler*)samp_surf[i][0];
277                 //COLLADASW::Surface *surface = (COLLADASW::Surface*)samp_surf[i][1];
278
279                 std::string uvname = strlen(t->uvname) ? t->uvname : active_uv;
280
281                 // color
282                 if (t->mapto & (MAP_COL | MAP_COLSPEC)) {
283                         ep.setDiffuse(createTexture(ima, uvname, sampler), false , "diffuse");
284                 }
285                 // ambient
286                 if (t->mapto & MAP_AMB) {
287                         ep.setAmbient(createTexture(ima, uvname, sampler), false , "ambient");
288                 }
289                 // specular
290                 if (t->mapto & MAP_SPEC) {
291                         ep.setSpecular(createTexture(ima, uvname, sampler), false , "specular");
292                 }
293                 // emission
294                 if (t->mapto & MAP_EMIT) {
295                         ep.setEmission(createTexture(ima, uvname, sampler), false , "emission");
296                 }
297                 // reflective
298                 if (t->mapto & MAP_REF) {
299                         ep.setReflective(createTexture(ima, uvname, sampler));
300                 }
301                 // alpha
302                 if (t->mapto & MAP_ALPHA) {
303                         ep.setTransparent(createTexture(ima, uvname, sampler));
304                 }
305                 // extension:
306                 // Normal map --> Must be stored with <extra> tag as different technique, 
307                 // since COLLADA doesn't support normal maps, even in current COLLADA 1.5.
308                 if (t->mapto & MAP_NORM) {
309                         COLLADASW::Texture texture(key);
310                         texture.setTexcoord(uvname);
311                         texture.setSampler(*sampler);
312                         // technique FCOLLADA, with the <bump> tag, is most likely the best understood,
313                         // most widespread de-facto standard.
314                         texture.setProfileName("FCOLLADA");
315                         texture.setChildElementName("bump");
316                         ep.addExtraTechniqueColorOrTexture(COLLADASW::ColorOrTexture(texture));
317                 }
318         }
319         // performs the actual writing
320         ep.addProfileElements();
321         bool twoSided = false;
322         if (ob->type == OB_MESH && ob->data) {
323                 Mesh *me = (Mesh*)ob->data;
324                 if (me->flag & ME_TWOSIDED)
325                         twoSided = true;
326         }
327         if (twoSided)
328                 ep.addExtraTechniqueParameter("GOOGLEEARTH", "double_sided", 1);
329         ep.addExtraTechniques(mSW);
330
331         ep.closeProfile();
332         if (twoSided)
333                 mSW->appendTextBlock("<extra><technique profile=\"MAX3D\"><double_sided>1</double_sided></technique></extra>");
334         closeEffect();  
335 }
336
337 COLLADASW::ColorOrTexture EffectsExporter::createTexture(Image *ima,
338                                                                                 std::string& uv_layer_name,
339                                                                                 COLLADASW::Sampler *sampler
340                                                                                 /*COLLADASW::Surface *surface*/)
341 {
342         
343         COLLADASW::Texture texture(translate_id(id_name(ima)));
344         texture.setTexcoord(uv_layer_name);
345         //texture.setSurface(*surface);
346         texture.setSampler(*sampler);
347         
348         COLLADASW::ColorOrTexture cot(texture);
349         return cot;
350 }
351
352 COLLADASW::ColorOrTexture EffectsExporter::getcol(float r, float g, float b, float a)
353 {
354         COLLADASW::Color color(r,g,b,a);
355         COLLADASW::ColorOrTexture cot(color);
356         return cot;
357 }
358
359 //returns the array of mtex indices which have image 
360 //need this for exporting textures
361 void EffectsExporter::createTextureIndices(Material *ma, std::vector<int> &indices)
362 {
363         indices.clear();
364
365         for (int a = 0; a < MAX_MTEX; a++) {
366                 if (ma->mtex[a] &&
367                         ma->mtex[a]->tex &&
368                         ma->mtex[a]->tex->type == TEX_IMAGE &&
369                         ma->mtex[a]->texco == TEXCO_UV){
370                         indices.push_back(a);
371                 }
372         }
373 }