Alembic: more lenient check on absence of sheer & homogeneous scaling
[blender.git] / source / blender / alembic / intern / abc_util.cc
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): Esteban Tovagliari, Cedric Paille, Kevin Dietrich
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #include "abc_util.h"
24
25 #include "abc_camera.h"
26 #include "abc_curves.h"
27 #include "abc_mesh.h"
28 #include "abc_nurbs.h"
29 #include "abc_points.h"
30 #include "abc_transform.h"
31
32 #include <Alembic/AbcMaterial/IMaterial.h>
33
34 #include <algorithm>
35
36 extern "C" {
37 #include "DNA_object_types.h"
38
39 #include "BLI_math.h"
40
41 #include "PIL_time.h"
42 }
43
44 std::string get_id_name(const Object * const ob)
45 {
46         if (!ob) {
47                 return "";
48         }
49
50         return get_id_name(&ob->id);
51 }
52
53 std::string get_id_name(const ID * const id)
54 {
55         std::string name(id->name + 2);
56         std::replace(name.begin(), name.end(), ' ', '_');
57         std::replace(name.begin(), name.end(), '.', '_');
58         std::replace(name.begin(), name.end(), ':', '_');
59
60         return name;
61 }
62
63 std::string get_object_dag_path_name(const Object * const ob, Object *dupli_parent)
64 {
65         std::string name = get_id_name(ob);
66
67         Object *p = ob->parent;
68
69         while (p) {
70                 name = get_id_name(p) + "/" + name;
71                 p = p->parent;
72         }
73
74         if (dupli_parent && (ob != dupli_parent)) {
75                 name = get_id_name(dupli_parent) + "/" + name;
76         }
77
78         return name;
79 }
80
81 bool object_selected(Object *ob)
82 {
83         return ob->flag & SELECT;
84 }
85
86 bool parent_selected(Object *ob)
87 {
88         if (object_selected(ob)) {
89                 return true;
90         }
91
92         bool do_export = false;
93
94         Object *parent = ob->parent;
95
96         while (parent != NULL) {
97                 if (object_selected(parent)) {
98                         do_export = true;
99                         break;
100                 }
101
102                 parent = parent->parent;
103         }
104
105         return do_export;
106 }
107
108 Imath::M44d convert_matrix(float mat[4][4])
109 {
110         Imath::M44d m;
111
112         for (int i = 0; i < 4; ++i) {
113                 for (int j = 0; j < 4; ++j) {
114                         m[i][j] = mat[i][j];
115                 }
116         }
117
118         return m;
119 }
120
121 void split(const std::string &s, const char delim, std::vector<std::string> &tokens)
122 {
123         tokens.clear();
124
125         std::stringstream ss(s);
126         std::string item;
127
128         while (std::getline(ss, item, delim)) {
129                 if (!item.empty()) {
130                         tokens.push_back(item);
131                 }
132         }
133 }
134
135 /* Create a rotation matrix for each axis from euler angles.
136  * Euler angles are swaped to change coordinate system. */
137 static void create_rotation_matrix(
138         float rot_x_mat[3][3], float rot_y_mat[3][3],
139         float rot_z_mat[3][3], const float euler[3], const bool to_yup)
140 {
141         const float rx = euler[0];
142         const float ry = (to_yup) ?  euler[2] : -euler[2];
143         const float rz = (to_yup) ? -euler[1] :  euler[1];
144
145         unit_m3(rot_x_mat);
146         unit_m3(rot_y_mat);
147         unit_m3(rot_z_mat);
148
149         rot_x_mat[1][1] = cos(rx);
150         rot_x_mat[2][1] = -sin(rx);
151         rot_x_mat[1][2] = sin(rx);
152         rot_x_mat[2][2] = cos(rx);
153
154         rot_y_mat[2][2] = cos(ry);
155         rot_y_mat[0][2] = -sin(ry);
156         rot_y_mat[2][0] = sin(ry);
157         rot_y_mat[0][0] = cos(ry);
158
159         rot_z_mat[0][0] = cos(rz);
160         rot_z_mat[1][0] = -sin(rz);
161         rot_z_mat[0][1] = sin(rz);
162         rot_z_mat[1][1] = cos(rz);
163 }
164
165 /* Convert matrix from Z=up to Y=up or vice versa. Use yup_mat = zup_mat for in-place conversion. */
166 void copy_m44_axis_swap(float dst_mat[4][4], float src_mat[4][4], AbcAxisSwapMode mode)
167 {
168         float dst_rot[3][3], src_rot[3][3], dst_scale_mat[4][4];
169         float rot_x_mat[3][3], rot_y_mat[3][3], rot_z_mat[3][3];
170         float src_trans[3], dst_scale[3], src_scale[3], euler[3];
171
172         zero_v3(src_trans);
173         zero_v3(dst_scale);
174         zero_v3(src_scale);
175         zero_v3(euler);
176         unit_m3(src_rot);
177         unit_m3(dst_rot);
178         unit_m4(dst_scale_mat);
179
180         /* We assume there is no sheer component and no homogeneous scaling component. */
181         BLI_assert(fabs(src_mat[0][3]) < 2 * FLT_EPSILON);
182         BLI_assert(fabs(src_mat[1][3]) < 2 * FLT_EPSILON);
183         BLI_assert(fabs(src_mat[2][3]) < 2 * FLT_EPSILON);
184         BLI_assert(fabs(src_mat[3][3] - 1.0f) < 2 * FLT_EPSILON);
185
186         /* Extract translation, rotation, and scale form matrix. */
187         mat4_to_loc_rot_size(src_trans, src_rot, src_scale, src_mat);
188
189         /* Get euler angles from rotation matrix. */
190         mat3_to_eulO(euler, ROT_MODE_XYZ, src_rot);
191
192         /* Create X, Y, Z rotation matrices from euler angles. */
193         create_rotation_matrix(rot_x_mat, rot_y_mat, rot_z_mat, euler,
194                                mode == ABC_YUP_FROM_ZUP);
195
196         /* Concatenate rotation matrices. */
197         mul_m3_m3m3(dst_rot, dst_rot, rot_y_mat);
198         mul_m3_m3m3(dst_rot, dst_rot, rot_z_mat);
199         mul_m3_m3m3(dst_rot, dst_rot, rot_x_mat);
200
201         mat3_to_eulO(euler, ROT_MODE_XYZ, dst_rot);
202
203         /* Start construction of dst_mat from rotation matrix */
204         unit_m4(dst_mat);
205         copy_m4_m3(dst_mat, dst_rot);
206
207         /* Apply translation */
208         switch(mode) {
209         case ABC_ZUP_FROM_YUP:
210                 copy_zup_from_yup(dst_mat[3], src_trans);
211                 break;
212         case ABC_YUP_FROM_ZUP:
213                 copy_yup_from_zup(dst_mat[3], src_trans);
214                 break;
215         default:
216                 BLI_assert(false);
217         }
218
219         /* Apply scale matrix. Swaps y and z, but does not
220          * negate like translation does. */
221         dst_scale[0] = src_scale[0];
222         dst_scale[1] = src_scale[2];
223         dst_scale[2] = src_scale[1];
224
225         size_to_mat4(dst_scale_mat, dst_scale);
226         mul_m4_m4m4(dst_mat, dst_mat, dst_scale_mat);
227 }
228
229 void convert_matrix(const Imath::M44d &xform, Object *ob,
230                     float r_mat[4][4], float scale, bool has_alembic_parent)
231 {
232         for (int i = 0; i < 4; ++i) {
233                 for (int j = 0; j < 4; ++j) {
234                         r_mat[i][j] = static_cast<float>(xform[i][j]);
235                 }
236         }
237
238         if (ob->type == OB_CAMERA) {
239                 float cam_to_yup[4][4];
240                 axis_angle_to_mat4_single(cam_to_yup, 'X', M_PI_2);
241                 mul_m4_m4m4(r_mat, r_mat, cam_to_yup);
242         }
243
244         copy_m44_axis_swap(r_mat, r_mat, ABC_ZUP_FROM_YUP);
245
246         if (!has_alembic_parent) {
247                 /* Only apply scaling to root objects, parenting will propagate it. */
248                 float scale_mat[4][4];
249                 scale_m4_fl(scale_mat, scale);
250                 mul_m4_m4m4(r_mat, r_mat, scale_mat);
251                 mul_v3_fl(r_mat[3], scale);
252         }
253 }
254
255 /* Recompute transform matrix of object in new coordinate system
256  * (from Z-Up to Y-Up). */
257 void create_transform_matrix(Object *obj, float yup_mat[4][4])
258 {
259         float zup_mat[4][4];
260
261         /* get local matrix. */
262         /* TODO Sybren: when we're exporting as "flat", i.e. non-hierarchial,
263          * we should export the world matrix even when the object has a parent
264          * Blender Object. */
265         if (obj->parent) {
266                 /* Note that this produces another matrix than the local matrix, due to
267                  * constraints and modifiers as well as the obj->parentinv matrix. */
268                 invert_m4_m4(obj->parent->imat, obj->parent->obmat);
269                 mul_m4_m4m4(zup_mat, obj->parent->imat, obj->obmat);
270         }
271         else {
272                 copy_m4_m4(zup_mat, obj->obmat);
273         }
274
275
276         copy_m44_axis_swap(yup_mat, zup_mat, ABC_YUP_FROM_ZUP);
277 }
278
279 bool has_property(const Alembic::Abc::ICompoundProperty &prop, const std::string &name)
280 {
281         if (!prop.valid()) {
282                 return false;
283         }
284
285         return prop.getPropertyHeader(name) != NULL;
286 }
287
288 typedef std::pair<Alembic::AbcCoreAbstract::index_t, float> index_time_pair_t;
289
290 float get_weight_and_index(float time,
291                            const Alembic::AbcCoreAbstract::TimeSamplingPtr &time_sampling,
292                            int samples_number,
293                            Alembic::AbcGeom::index_t &i0,
294                            Alembic::AbcGeom::index_t &i1)
295 {
296         samples_number = std::max(samples_number, 1);
297
298         index_time_pair_t t0 = time_sampling->getFloorIndex(time, samples_number);
299         i0 = i1 = t0.first;
300
301         if (samples_number == 1 || (fabs(time - t0.second) < 0.0001f)) {
302                 return 0.0f;
303         }
304
305         index_time_pair_t t1 = time_sampling->getCeilIndex(time, samples_number);
306         i1 = t1.first;
307
308         if (i0 == i1) {
309                 return 0.0f;
310         }
311
312         const float bias = (time - t0.second) / (t1.second - t0.second);
313
314         if (fabs(1.0f - bias) < 0.0001f) {
315                 i0 = i1;
316                 return 0.0f;
317         }
318
319         return bias;
320 }
321
322 //#define USE_NURBS
323
324 AbcObjectReader *create_reader(const Alembic::AbcGeom::IObject &object, ImportSettings &settings)
325 {
326         AbcObjectReader *reader = NULL;
327
328         const Alembic::AbcGeom::MetaData &md = object.getMetaData();
329
330         if (Alembic::AbcGeom::IXform::matches(md)) {
331                 reader = new AbcEmptyReader(object, settings);
332         }
333         else if (Alembic::AbcGeom::IPolyMesh::matches(md)) {
334                 reader = new AbcMeshReader(object, settings);
335         }
336         else if (Alembic::AbcGeom::ISubD::matches(md)) {
337                 reader = new AbcSubDReader(object, settings);
338         }
339         else if (Alembic::AbcGeom::INuPatch::matches(md)) {
340 #ifdef USE_NURBS
341                 /* TODO(kevin): importing cyclic NURBS from other software crashes
342                  * at the moment. This is due to the fact that NURBS in other
343                  * software have duplicated points which causes buffer overflows in
344                  * Blender. Need to figure out exactly how these points are
345                  * duplicated, in all cases (cyclic U, cyclic V, and cyclic UV).
346                  * Until this is fixed, disabling NURBS reading. */
347                 reader = new AbcNurbsReader(child, settings);
348 #endif
349         }
350         else if (Alembic::AbcGeom::ICamera::matches(md)) {
351                 reader = new AbcCameraReader(object, settings);
352         }
353         else if (Alembic::AbcGeom::IPoints::matches(md)) {
354                 reader = new AbcPointsReader(object, settings);
355         }
356         else if (Alembic::AbcMaterial::IMaterial::matches(md)) {
357                 /* Pass for now. */
358         }
359         else if (Alembic::AbcGeom::ILight::matches(md)) {
360                 /* Pass for now. */
361         }
362         else if (Alembic::AbcGeom::IFaceSet::matches(md)) {
363                 /* Pass, those are handled in the mesh reader. */
364         }
365         else if (Alembic::AbcGeom::ICurves::matches(md)) {
366                 reader = new AbcCurveReader(object, settings);
367         }
368         else {
369                 std::cerr << "Alembic: unknown how to handle objects of schema "
370                           << md.get("schemaObjTitle")
371                           << ", skipping object "
372                           << object.getFullName() << std::endl;
373         }
374
375         return reader;
376 }
377
378 /* ********************** */
379
380 ScopeTimer::ScopeTimer(const char *message)
381         : m_message(message)
382         , m_start(PIL_check_seconds_timer())
383 {}
384
385 ScopeTimer::~ScopeTimer()
386 {
387         fprintf(stderr, "%s: %fs\n", m_message, PIL_check_seconds_timer() - m_start);
388 }
389
390 /* ********************** */
391
392 bool SimpleLogger::empty()
393 {
394         return ((size_t)m_stream.tellp()) == 0ul;
395 }
396
397 std::string SimpleLogger::str() const
398 {
399         return m_stream.str();
400 }
401
402 void SimpleLogger::clear()
403 {
404         m_stream.clear();
405         m_stream.str("");
406 }
407
408 std::ostringstream &SimpleLogger::stream()
409 {
410         return m_stream;
411 }
412
413 std::ostream &operator<<(std::ostream &os, const SimpleLogger &logger)
414 {
415         os << logger.str();
416         return os;
417 }