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