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