Merge branch 'master' into blender2.8
[blender.git] / source / blender / collada / DocumentExporter.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  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/collada/DocumentExporter.cpp
24  *  \ingroup collada
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <math.h>
30 #include <vector>
31 #include <algorithm> // std::find
32
33 #include "COLLADASWCamera.h"
34 #include "COLLADASWAsset.h"
35 #include "COLLADASWLibraryVisualScenes.h"
36 #include "COLLADASWNode.h"
37 #include "COLLADASWSource.h"
38 #include "COLLADASWInstanceGeometry.h"
39 #include "COLLADASWInputList.h"
40 #include "COLLADASWPrimitves.h"
41 #include "COLLADASWVertices.h"
42 #include "COLLADASWLibraryAnimations.h"
43 #include "COLLADASWLibraryImages.h"
44 #include "COLLADASWLibraryEffects.h"
45 #include "COLLADASWImage.h"
46 #include "COLLADASWEffectProfile.h"
47 #include "COLLADASWColorOrTexture.h"
48 #include "COLLADASWParamTemplate.h"
49 #include "COLLADASWParamBase.h"
50 #include "COLLADASWSurfaceInitOption.h"
51 #include "COLLADASWSampler.h"
52 #include "COLLADASWScene.h"
53 #include "COLLADASWTechnique.h"
54 #include "COLLADASWTexture.h"
55 #include "COLLADASWLibraryMaterials.h"
56 #include "COLLADASWBindMaterial.h"
57 #include "COLLADASWInstanceCamera.h"
58 #include "COLLADASWInstanceLight.h"
59 #include "COLLADASWConstants.h"
60 #include "COLLADASWLibraryControllers.h"
61 #include "COLLADASWInstanceController.h"
62 #include "COLLADASWInstanceNode.h"
63 #include "COLLADASWBaseInputElement.h"
64
65 extern "C" 
66 {
67 #include "DNA_scene_types.h"
68 #include "DNA_object_types.h"
69 #include "DNA_group_types.h"
70 #include "DNA_meshdata_types.h"
71 #include "DNA_mesh_types.h"
72 #include "DNA_image_types.h"
73 #include "DNA_material_types.h"
74 #include "DNA_anim_types.h"
75 #include "DNA_action_types.h"
76 #include "DNA_curve_types.h"
77 #include "DNA_armature_types.h"
78 #include "DNA_modifier_types.h"
79 #include "DNA_userdef_types.h"
80
81 #include "BLI_path_util.h"
82 #include "BLI_fileops.h"
83 #include "BLI_math.h"
84 #include "BLI_string.h"
85 #include "BLI_listbase.h"
86 #include "BLI_utildefines.h"
87
88 #include "BKE_DerivedMesh.h"
89 #include "BKE_action.h" // pose functions
90 #include "BKE_animsys.h"
91 #include "BKE_armature.h"
92 #include "BKE_blender_version.h"
93 #include "BKE_fcurve.h"
94 #include "BKE_global.h"
95 #include "BKE_image.h"
96 #include "BKE_main.h"
97 #include "BKE_material.h"
98 #include "BKE_object.h"
99 #include "BKE_scene.h"
100 #include "BKE_appdir.h"
101
102 #include "ED_keyframing.h"
103 #ifdef WITH_BUILDINFO
104 extern char build_commit_date[];
105 extern char build_commit_time[];
106 extern char build_hash[];
107 #endif
108
109 #include "MEM_guardedalloc.h"
110
111 #include "RNA_access.h"
112 }
113
114 #include "collada_internal.h"
115 #include "collada_utils.h"
116 #include "DocumentExporter.h"
117
118 extern bool bc_has_object_type(LinkNode *export_set, short obtype);
119
120 // can probably go after refactor is complete
121 #include "InstanceWriter.h"
122 #include "TransformWriter.h"
123
124 #include "SceneExporter.h"
125 #include "ArmatureExporter.h"
126 #include "AnimationExporter.h"
127 #include "CameraExporter.h"
128 #include "ControllerExporter.h"
129 #include "EffectExporter.h"
130 #include "GeometryExporter.h"
131 #include "ImageExporter.h"
132 #include "LightExporter.h"
133 #include "MaterialExporter.h"
134
135 #include <errno.h>
136
137 char *bc_CustomData_get_layer_name(const struct CustomData *data, int type, int n)
138 {
139         int layer_index = CustomData_get_layer_index(data, type);
140         if (layer_index < 0) return NULL;
141
142         return data->layers[layer_index + n].name;
143 }
144
145 char *bc_CustomData_get_active_layer_name(const CustomData *data, int type)
146 {
147         /* get the layer index of the active layer of type */
148         int layer_index = CustomData_get_active_layer_index(data, type);
149         if (layer_index < 0) return NULL;
150
151         return data->layers[layer_index].name;
152 }
153
154 DocumentExporter::DocumentExporter(Depsgraph *depsgraph, const ExportSettings *export_settings) :
155         depsgraph(depsgraph),
156         export_settings(export_settings) {
157 }
158
159 static COLLADABU::NativeString make_temp_filepath(const char *name, const char *extension)
160 {
161         char tempfile[FILE_MAX];
162         const char *tempdir = BKE_tempdir_session();
163
164         if (name == NULL) {
165                 name = "untitled";
166         }
167
168         BLI_make_file_string(NULL, tempfile, tempdir, name);
169
170         if (extension) {
171                 BLI_ensure_extension(tempfile, FILE_MAX, extension);
172         }
173
174         COLLADABU::NativeString native_filename =
175                 COLLADABU::NativeString(tempfile, COLLADABU::NativeString::ENCODING_UTF8);
176         return native_filename;
177 }
178
179 // TODO: it would be better to instantiate animations rather than create a new one per object
180 // COLLADA allows this through multiple <channel>s in <animation>.
181 // For this to work, we need to know objects that use a certain action.
182
183 int DocumentExporter::exportCurrentScene(bContext *C, Scene *sce)
184 {
185         PointerRNA sceneptr, unit_settings;
186         PropertyRNA *system; /* unused , *scale; */
187
188         clear_global_id_map();
189
190         COLLADABU::NativeString native_filename = make_temp_filepath(NULL, ".dae");
191         COLLADASW::StreamWriter *writer = new COLLADASW::StreamWriter(native_filename);
192
193         // open <collada>
194         writer->startDocument();
195
196         // <asset>
197         COLLADASW::Asset asset(writer);
198
199         RNA_id_pointer_create(&(sce->id), &sceneptr);
200         unit_settings = RNA_pointer_get(&sceneptr, "unit_settings");
201         system = RNA_struct_find_property(&unit_settings, "system");
202         //scale = RNA_struct_find_property(&unit_settings, "scale_length");
203
204         std::string unitname = "meter";
205         float linearmeasure = RNA_float_get(&unit_settings, "scale_length");
206
207         switch (RNA_property_enum_get(&unit_settings, system)) {
208                 case USER_UNIT_NONE:
209                 case USER_UNIT_METRIC:
210                         if (linearmeasure == 0.001f) {
211                                 unitname = "millimeter";
212                         }
213                         else if (linearmeasure == 0.01f) {
214                                 unitname = "centimeter";
215                         }
216                         else if (linearmeasure == 0.1f) {
217                                 unitname = "decimeter";
218                         }
219                         else if (linearmeasure == 1.0f) {
220                                 unitname = "meter";
221                         }
222                         else if (linearmeasure == 1000.0f) {
223                                 unitname = "kilometer";
224                         }
225                         break;
226                 case USER_UNIT_IMPERIAL:
227                         if (linearmeasure == 0.0254f) {
228                                 unitname = "inch";
229                         }
230                         else if (linearmeasure == 0.3048f) {
231                                 unitname = "foot";
232                         }
233                         else if (linearmeasure == 0.9144f) {
234                                 unitname = "yard";
235                         }
236                         break;
237                 default:
238                         break;
239         }
240
241         asset.setUnit(unitname, linearmeasure);
242         asset.setUpAxisType(COLLADASW::Asset::Z_UP);
243         if (U.author[0] != '\0') {
244                 asset.getContributor().mAuthor = U.author;
245         }
246         else {
247                 asset.getContributor().mAuthor = "Blender User";
248         }
249         char version_buf[128];
250 #ifdef WITH_BUILDINFO
251         BLI_snprintf(version_buf, sizeof(version_buf), "Blender %d.%02d.%d commit date:%s, commit time:%s, hash:%s",
252                      BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION,
253                      build_commit_date, build_commit_time, build_hash);
254 #else
255         BLI_snprintf(version_buf, sizeof(version_buf), "Blender %d.%02d.%d",
256                      BLENDER_VERSION / 100, BLENDER_VERSION % 100, BLENDER_SUBVERSION);
257 #endif
258         asset.getContributor().mAuthoringTool = version_buf;
259         asset.add();
260         
261         LinkNode *export_set = this->export_settings->export_set;
262         // <library_cameras>
263         if (bc_has_object_type(export_set, OB_CAMERA)) {
264                 CamerasExporter ce(writer, this->export_settings);
265                 ce.exportCameras(sce);
266         }
267         
268         // <library_lights>
269         if (bc_has_object_type(export_set, OB_LAMP)) {
270                 LightsExporter le(writer, this->export_settings);
271                 le.exportLights(sce);
272         }
273
274         // <library_images>
275         ImagesExporter ie(writer, this->export_settings);
276         ie.exportImages(sce);
277         
278         // <library_effects>
279         EffectsExporter ee(writer, this->export_settings);
280         ee.exportEffects(sce);
281         
282         // <library_materials>
283         MaterialsExporter me(writer, this->export_settings);
284         me.exportMaterials(sce);
285
286         // <library_geometries>
287         if (bc_has_object_type(export_set, OB_MESH)) {
288                 GeometryExporter ge(writer, this->export_settings);
289                 ge.exportGeom(depsgraph, sce);
290         }
291
292         // <library_controllers>
293         ArmatureExporter arm_exporter(writer, this->export_settings);
294         ControllerExporter controller_exporter(writer, this->export_settings);
295         if (bc_has_object_type(export_set, OB_ARMATURE) || this->export_settings->include_shapekeys) 
296         {
297                 controller_exporter.export_controllers(depsgraph, sce);
298         }
299
300         // <library_visual_scenes>
301
302         SceneExporter se(writer, &arm_exporter, this->export_settings);
303
304         if (this->export_settings->include_animations) {
305                 // <library_animations>
306                 AnimationExporter ae(depsgraph, writer, this->export_settings);
307                 ae.exportAnimations(sce);
308         }
309         se.exportScene(C, depsgraph, sce);
310         
311         // <scene>
312         std::string scene_name(translate_id(id_name(sce)));
313         COLLADASW::Scene scene(writer, COLLADASW::URI(COLLADABU::Utils::EMPTY_STRING,
314                                                    scene_name));
315         scene.add();
316         
317         // close <Collada>
318         writer->endDocument();
319         delete writer;
320
321         // Finally move the created document into place
322         fprintf(stdout, "Collada export to: %s\n", this->export_settings->filepath);
323         int status = BLI_rename(native_filename.c_str(), this->export_settings->filepath);
324         if (status != 0) {
325                 status = BLI_copy(native_filename.c_str(), this->export_settings->filepath);
326                 BLI_delete(native_filename.c_str(), false, false);
327         }
328         return status;
329 }
330
331 void DocumentExporter::exportScenes(const char *filename)
332 {
333 }
334
335 /*
336  * NOTES:
337  *
338  * AnimationExporter::sample_animation enables all curves on armature, this is undesirable for a user
339  *
340  */