Merge with trunk r37757.
[blender.git] / source / blender / collada / SkinInfo.cpp
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Chingiz Dyussenov, Arystanbek Dyussenov, Nathan Letwory.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/collada/SkinInfo.cpp
26  *  \ingroup collada
27  */
28
29
30 #include <algorithm>
31
32 #if !defined(WIN32) || defined(FREE_WINDOWS)
33 #include <stdint.h>
34 #endif
35
36 /* COLLADABU_ASSERT, may be able to remove later */
37 #include "COLLADABUPlatform.h"
38
39 #include "BKE_object.h"
40 #include "DNA_armature_types.h"
41 #include "DNA_modifier_types.h"
42 #include "ED_mesh.h"
43 #include "ED_object.h"
44 #include "BKE_action.h"
45 #include "BLI_listbase.h"
46 #include "BLI_math.h"
47
48 #include "SkinInfo.h"
49 #include "collada_utils.h"
50
51 // use name, or fall back to original id if name not present (name is optional)
52 template<class T>
53 static const char *bc_get_joint_name(T *node)
54 {
55         const std::string& id = node->getName();
56         return id.size() ? id.c_str() : node->getOriginalId().c_str();
57 }
58
59 // This is used to store data passed in write_controller_data.
60 // Arrays from COLLADAFW::SkinControllerData lose ownership, so do this class members
61 // so that arrays don't get freed until we free them explicitly.
62 SkinInfo::SkinInfo() {}
63
64 SkinInfo::SkinInfo(const SkinInfo& skin) : weights(skin.weights),
65                                                                  joint_data(skin.joint_data),
66                                                                  unit_converter(skin.unit_converter),
67                                                                  ob_arm(skin.ob_arm),
68                                                                  controller_uid(skin.controller_uid),
69                                                                  parent(skin.parent)
70 {
71         copy_m4_m4(bind_shape_matrix, (float (*)[4])skin.bind_shape_matrix);
72
73         transfer_uint_array_data_const(skin.joints_per_vertex, joints_per_vertex);
74         transfer_uint_array_data_const(skin.weight_indices, weight_indices);
75         transfer_int_array_data_const(skin.joint_indices, joint_indices);
76 }
77
78 SkinInfo::SkinInfo(UnitConverter *conv) : unit_converter(conv), ob_arm(NULL), parent(NULL) {}
79
80 // nobody owns the data after this, so it should be freed manually with releaseMemory
81 template <class T>
82 void SkinInfo::transfer_array_data(T& src, T& dest)
83 {
84         dest.setData(src.getData(), src.getCount());
85         src.yieldOwnerShip();
86         dest.yieldOwnerShip();
87 }
88
89 // when src is const we cannot src.yieldOwnerShip, this is used by copy constructor
90 void SkinInfo::transfer_int_array_data_const(const COLLADAFW::IntValuesArray& src, COLLADAFW::IntValuesArray& dest)
91 {
92         dest.setData((int*)src.getData(), src.getCount());
93         dest.yieldOwnerShip();
94 }
95
96 void SkinInfo::transfer_uint_array_data_const(const COLLADAFW::UIntValuesArray& src, COLLADAFW::UIntValuesArray& dest)
97 {
98         dest.setData((unsigned int*)src.getData(), src.getCount());
99         dest.yieldOwnerShip();
100 }
101
102 void SkinInfo::borrow_skin_controller_data(const COLLADAFW::SkinControllerData* skin)
103 {
104         transfer_array_data((COLLADAFW::UIntValuesArray&)skin->getJointsPerVertex(), joints_per_vertex);
105         transfer_array_data((COLLADAFW::UIntValuesArray&)skin->getWeightIndices(), weight_indices);
106         transfer_array_data((COLLADAFW::IntValuesArray&)skin->getJointIndices(), joint_indices);
107         // transfer_array_data(skin->getWeights(), weights);
108
109         // cannot transfer data for FloatOrDoubleArray, copy values manually
110         const COLLADAFW::FloatOrDoubleArray& weight = skin->getWeights();
111         for (unsigned int i = 0; i < weight.getValuesCount(); i++)
112                 weights.push_back(bc_get_float_value(weight, i));
113
114         unit_converter->dae_matrix_to_mat4_(bind_shape_matrix, skin->getBindShapeMatrix());
115 }
116         
117 void SkinInfo::free()
118 {
119         joints_per_vertex.releaseMemory();
120         weight_indices.releaseMemory();
121         joint_indices.releaseMemory();
122         // weights.releaseMemory();
123 }
124
125 // using inverse bind matrices to construct armature
126 // it is safe to invert them to get the original matrices
127 // because if they are inverse matrices, they can be inverted
128 void SkinInfo::add_joint(const COLLADABU::Math::Matrix4& matrix)
129 {
130         JointData jd;
131         unit_converter->dae_matrix_to_mat4_(jd.inv_bind_mat, matrix);
132         joint_data.push_back(jd);
133 }
134
135 void SkinInfo::set_controller(const COLLADAFW::SkinController* co)
136 {
137         controller_uid = co->getUniqueId();
138
139         // fill in joint UIDs
140         const COLLADAFW::UniqueIdArray& joint_uids = co->getJoints();
141         for (unsigned int i = 0; i < joint_uids.getCount(); i++) {
142                 joint_data[i].joint_uid = joint_uids[i];
143
144                 // // store armature pointer
145                 // JointData& jd = joint_index_to_joint_info_map[i];
146                 // jd.ob_arm = ob_arm;
147
148                 // now we'll be able to get inv bind matrix from joint id
149                 // joint_id_to_joint_index_map[joint_ids[i]] = i;
150         }
151 }
152
153 // called from write_controller
154 Object *SkinInfo::create_armature(Scene *scene)
155 {
156         ob_arm = add_object(scene, OB_ARMATURE);
157         return ob_arm;
158 }
159
160 Object* SkinInfo::set_armature(Object *ob_arm)
161 {
162         if (this->ob_arm)
163                 return this->ob_arm;
164
165         this->ob_arm = ob_arm;
166         return ob_arm;
167 }
168
169 bool SkinInfo::get_joint_inv_bind_matrix(float inv_bind_mat[][4], COLLADAFW::Node *node)
170 {
171         const COLLADAFW::UniqueId& uid = node->getUniqueId();
172         std::vector<JointData>::iterator it;
173         for (it = joint_data.begin(); it != joint_data.end(); it++) {
174                 if ((*it).joint_uid == uid) {
175                         copy_m4_m4(inv_bind_mat, (*it).inv_bind_mat);
176                         return true;
177                 }
178         }
179
180         return false;
181 }
182
183 Object *SkinInfo::get_armature()
184 {
185         return ob_arm;
186 }
187
188 const COLLADAFW::UniqueId& SkinInfo::get_controller_uid()
189 {
190         return controller_uid;
191 }
192
193 // check if this skin controller references a joint or any descendant of it
194 // 
195 // some nodes may not be referenced by SkinController,
196 // in this case to determine if the node belongs to this armature,
197 // we need to search down the tree
198 bool SkinInfo::uses_joint_or_descendant(COLLADAFW::Node *node)
199 {
200         const COLLADAFW::UniqueId& uid = node->getUniqueId();
201         std::vector<JointData>::iterator it;
202         for (it = joint_data.begin(); it != joint_data.end(); it++) {
203                 if ((*it).joint_uid == uid)
204                         return true;
205         }
206
207         COLLADAFW::NodePointerArray& children = node->getChildNodes();
208         for (unsigned int i = 0; i < children.getCount(); i++) {
209                 if (uses_joint_or_descendant(children[i]))
210                         return true;
211         }
212
213         return false;
214 }
215
216 void SkinInfo::link_armature(bContext *C, Object *ob, std::map<COLLADAFW::UniqueId, COLLADAFW::Node*>& joint_by_uid,
217                                    TransformReader *tm)
218 {
219         Main *bmain = CTX_data_main(C);
220         Scene *scene = CTX_data_scene(C);
221
222         ModifierData *md = ED_object_modifier_add(NULL, bmain, scene, ob, NULL, eModifierType_Armature);
223         ((ArmatureModifierData *)md)->object = ob_arm;
224
225         copy_m4_m4(ob->obmat, bind_shape_matrix);
226         object_apply_mat4(ob, ob->obmat, 0, 0);
227 #if 1
228         bc_set_parent(ob, ob_arm, C);
229 #else
230         Object workob;
231         ob->parent = ob_arm;
232         ob->partype = PAROBJECT;
233
234         what_does_parent(scene, ob, &workob);
235         invert_m4_m4(ob->parentinv, workob.obmat);
236
237         ob->recalc |= OB_RECALC_OB|OB_RECALC_DATA;
238
239         DAG_scene_sort(bmain, scene);
240         DAG_ids_flush_update(bmain, 0);
241         WM_event_add_notifier(C, NC_OBJECT|ND_TRANSFORM, NULL);
242 #endif
243
244         ((bArmature*)ob_arm->data)->deformflag = ARM_DEF_VGROUP;
245
246         // create all vertex groups
247         std::vector<JointData>::iterator it;
248         int joint_index;
249         for (it = joint_data.begin(), joint_index = 0; it != joint_data.end(); it++, joint_index++) {
250                 const char *name = "Group";
251
252                 // skip joints that have invalid UID
253                 if ((*it).joint_uid == COLLADAFW::UniqueId::INVALID) continue;
254                 
255                 // name group by joint node name
256                 
257                 if (joint_by_uid.find((*it).joint_uid) != joint_by_uid.end()) {
258                         name = bc_get_joint_name(joint_by_uid[(*it).joint_uid]);
259                 }
260
261                 ED_vgroup_add_name(ob, (char*)name);
262         }
263
264         // <vcount> - number of joints per vertex - joints_per_vertex
265         // <v> - [[bone index, weight index] * joints per vertex] * vertices - weight indices
266         // ^ bone index can be -1 meaning weight toward bind shape, how to express this in Blender?
267
268         // for each vertex in weight indices
269         //   for each bone index in vertex
270         //     add vertex to group at group index
271         //     treat group index -1 specially
272
273         // get def group by index with BLI_findlink
274
275         for (unsigned int vertex = 0, weight = 0; vertex < joints_per_vertex.getCount(); vertex++) {
276
277                 unsigned int limit = weight + joints_per_vertex[vertex];
278                 for ( ; weight < limit; weight++) {
279                         int joint = joint_indices[weight], joint_weight = weight_indices[weight];
280
281                         // -1 means "weight towards the bind shape", we just don't assign it to any group
282                         if (joint != -1) {
283                                 bDeformGroup *def = (bDeformGroup*)BLI_findlink(&ob->defbase, joint);
284
285                                 ED_vgroup_vert_add(ob, def, vertex, weights[joint_weight], WEIGHT_REPLACE);
286                         }
287                 }
288         }
289 }
290
291 bPoseChannel *SkinInfo::get_pose_channel_from_node(COLLADAFW::Node *node)
292 {
293         return get_pose_channel(ob_arm->pose, bc_get_joint_name(node));
294 }
295
296 void SkinInfo::set_parent(Object *_parent)
297 {
298         parent = _parent;
299 }
300
301 Object* SkinInfo::get_parent()
302 {
303         return parent;
304 }
305
306 void SkinInfo::find_root_joints(const std::vector<COLLADAFW::Node*> &root_joints,
307                                           std::map<COLLADAFW::UniqueId, COLLADAFW::Node*>& joint_by_uid,
308                                           std::vector<COLLADAFW::Node*>& result)
309 {
310         std::vector<COLLADAFW::Node*>::const_iterator it;
311         // for each root_joint
312         for (it = root_joints.begin(); it != root_joints.end(); it++) {
313                 COLLADAFW::Node *root = *it;
314                 std::vector<JointData>::iterator ji;
315                 //for each joint_data in this skin
316                 for (ji = joint_data.begin(); ji != joint_data.end(); ji++) {
317                         //get joint node from joint map
318                         COLLADAFW::Node *joint = joint_by_uid[(*ji).joint_uid];
319                         //find if joint node is in the tree belonging to the root_joint
320                         if (find_node_in_tree(joint, root)) {
321                                 if (std::find(result.begin(), result.end(), root) == result.end())
322                                         result.push_back(root);
323                         }
324                 }
325         }
326 }
327
328 bool SkinInfo::find_node_in_tree(COLLADAFW::Node *node, COLLADAFW::Node *tree_root)
329 {
330         if (node == tree_root)
331                 return true;
332
333         COLLADAFW::NodePointerArray& children = tree_root->getChildNodes();
334         for (unsigned int i = 0; i < children.getCount(); i++) {
335                 if (find_node_in_tree(node, children[i]))
336                         return true;
337         }
338
339         return false;
340 }