Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / collada / ControllerExporter.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup collada
18  */
19
20 #ifndef __CONTROLLEREXPORTER_H__
21 #define __CONTROLLEREXPORTER_H__
22
23 #include <list>
24 #include <string>
25 //#include <vector>
26
27 #include "COLLADASWStreamWriter.h"
28 #include "COLLADASWLibraryControllers.h"
29 #include "COLLADASWInstanceController.h"
30 #include "COLLADASWInputList.h"
31 #include "COLLADASWNode.h"
32 #include "COLLADASWExtraTechnique.h"
33
34 #include "DNA_armature_types.h"
35 #include "DNA_listBase.h"
36 #include "DNA_mesh_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_constraint_types.h"
39 #include "DNA_scene_types.h"
40 #include "DNA_key_types.h"
41
42 #include "TransformWriter.h"
43 #include "InstanceWriter.h"
44
45 #include "ExportSettings.h"
46
47 #include "BKE_key.h"
48
49 struct Depsgraph;
50 class SceneExporter;
51
52 class ControllerExporter : public COLLADASW::LibraryControllers, protected TransformWriter, protected InstanceWriter
53 {
54 public:
55         // XXX exporter writes wrong data for shared armatures.  A separate
56         // controller should be written for each armature-mesh binding how do
57         // we make controller ids then?
58         ControllerExporter(BlenderContext &blender_context, COLLADASW::StreamWriter *sw, const ExportSettings *export_settings) :
59                 COLLADASW::LibraryControllers(sw),
60                 blender_context(blender_context),
61                 export_settings(export_settings) {
62         }
63
64         bool is_skinned_mesh(Object *ob);
65
66         bool add_instance_controller(Object *ob);
67
68         void export_controllers();
69
70         void operator()(Object *ob);
71
72 private:
73         BlenderContext &blender_context;
74         const ExportSettings *export_settings;
75
76 #if 0
77         std::vector<Object *> written_armatures;
78
79         bool already_written(Object *ob_arm);
80
81         void wrote(Object *ob_arm);
82
83         void find_objects_using_armature(Object *ob_arm, std::vector<Object *>& objects, Scene *sce);
84 #endif
85
86         std::string get_controller_id(Object *ob_arm, Object *ob);
87
88         std::string get_controller_id(Key *key, Object *ob);
89
90         // ob should be of type OB_MESH
91         // both args are required
92         void export_skin_controller(Object *ob, Object *ob_arm);
93
94         void export_morph_controller(Object *ob, Key *key);
95
96         void add_joints_element(ListBase *defbase,
97                                 const std::string& joints_source_id, const std::string& inv_bind_mat_source_id);
98
99         void add_bind_shape_mat(Object *ob);
100
101         std::string add_morph_targets(Key *key, Object *ob);
102
103         std::string add_morph_weights(Key *key, Object *ob);
104
105         void add_weight_extras(Key *key);
106
107         std::string add_joints_source(Object *ob_arm, ListBase *defbase, const std::string& controller_id);
108
109         std::string add_inv_bind_mats_source(Object *ob_arm, ListBase *defbase, const std::string& controller_id);
110
111         Bone *get_bone_from_defgroup(Object *ob_arm, bDeformGroup *def);
112
113         bool is_bone_defgroup(Object *ob_arm, bDeformGroup *def);
114
115         std::string add_weights_source(Mesh *me, const std::string& controller_id,
116                                        const std::list<float>& weights);
117
118         void add_vertex_weights_element(const std::string& weights_source_id, const std::string& joints_source_id,
119                                         const std::list<int>& vcount, const std::list<int>& joints);
120
121         void write_bone_URLs(COLLADASW::InstanceController &ins, Object *ob_arm, Bone *bone);
122 };
123
124 #endif