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