Cleanup: remove redundant preference check
[blender.git] / source / blender / collada / collada_utils.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup collada
19  */
20
21 #ifndef __COLLADA_UTILS_H__
22 #define __COLLADA_UTILS_H__
23
24 #include "COLLADAFWMeshPrimitive.h"
25 #include "COLLADAFWGeometry.h"
26 #include "COLLADAFWFloatOrDoubleArray.h"
27 #include "COLLADAFWTypes.h"
28 #include "COLLADASWEffectProfile.h"
29 #include "COLLADAFWColorOrTexture.h"
30
31 #include <vector>
32 #include <map>
33 #include <set>
34 #include <algorithm>
35
36 extern "C" {
37 #include "DNA_object_types.h"
38 #include "DNA_anim_types.h"
39 #include "DNA_constraint_types.h"
40 #include "DNA_mesh_types.h"
41 #include "DNA_light_types.h"
42 #include "DNA_camera_types.h"
43
44 #include "DNA_customdata_types.h"
45 #include "DNA_texture_types.h"
46 #include "DNA_scene_types.h"
47
48 #include "RNA_access.h"
49
50 #include "BLI_linklist.h"
51 #include "BLI_utildefines.h"
52 #include "BLI_string.h"
53
54 #include "BKE_main.h"
55 #include "BKE_context.h"
56 #include "BKE_object.h"
57 #include "BKE_scene.h"
58 #include "BKE_idprop.h"
59 #include "BKE_node.h"
60 }
61
62 #include "DEG_depsgraph_query.h"
63
64 #include "ImportSettings.h"
65 #include "ExportSettings.h"
66 #include "collada_internal.h"
67 #include "BCSampleData.h"
68 #include "BlenderContext.h"
69
70 constexpr int LIMITTED_PRECISION = 6;
71
72 struct Depsgraph;
73
74 typedef std::map<COLLADAFW::UniqueId, Image *> UidImageMap;
75 typedef std::map<std::string, Image *> KeyImageMap;
76 typedef std::map<COLLADAFW::TextureMapId, std::vector<MTex *>> TexIndexTextureArrayMap;
77 typedef std::set<Object *> BCObjectSet;
78
79 extern void bc_update_scene(BlenderContext &blender_context, float ctime);
80
81 /* Action helpers */
82
83 std::vector<bAction *> bc_getSceneActions(const bContext *C, Object *ob, bool all_actions);
84
85 /* Action helpers */
86
87 inline bAction *bc_getSceneObjectAction(Object *ob)
88 {
89   return (ob->adt && ob->adt->action) ? ob->adt->action : NULL;
90 }
91
92 /* Returns Light Action or NULL */
93 inline bAction *bc_getSceneLightAction(Object *ob)
94 {
95   if (ob->type != OB_LAMP) {
96     return NULL;
97   }
98
99   Light *lamp = (Light *)ob->data;
100   return (lamp->adt && lamp->adt->action) ? lamp->adt->action : NULL;
101 }
102
103 /* Return Camera Action or NULL */
104 inline bAction *bc_getSceneCameraAction(Object *ob)
105 {
106   if (ob->type != OB_CAMERA) {
107     return NULL;
108   }
109
110   Camera *camera = (Camera *)ob->data;
111   return (camera->adt && camera->adt->action) ? camera->adt->action : NULL;
112 }
113
114 /* returns material action or NULL */
115 inline bAction *bc_getSceneMaterialAction(Material *ma)
116 {
117   if (ma == NULL) {
118     return NULL;
119   }
120
121   return (ma->adt && ma->adt->action) ? ma->adt->action : NULL;
122 }
123
124 inline void bc_setSceneObjectAction(bAction *action, Object *ob)
125 {
126   if (ob->adt) {
127     ob->adt->action = action;
128   }
129 }
130
131 std::string bc_get_action_id(std::string action_name,
132                              std::string ob_name,
133                              std::string channel_type,
134                              std::string axis_name,
135                              std::string axis_separator = "_");
136
137 extern float bc_get_float_value(const COLLADAFW::FloatOrDoubleArray &array, unsigned int index);
138 extern int bc_test_parent_loop(Object *par, Object *ob);
139
140 extern bool bc_validateConstraints(bConstraint *con);
141
142 bool bc_set_parent(Object *ob, Object *par, bContext *C, bool is_parent_space = true);
143 extern Object *bc_add_object(
144     Main *bmain, Scene *scene, ViewLayer *view_layer, int type, const char *name);
145 extern Mesh *bc_get_mesh_copy(BlenderContext &blender_context,
146                               Object *ob,
147                               BC_export_mesh_type export_mesh_type,
148                               bool apply_modifiers,
149                               bool triangulate);
150
151 extern Object *bc_get_assigned_armature(Object *ob);
152 extern bool bc_has_object_type(LinkNode *export_set, short obtype);
153
154 extern char *bc_CustomData_get_layer_name(const CustomData *data, int type, int n);
155 extern char *bc_CustomData_get_active_layer_name(const CustomData *data, int type);
156
157 extern void bc_bubble_sort_by_Object_name(LinkNode *export_set);
158 extern bool bc_is_root_bone(Bone *aBone, bool deform_bones_only);
159 extern int bc_get_active_UVLayer(Object *ob);
160
161 std::string bc_find_bonename_in_path(std::string path, std::string probe);
162
163 inline std::string bc_string_after(const std::string &s, const std::string probe)
164 {
165   size_t i = s.rfind(probe);
166   if (i != std::string::npos) {
167     return (s.substr(i + probe.length(), s.length() - i));
168   }
169   return (s);
170 }
171
172 inline std::string bc_string_before(const std::string &s, const std::string probe)
173 {
174   size_t i = s.find(probe);
175   if (i != std::string::npos) {
176     return s.substr(0, i);
177   }
178   return (s);
179 }
180
181 inline bool bc_startswith(std::string const &value, std::string const &starting)
182 {
183   if (starting.size() > value.size()) {
184     return false;
185   }
186   return (value.substr(0, starting.size()) == starting);
187 }
188
189 inline bool bc_endswith(const std::string &value, const std::string &ending)
190 {
191   if (ending.size() > value.size()) {
192     return false;
193   }
194
195   return value.compare(value.size() - ending.size(), ending.size(), ending) == 0;
196 }
197
198 #if 0 /* UNUSED */
199 inline bool bc_endswith(std::string const &value, std::string const &ending)
200 {
201   if (ending.size() > value.size()) {
202     return false;
203   }
204   return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
205 }
206 #endif
207
208 extern std::string bc_replace_string(std::string data,
209                                      const std::string &pattern,
210                                      const std::string &replacement);
211 extern std::string bc_url_encode(std::string data);
212 extern void bc_match_scale(Object *ob, UnitConverter &bc_unit, bool scale_to_scene);
213 extern void bc_match_scale(std::vector<Object *> *objects_done,
214                            UnitConverter &unit_converter,
215                            bool scale_to_scene);
216
217 extern void bc_decompose(float mat[4][4], float *loc, float eul[3], float quat[4], float *size);
218 extern void bc_rotate_from_reference_quat(float quat_to[4],
219                                           float quat_from[4],
220                                           float mat_to[4][4]);
221
222 extern void bc_triangulate_mesh(Mesh *me);
223 extern bool bc_is_leaf_bone(Bone *bone);
224 extern EditBone *bc_get_edit_bone(bArmature *armature, char *name);
225 extern int bc_set_layer(int bitfield, int layer, bool enable);
226 extern int bc_set_layer(int bitfield, int layer);
227
228 inline bool bc_in_range(float a, float b, float range)
229 {
230   return fabsf(a - b) < range;
231 }
232 void bc_copy_m4_farray(float r[4][4], float *a);
233 void bc_copy_farray_m4(float *r, float a[4][4]);
234 void bc_copy_darray_m4d(double *r, double a[4][4]);
235 void bc_copy_m4d_v44(double (&r)[4][4], std::vector<std::vector<double>> &a);
236 void bc_copy_v44_m4d(std::vector<std::vector<double>> &a, double (&r)[4][4]);
237
238 void bc_sanitize_v3(double v[3], int precision);
239 void bc_sanitize_v3(float v[3], int precision);
240
241 extern IDProperty *bc_get_IDProperty(Bone *bone, std::string key);
242 extern void bc_set_IDProperty(EditBone *ebone, const char *key, float value);
243 extern void bc_set_IDPropertyMatrix(EditBone *ebone, const char *key, float mat[4][4]);
244
245 extern float bc_get_property(Bone *bone, std::string key, float def);
246 extern void bc_get_property_vector(Bone *bone, std::string key, float val[3], const float def[3]);
247 extern bool bc_get_property_matrix(Bone *bone, std::string key, float mat[4][4]);
248
249 extern void bc_enable_fcurves(bAction *act, char *bone_name);
250 extern bool bc_bone_matrix_local_get(Object *ob, Bone *bone, Matrix &mat, bool for_opensim);
251 extern bool bc_is_animated(BCMatrixSampleMap &values);
252 extern bool bc_has_animations(Scene *sce, LinkNode *node);
253 extern bool bc_has_animations(Object *ob);
254
255 extern void bc_add_global_transform(Matrix &to_mat,
256                                     const Matrix &from_mat,
257                                     const BCMatrix &global_transform,
258                                     const bool invert = false);
259 extern void bc_add_global_transform(Vector &to_vec,
260                                     const Vector &from_vec,
261                                     const BCMatrix &global_transform,
262                                     const bool invert = false);
263 extern void bc_add_global_transform(Vector &to_vec,
264                                     const BCMatrix &global_transform,
265                                     const bool invert = false);
266 extern void bc_add_global_transform(Matrix &to_mat,
267                                     const BCMatrix &global_transform,
268                                     const bool invert = false);
269 extern void bc_apply_global_transform(Matrix &to_mat,
270                                       const BCMatrix &global_transform,
271                                       const bool invert = false);
272 extern void bc_apply_global_transform(Vector &to_vec,
273                                       const BCMatrix &global_transform,
274                                       const bool invert = false);
275 extern void bc_create_restpose_mat(BCExportSettings &export_settings,
276                                    Bone *bone,
277                                    float to_mat[4][4],
278                                    float from_mat[4][4],
279                                    bool use_local_space);
280
281 class ColladaBaseNodes {
282  private:
283   std::vector<Object *> base_objects;
284
285  public:
286   void add(Object *ob)
287   {
288     base_objects.push_back(ob);
289   }
290
291   bool contains(Object *ob)
292   {
293     std::vector<Object *>::iterator it = std::find(base_objects.begin(), base_objects.end(), ob);
294     return (it != base_objects.end());
295   }
296
297   int size()
298   {
299     return base_objects.size();
300   }
301
302   Object *get(int index)
303   {
304     return base_objects[index];
305   }
306 };
307
308 class BCPolygonNormalsIndices {
309   std::vector<unsigned int> normal_indices;
310
311  public:
312   void add_index(unsigned int index)
313   {
314     normal_indices.push_back(index);
315   }
316
317   unsigned int operator[](unsigned int i)
318   {
319     return normal_indices[i];
320   }
321 };
322
323 class BoneExtended {
324
325  private:
326   char name[MAXBONENAME];
327   int chain_length;
328   bool is_leaf;
329   float tail[3];
330   float roll;
331
332   int bone_layers;
333   int use_connect;
334   bool has_custom_tail;
335   bool has_custom_roll;
336
337  public:
338   BoneExtended(EditBone *aBone);
339
340   void set_name(char *aName);
341   char *get_name();
342
343   void set_chain_length(const int aLength);
344   int get_chain_length();
345
346   void set_leaf_bone(bool state);
347   bool is_leaf_bone();
348
349   void set_bone_layers(std::string layers, std::vector<std::string> &layer_labels);
350   int get_bone_layers();
351   static std::string get_bone_layers(int bitfield);
352
353   void set_roll(float roll);
354   bool has_roll();
355   float get_roll();
356
357   void set_tail(float vec[]);
358   float *get_tail();
359   bool has_tail();
360
361   void set_use_connect(int use_connect);
362   int get_use_connect();
363 };
364
365 /* a map to store bone extension maps
366  * std:string     : an armature name
367  * BoneExtended * : a map that contains extra data for bones
368  */
369 typedef std::map<std::string, BoneExtended *> BoneExtensionMap;
370
371 /*
372  * A class to organize bone extension data for multiple Armatures.
373  * this is needed for the case where a Collada file contains 2 or more
374  * separate armatures.
375  */
376 class BoneExtensionManager {
377  private:
378   std::map<std::string, BoneExtensionMap *> extended_bone_maps;
379
380  public:
381   BoneExtensionMap &getExtensionMap(bArmature *armature);
382   ~BoneExtensionManager();
383 };
384
385 void bc_add_default_shader(bContext *C, Material *ma);
386 bNode *bc_get_master_shader(Material *ma);
387
388 COLLADASW::ColorOrTexture bc_get_base_color(Material *ma);
389 COLLADASW::ColorOrTexture bc_get_emission(Material *ma);
390 COLLADASW::ColorOrTexture bc_get_ambient(Material *ma);
391 COLLADASW::ColorOrTexture bc_get_specular(Material *ma);
392 COLLADASW::ColorOrTexture bc_get_reflective(Material *ma);
393
394 double bc_get_reflectivity(Material *ma);
395 double bc_get_alpha(Material *ma);
396 double bc_get_ior(Material *ma);
397 double bc_get_shininess(Material *ma);
398
399 double bc_get_float_from_shader(bNode *shader, double &ior, std::string nodeid);
400 COLLADASW::ColorOrTexture bc_get_cot_from_shader(bNode *shader,
401                                                  std::string nodeid,
402                                                  Color &default_color);
403
404 COLLADASW::ColorOrTexture bc_get_cot(float r, float g, float b, float a);
405 COLLADASW::ColorOrTexture bc_get_cot(Color col);
406
407 #endif