Merge branch 'master' into blender2.8
[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 __ARMATUREIMPORTER_H__
28 #define __ARMATUREIMPORTER_H__
29
30 #include "COLLADAFWNode.h"
31 #include "COLLADAFWUniqueId.h"
32 #include "COLLADAFWMorphController.h"
33
34 extern "C" {
35 #include "BKE_context.h"
36 #include "BKE_key.h"
37
38 #include "DNA_armature_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_key_types.h"
42
43 #include "ED_armature.h"
44 }
45
46 #include "AnimationImporter.h"
47 #include "MeshImporter.h"
48 #include "SkinInfo.h"
49 #include "TransformReader.h"
50 #include "ExtraTags.h"
51
52 #include <map>
53 #include <vector>
54
55 #include "collada_internal.h"
56 #include "collada_utils.h"
57 #include "ImportSettings.h"
58
59 #define UNLIMITED_CHAIN_MAX INT_MAX
60 #define MINIMUM_BONE_LENGTH 0.000001f
61
62 class ArmatureImporter : private TransformReader
63 {
64 private:
65         Main *m_bmain;
66         Scene *scene;
67         ViewLayer *view_layer;
68         UnitConverter *unit_converter;
69         const ImportSettings *import_settings;
70
71         // std::map<int, JointData> joint_index_to_joint_info_map;
72         // std::map<COLLADAFW::UniqueId, int> joint_id_to_joint_index_map;
73         BoneExtensionManager bone_extension_manager;
74         // int bone_direction_row; // XXX not used
75         float leaf_bone_length;
76         int totbone;
77         // XXX not used
78         // float min_angle; // minimum angle between bone head-tail and a row of bone matrix
79
80 #if 0
81         struct ArmatureJoints {
82                 Object *ob_arm;
83                 std::vector<COLLADAFW::Node*> root_joints;
84         };
85         std::vector<ArmatureJoints> armature_joints;
86 #endif
87
88         Object *empty; // empty for leaf bones
89
90         std::map<COLLADAFW::UniqueId, COLLADAFW::UniqueId> geom_uid_by_controller_uid;
91         std::map<COLLADAFW::UniqueId, COLLADAFW::Node*> joint_by_uid; // contains all joints
92         std::vector<COLLADAFW::Node*> root_joints;
93         std::vector<COLLADAFW::Node*> finished_joints;
94         std::vector<COLLADAFW::MorphController*> morph_controllers;
95         std::map<COLLADAFW::UniqueId, Object*> joint_parent_map;
96         std::map<COLLADAFW::UniqueId, Object*> unskinned_armature_map;
97
98         MeshImporterBase *mesh_importer;
99
100         // This is used to store data passed in write_controller_data.
101         // Arrays from COLLADAFW::SkinControllerData lose ownership, so do this class members
102         // so that arrays don't get freed until we free them explicitly.
103
104         std::map<COLLADAFW::UniqueId, SkinInfo> skin_by_data_uid; // data UID = skin controller data UID
105 #if 0
106         JointData *get_joint_data(COLLADAFW::Node *node);
107 #endif
108
109         int create_bone(SkinInfo* skin, COLLADAFW::Node *node, EditBone *parent, int totchild,
110                 float parent_mat[4][4], bArmature *arm, std::vector<std::string> &layer_labels);
111
112         BoneExtended &add_bone_extended(EditBone *bone, COLLADAFW::Node * node, int sibcount, std::vector<std::string> &layer_labels, BoneExtensionMap &extended_bones);
113
114         void fix_leaf_bone_hierarchy(bArmature *armature, Bone *bone, bool fix_orientation);
115         void fix_leaf_bone(bArmature *armature, EditBone *ebone, BoneExtended *be, bool fix_orientation);
116         void fix_parent_connect(bArmature *armature, Bone *bone);
117         void connect_bone_chains(bArmature *armature, Bone *bone, const int max_chain_length);
118
119         void set_pose( Object *ob_arm,  COLLADAFW::Node *root_node, const char *parentname, float parent_mat[4][4]);
120
121 #if 0
122         void set_leaf_bone_shapes(Object *ob_arm);
123         void set_euler_rotmode();
124 #endif
125
126         Object *get_empty_for_leaves();
127
128 #if 0
129         Object *find_armature(COLLADAFW::Node *node);
130
131         ArmatureJoints& get_armature_joints(Object *ob_arm);
132 #endif
133
134         Object *create_armature_bones(Main *bmain, SkinInfo& skin);
135         void create_armature_bones(Main *bmain, std::vector<Object *> &arm_objs);
136
137         /** TagsMap typedef for uid_tags_map. */
138         typedef std::map<std::string, ExtraTags*> TagsMap;
139         TagsMap uid_tags_map;
140 public:
141
142         ArmatureImporter(
143                 UnitConverter *conv, MeshImporterBase *mesh, Main *bmain, Scene *sce, ViewLayer *view_layer, const ImportSettings *import_settings);
144         ~ArmatureImporter();
145
146         void add_root_joint(COLLADAFW::Node *node, Object *parent);
147
148         // here we add bones to armatures, having armatures previously created in write_controller
149         void make_armatures(bContext *C, std::vector<Object *> &objects_to_scale);
150
151         void make_shape_keys(bContext *C);
152
153 #if 0
154         // link with meshes, create vertex groups, assign weights
155         void link_armature(Object *ob_arm, const COLLADAFW::UniqueId& geom_id, const COLLADAFW::UniqueId& controller_data_id);
156 #endif
157
158         bool write_skin_controller_data(const COLLADAFW::SkinControllerData* data);
159
160         bool write_controller(const COLLADAFW::Controller* controller);
161
162         COLLADAFW::UniqueId *get_geometry_uid(const COLLADAFW::UniqueId& controller_uid);
163
164         Object *get_armature_for_joint(COLLADAFW::Node *node);
165
166         void get_rna_path_for_joint(COLLADAFW::Node *node, char *joint_path, size_t count);
167
168         // gives a world-space mat
169         bool get_joint_bind_mat(float m[4][4], COLLADAFW::Node *joint);
170
171         void set_tags_map( TagsMap& tags_map);
172
173 };
174
175 #endif