use const for readonly strings and set some functions to static
[blender.git] / source / blender / collada / ArmatureImporter.h
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, Nathan Letwory.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file ArmatureImporter.h
24  *  \ingroup collada
25  */
26
27 #ifndef __BC_ARMATUREIMPORTER_H__
28 #define __BC_ARMATUREIMPORTER_H__
29
30 #include "COLLADAFWNode.h"
31 #include "COLLADAFWUniqueId.h"
32
33 extern "C" {
34 #include "BKE_context.h"
35
36 #include "DNA_armature_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_scene_types.h"
39
40 #include "ED_armature.h"
41 }
42
43 #include "AnimationImporter.h"
44 #include "MeshImporter.h"
45 #include "SkinInfo.h"
46 #include "TransformReader.h"
47 #include "ExtraTags.h"
48
49 #include <map>
50 #include <vector>
51
52 #include "collada_internal.h"
53 #include "collada_utils.h"
54
55 class ArmatureImporter : private TransformReader
56 {
57 private:
58         Scene *scene;
59         UnitConverter *unit_converter;
60
61         // std::map<int, JointData> joint_index_to_joint_info_map;
62         // std::map<COLLADAFW::UniqueId, int> joint_id_to_joint_index_map;
63
64         struct LeafBone {
65                 // COLLADAFW::Node *node;
66                 EditBone *bone;
67                 char name[32];
68                 float mat[4][4]; // bone matrix, derived from inv_bind_mat
69         };
70         std::vector<LeafBone> leaf_bones;
71         // int bone_direction_row; // XXX not used
72         float leaf_bone_length;
73         int totbone;
74         // XXX not used
75         // float min_angle; // minimum angle between bone head-tail and a row of bone matrix
76
77 #if 0
78         struct ArmatureJoints {
79                 Object *ob_arm;
80                 std::vector<COLLADAFW::Node*> root_joints;
81         };
82         std::vector<ArmatureJoints> armature_joints;
83 #endif
84
85         Object *empty; // empty for leaf bones
86
87         std::map<COLLADAFW::UniqueId, COLLADAFW::UniqueId> geom_uid_by_controller_uid;
88         std::map<COLLADAFW::UniqueId, COLLADAFW::Node*> joint_by_uid; // contains all joints
89         std::vector<COLLADAFW::Node*> root_joints;
90         std::vector<COLLADAFW::Node*> finished_joints;
91         std::map<COLLADAFW::UniqueId, Object*> joint_parent_map;
92         std::map<COLLADAFW::UniqueId, Object*> unskinned_armature_map;
93
94         MeshImporterBase *mesh_importer;
95         AnimationImporterBase *anim_importer;
96
97         // This is used to store data passed in write_controller_data.
98         // Arrays from COLLADAFW::SkinControllerData lose ownership, so do this class members
99         // so that arrays don't get freed until we free them explicitly.
100
101         std::map<COLLADAFW::UniqueId, SkinInfo> skin_by_data_uid; // data UID = skin controller data UID
102 #if 0
103         JointData *get_joint_data(COLLADAFW::Node *node);
104 #endif
105
106         void create_bone(SkinInfo& skin, COLLADAFW::Node *node, EditBone *parent, int totchild,
107                                          float parent_mat[][4], bArmature *arm);
108
109         void create_unskinned_bone(COLLADAFW::Node *node, EditBone *parent, int totchild,
110                                  float parent_mat[][4], Object * ob_arm);
111
112         void add_leaf_bone(float mat[][4], EditBone *bone, COLLADAFW::Node * node);
113
114         void fix_leaf_bones();
115         
116         void set_pose ( Object * ob_arm ,  COLLADAFW::Node * root_node , const char *parentname, float parent_mat[][4]);
117
118
119 #if 0
120         void set_leaf_bone_shapes(Object *ob_arm);
121         void set_euler_rotmode();
122 #endif
123
124         Object *get_empty_for_leaves();
125
126 #if 0
127         Object *find_armature(COLLADAFW::Node *node);
128
129         ArmatureJoints& get_armature_joints(Object *ob_arm);
130 #endif
131
132         void create_armature_bones(SkinInfo& skin);
133         void create_armature_bones( );
134
135         /** TagsMap typedef for uid_tags_map. */
136         typedef std::map<std::string, ExtraTags*> TagsMap;
137         TagsMap uid_tags_map;
138 public:
139
140         ArmatureImporter(UnitConverter *conv, MeshImporterBase *mesh, AnimationImporterBase *anim, Scene *sce);
141         ~ArmatureImporter();
142
143         // root - if this joint is the top joint in hierarchy, if a joint
144         // is a child of a node (not joint), root should be true since
145         // this is where we build armature bones from
146         void add_joint(COLLADAFW::Node *node, bool root, Object *parent, Scene *sce);
147
148 #if 0
149         void add_root_joint(COLLADAFW::Node *node);
150 #endif
151
152         // here we add bones to armatures, having armatures previously created in write_controller
153         void make_armatures(bContext *C);
154
155 #if 0
156         // link with meshes, create vertex groups, assign weights
157         void link_armature(Object *ob_arm, const COLLADAFW::UniqueId& geom_id, const COLLADAFW::UniqueId& controller_data_id);
158 #endif
159
160         bool write_skin_controller_data(const COLLADAFW::SkinControllerData* data);
161
162         bool write_controller(const COLLADAFW::Controller* controller);
163
164         COLLADAFW::UniqueId *get_geometry_uid(const COLLADAFW::UniqueId& controller_uid);
165         
166         Object *get_armature_for_joint(COLLADAFW::Node *node);
167
168         void get_rna_path_for_joint(COLLADAFW::Node *node, char *joint_path, size_t count);
169         
170         // gives a world-space mat
171         bool get_joint_bind_mat(float m[][4], COLLADAFW::Node *joint);
172
173         void set_tags_map( TagsMap& tags_map);
174         
175 };
176
177 #endif