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