Alembic import: prevent crash when cancelling import.
[blender.git] / source / blender / alembic / intern / abc_util.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): Esteban Tovagliari, Cedric Paille, Kevin Dietrich
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __ABC_UTIL_H__
24 #define __ABC_UTIL_H__
25
26 #include <Alembic/Abc/All.h>
27 #include <Alembic/AbcGeom/All.h>
28
29 #ifdef _MSC_VER
30 #  define ABC_INLINE static __forceinline
31 #else
32 #  define ABC_INLINE static inline
33 #endif
34
35 /**
36  * @brief The CacheReader struct is only used for anonymous pointers,
37  * to interface between C and C++ code. This library only creates
38  * pointers to AbcObjectReader (or subclasses thereof).
39  */
40 struct CacheReader {
41         int unused;
42 };
43
44 using Alembic::Abc::chrono_t;
45
46 class AbcObjectReader;
47 struct ImportSettings;
48
49 struct ID;
50 struct Object;
51
52 std::string get_id_name(const ID * const id);
53 std::string get_id_name(const Object * const ob);
54 std::string get_object_dag_path_name(const Object * const ob, Object *dupli_parent);
55
56 bool object_selected(Object *ob);
57 bool parent_selected(Object *ob);
58
59 Imath::M44d convert_matrix(float mat[4][4]);
60 void create_transform_matrix(Object *obj, float r_transform_mat[4][4]);
61
62 void split(const std::string &s, const char delim, std::vector<std::string> &tokens);
63
64 template<class TContainer>
65 bool begins_with(const TContainer &input, const TContainer &match)
66 {
67         return input.size() >= match.size()
68                 && std::equal(match.begin(), match.end(), input.begin());
69 }
70
71 void convert_matrix(const Imath::M44d &xform, Object *ob, float r_mat[4][4]);
72
73 template <typename Schema>
74 void get_min_max_time_ex(const Schema &schema, chrono_t &min, chrono_t &max)
75 {
76         const Alembic::Abc::TimeSamplingPtr &time_samp = schema.getTimeSampling();
77
78         if (!schema.isConstant()) {
79                 const size_t num_samps = schema.getNumSamples();
80
81                 if (num_samps > 0) {
82                         const chrono_t min_time = time_samp->getSampleTime(0);
83                         min = std::min(min, min_time);
84
85                         const chrono_t max_time = time_samp->getSampleTime(num_samps - 1);
86                         max = std::max(max, max_time);
87                 }
88         }
89 }
90
91 template <typename Schema>
92 void get_min_max_time(const Alembic::AbcGeom::IObject &object, const Schema &schema, chrono_t &min, chrono_t &max)
93 {
94         get_min_max_time_ex(schema, min, max);
95
96         const Alembic::AbcGeom::IObject &parent = object.getParent();
97         if (parent.valid() && Alembic::AbcGeom::IXform::matches(parent.getMetaData())) {
98                 Alembic::AbcGeom::IXform xform(parent, Alembic::AbcGeom::kWrapExisting);
99                 get_min_max_time_ex(xform.getSchema(), min, max);
100         }
101 }
102
103 bool has_property(const Alembic::Abc::ICompoundProperty &prop, const std::string &name);
104
105 float get_weight_and_index(float time,
106                            const Alembic::AbcCoreAbstract::TimeSamplingPtr &time_sampling,
107                            int samples_number,
108                            Alembic::AbcGeom::index_t &i0,
109                            Alembic::AbcGeom::index_t &i1);
110
111 AbcObjectReader *create_reader(const Alembic::AbcGeom::IObject &object, ImportSettings &settings);
112
113 /* ************************** */
114
115 /* TODO(kevin): for now keeping these transformations hardcoded to make sure
116  * everything works properly, and also because Alembic is almost exclusively
117  * used in Y-up software, but eventually they'll be set by the user in the UI
118  * like other importers/exporters do, to support other axis. */
119
120 /* Copy from Y-up to Z-up. */
121
122 ABC_INLINE void copy_zup_from_yup(float zup[3], const float yup[3])
123 {
124         const float old_yup1 = yup[1];  /* in case zup == yup */
125         zup[0] = yup[0];
126         zup[1] = -yup[2];
127         zup[2] = old_yup1;
128 }
129
130 ABC_INLINE void copy_zup_from_yup(short zup[3], const short yup[3])
131 {
132         const short old_yup1 = yup[1];  /* in case zup == yup */
133         zup[0] = yup[0];
134         zup[1] = -yup[2];
135         zup[2] = old_yup1;
136 }
137
138 /* Copy from Z-up to Y-up. */
139
140 ABC_INLINE void copy_yup_from_zup(float yup[3], const float zup[3])
141 {
142         const float old_zup1 = zup[1];  /* in case yup == zup */
143         yup[0] = zup[0];
144         yup[1] = zup[2];
145         yup[2] = -old_zup1;
146 }
147
148 ABC_INLINE void copy_yup_from_zup(short yup[3], const short zup[3])
149 {
150         const short old_zup1 = zup[1];  /* in case yup == zup */
151         yup[0] = zup[0];
152         yup[1] = zup[2];
153         yup[2] = -old_zup1;
154 }
155
156 /* Names are given in (dst, src) order, just like
157  * the parameters of copy_m44_axis_swap() */
158 typedef enum {
159         ABC_ZUP_FROM_YUP = 1,
160         ABC_YUP_FROM_ZUP = 2,
161 } AbcAxisSwapMode;
162
163 /* Create a rotation matrix for each axis from euler angles.
164  * Euler angles are swaped to change coordinate system. */
165 void create_swapped_rotation_matrix(
166         float rot_x_mat[3][3], float rot_y_mat[3][3],
167         float rot_z_mat[3][3], const float euler[3],
168         AbcAxisSwapMode mode);
169
170 void copy_m44_axis_swap(float dst_mat[4][4], float src_mat[4][4], AbcAxisSwapMode mode);
171
172 /* *************************** */
173
174 #undef ABC_DEBUG_TIME
175
176 class ScopeTimer {
177         const char *m_message;
178         double m_start;
179
180 public:
181         ScopeTimer(const char *message);
182         ~ScopeTimer();
183 };
184
185 #ifdef ABC_DEBUG_TIME
186 #       define SCOPE_TIMER(message) ScopeTimer prof(message)
187 #else
188 #       define SCOPE_TIMER(message)
189 #endif
190
191 /* *************************** */
192
193 /**
194  * Utility class whose purpose is to more easily log related informations. An
195  * instance of the SimpleLogger can be created in any context, and will hold a
196  * copy of all the strings passed to its output stream.
197  *
198  * Different instances of the class may be accessed from different threads,
199  * although accessing the same instance from different threads will lead to race
200  * conditions.
201  */
202 class SimpleLogger {
203         std::ostringstream m_stream;
204
205 public:
206         /**
207          * Check whether or not the SimpleLogger's stream is empty.
208          */
209         bool empty();
210
211         /**
212          * Return a copy of the string contained in the SimpleLogger's stream.
213          */
214         std::string str() const;
215
216         /**
217          * Remove the bits set on the SimpleLogger's stream and clear its string.
218          */
219         void clear();
220
221         /**
222          * Return a reference to the SimpleLogger's stream, in order to e.g. push
223          * content into it.
224          */
225         std::ostringstream &stream();
226 };
227
228 #define ABC_LOG(logger) logger.stream()
229
230 /**
231  * Pass the content of the logger's stream to the specified std::ostream.
232  */
233 std::ostream &operator<<(std::ostream &os, const SimpleLogger &logger);
234
235 #endif  /* __ABC_UTIL_H__ */