Merge branch 'master' into blender2.8
[blender.git] / source / blender / collada / SkinInfo.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 SkinInfo.h
24  *  \ingroup collada
25  */
26
27 #ifndef __SKININFO_H__
28 #define __SKININFO_H__
29
30 #include <map>
31 #include <vector>
32
33 #include "COLLADAFWUniqueId.h"
34 #include "COLLADAFWTypes.h"
35 #include "COLLADAFWNode.h"
36 #include "COLLADAFWSkinController.h"
37 #include "COLLADAFWSkinControllerData.h"
38
39 #include "DNA_object_types.h"
40 #include "BKE_context.h"
41
42 #include "TransformReader.h"
43 #include "collada_internal.h"
44
45 // This is used to store data passed in write_controller_data.
46 // Arrays from COLLADAFW::SkinControllerData lose ownership, so do this class members
47 // so that arrays don't get freed until we free them explicitly.
48 class SkinInfo
49 {
50 private:
51         // to build armature bones from inverse bind matrices
52         struct JointData {
53                 float inv_bind_mat[4][4]; // joint inverse bind matrix
54                 COLLADAFW::UniqueId joint_uid; // joint node UID
55                 // Object *ob_arm;                        // armature object
56         };
57
58         float bind_shape_matrix[4][4];
59
60         // data from COLLADAFW::SkinControllerData, each array should be freed
61         COLLADAFW::UIntValuesArray joints_per_vertex;
62         COLLADAFW::UIntValuesArray weight_indices;
63         COLLADAFW::IntValuesArray joint_indices;
64         // COLLADAFW::FloatOrDoubleArray weights;
65         std::vector<float> weights;
66
67         std::vector<JointData> joint_data; // index to this vector is joint index
68
69         UnitConverter *unit_converter;
70
71         Object *ob_arm;
72         COLLADAFW::UniqueId controller_uid;
73         Object *parent;
74
75 public:
76
77         SkinInfo();
78         SkinInfo(const SkinInfo& skin);
79         SkinInfo(UnitConverter *conv);
80
81         // nobody owns the data after this, so it should be freed manually with releaseMemory
82         template <typename T>
83         void transfer_array_data(T& src, T& dest);
84
85         // when src is const we cannot src.yieldOwnerShip, this is used by copy constructor
86         void transfer_int_array_data_const(const COLLADAFW::IntValuesArray& src, COLLADAFW::IntValuesArray& dest);
87
88         void transfer_uint_array_data_const(const COLLADAFW::UIntValuesArray& src, COLLADAFW::UIntValuesArray& dest);
89
90         void borrow_skin_controller_data(const COLLADAFW::SkinControllerData* skin);
91
92         void free();
93
94         // using inverse bind matrices to construct armature
95         // it is safe to invert them to get the original matrices
96         // because if they are inverse matrices, they can be inverted
97         void add_joint(const COLLADABU::Math::Matrix4& matrix);
98
99         void set_controller(const COLLADAFW::SkinController* co);
100
101         // called from write_controller
102         Object *create_armature(Main *bmain, Scene *scene, ViewLayer *view_layer);
103
104         Object* set_armature(Object *ob_arm);
105
106         bool get_joint_inv_bind_matrix(float inv_bind_mat[4][4], COLLADAFW::Node *node);
107
108         Object *BKE_armature_from_object();
109
110         const COLLADAFW::UniqueId& get_controller_uid();
111
112         // check if this skin controller references a joint or any descendant of it
113         //
114         // some nodes may not be referenced by SkinController,
115         // in this case to determine if the node belongs to this armature,
116         // we need to search down the tree
117         bool uses_joint_or_descendant(COLLADAFW::Node *node);
118
119         void link_armature(bContext *C, Object *ob, std::map<COLLADAFW::UniqueId, COLLADAFW::Node*>& joint_by_uid, TransformReader *tm);
120
121         bPoseChannel *get_pose_channel_from_node(COLLADAFW::Node *node);
122
123         void set_parent(Object *_parent);
124
125         Object* get_parent();
126
127         void find_root_joints(const std::vector<COLLADAFW::Node*> &root_joints,
128                                                   std::map<COLLADAFW::UniqueId, COLLADAFW::Node*>& joint_by_uid,
129                                                   std::vector<COLLADAFW::Node*>& result);
130
131         bool find_node_in_tree(COLLADAFW::Node *node, COLLADAFW::Node *tree_root);
132
133 };
134
135 #endif