fix T64873 collada export crashes Blender on Mac
[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   Light *lamp = (Light *)ob->data;
99   return (lamp->adt && lamp->adt->action) ? lamp->adt->action : NULL;
100 }
101
102 /* Return Camera Action or NULL */
103 inline bAction *bc_getSceneCameraAction(Object *ob)
104 {
105   if (ob->type != OB_CAMERA)
106     return NULL;
107
108   Camera *camera = (Camera *)ob->data;
109   return (camera->adt && camera->adt->action) ? camera->adt->action : NULL;
110 }
111
112 /* returns material action or NULL */
113 inline bAction *bc_getSceneMaterialAction(Material *ma)
114 {
115   if (ma == NULL)
116     return NULL;
117
118   return (ma->adt && ma->adt->action) ? ma->adt->action : NULL;
119 }
120
121 inline void bc_setSceneObjectAction(bAction *action, Object *ob)
122 {
123   if (ob->adt)
124     ob->adt->action = action;
125 }
126
127 std::string bc_get_action_id(std::string action_name,
128                              std::string ob_name,
129                              std::string channel_type,
130                              std::string axis_name,
131                              std::string axis_separator = "_");
132
133 extern float bc_get_float_value(const COLLADAFW::FloatOrDoubleArray &array, unsigned int index);
134 extern int bc_test_parent_loop(Object *par, Object *ob);
135
136 extern void bc_get_children(std::vector<Object *> &child_set, Object *ob, ViewLayer *view_layer);
137 extern bool bc_validateConstraints(bConstraint *con);
138
139 extern int bc_set_parent(Object *ob, Object *par, bContext *C, bool is_parent_space = true);
140 extern Object *bc_add_object(
141     Main *bmain, Scene *scene, ViewLayer *view_layer, int type, const char *name);
142 extern Mesh *bc_get_mesh_copy(BlenderContext &blender_context,
143                               Object *ob,
144                               BC_export_mesh_type export_mesh_type,
145                               bool apply_modifiers,
146                               bool triangulate);
147
148 extern Object *bc_get_assigned_armature(Object *ob);
149 extern Object *bc_get_highest_selected_ancestor_or_self(LinkNode *export_set, Object *ob);
150 extern bool bc_is_base_node(LinkNode *export_set, Object *ob);
151 extern bool bc_is_in_Export_set(LinkNode *export_set, Object *ob, ViewLayer *view_layer);
152 extern bool bc_has_object_type(LinkNode *export_set, short obtype);
153
154 extern int bc_is_marked(Object *ob);
155 extern void bc_remove_mark(Object *ob);
156 extern void bc_set_mark(Object *ob);
157
158 extern char *bc_CustomData_get_layer_name(const CustomData *data, int type, int n);
159 extern char *bc_CustomData_get_active_layer_name(const CustomData *data, int type);
160
161 extern void bc_bubble_sort_by_Object_name(LinkNode *export_set);
162 extern bool bc_is_root_bone(Bone *aBone, bool deform_bones_only);
163 extern int bc_get_active_UVLayer(Object *ob);
164
165 std::string bc_find_bonename_in_path(std::string path, std::string probe);
166
167 inline std::string bc_string_after(const std::string &s, const char c)
168 {
169   size_t i = s.rfind(c, s.length());
170   if (i != std::string::npos) {
171     return (s.substr(i + 1, s.length() - i));
172   }
173   return (s);
174 }
175
176 inline bool bc_startswith(std::string const &value, std::string const &starting)
177 {
178   if (starting.size() > value.size())
179     return false;
180   return (value.substr(0, starting.size()) == starting);
181 }
182
183 #if 0 /* UNUSED */
184 inline bool bc_endswith(std::string const &value, std::string const &ending)
185 {
186   if (ending.size() > value.size())
187     return false;
188   return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
189 }
190 #endif
191
192 extern std::string bc_replace_string(std::string data,
193                                      const std::string &pattern,
194                                      const std::string &replacement);
195 extern std::string bc_url_encode(std::string data);
196 extern void bc_match_scale(Object *ob, UnitConverter &bc_unit, bool scale_to_scene);
197 extern void bc_match_scale(std::vector<Object *> *objects_done,
198                            UnitConverter &unit_converter,
199                            bool scale_to_scene);
200
201 extern void bc_decompose(float mat[4][4], float *loc, float eul[3], float quat[4], float *size);
202 extern void bc_rotate_from_reference_quat(float quat_to[4],
203                                           float quat_from[4],
204                                           float mat_to[4][4]);
205
206 extern void bc_triangulate_mesh(Mesh *me);
207 extern bool bc_is_leaf_bone(Bone *bone);
208 extern EditBone *bc_get_edit_bone(bArmature *armature, char *name);
209 extern int bc_set_layer(int bitfield, int layer, bool enable);
210 extern int bc_set_layer(int bitfield, int layer);
211
212 inline bool bc_in_range(float a, float b, float range)
213 {
214   return fabsf(a - b) < range;
215 }
216 void bc_copy_m4_farray(float r[4][4], float *a);
217 void bc_copy_farray_m4(float *r, float a[4][4]);
218 void bc_copy_darray_m4d(double *r, double a[4][4]);
219 void bc_copy_m4d_v44(double (&r)[4][4], std::vector<std::vector<double>> &a);
220 void bc_copy_v44_m4d(std::vector<std::vector<double>> &a, double (&r)[4][4]);
221
222 void bc_sanitize_mat(float mat[4][4], int precision);
223 void bc_sanitize_mat(double mat[4][4], int precision);
224 void bc_sanitize_v3(double v[3], int precision);
225 void bc_sanitize_v3(float v[3], int precision);
226
227 extern IDProperty *bc_get_IDProperty(Bone *bone, std::string key);
228 extern void bc_set_IDProperty(EditBone *ebone, const char *key, float value);
229 extern void bc_set_IDPropertyMatrix(EditBone *ebone, const char *key, float mat[4][4]);
230
231 extern float bc_get_property(Bone *bone, std::string key, float def);
232 extern void bc_get_property_vector(Bone *bone, std::string key, float val[3], const float def[3]);
233 extern bool bc_get_property_matrix(Bone *bone, std::string key, float mat[4][4]);
234
235 extern void bc_enable_fcurves(bAction *act, char *bone_name);
236 extern bool bc_bone_matrix_local_get(Object *ob, Bone *bone, Matrix &mat, bool for_opensim);
237 extern bool bc_is_animated(BCMatrixSampleMap &values);
238 extern bool bc_has_animations(Scene *sce, LinkNode *node);
239 extern bool bc_has_animations(Object *ob);
240
241 extern void bc_create_restpose_mat(const ExportSettings *export_settings,
242                                    Bone *bone,
243                                    float to_mat[4][4],
244                                    float world[4][4],
245                                    bool use_local_space);
246
247 class BCPolygonNormalsIndices {
248   std::vector<unsigned int> normal_indices;
249
250  public:
251   void add_index(unsigned int index)
252   {
253     normal_indices.push_back(index);
254   }
255
256   unsigned int operator[](unsigned int i)
257   {
258     return normal_indices[i];
259   }
260 };
261
262 class BoneExtended {
263
264  private:
265   char name[MAXBONENAME];
266   int chain_length;
267   bool is_leaf;
268   float tail[3];
269   float roll;
270
271   int bone_layers;
272   int use_connect;
273   bool has_custom_tail;
274   bool has_custom_roll;
275
276  public:
277   BoneExtended(EditBone *aBone);
278
279   void set_name(char *aName);
280   char *get_name();
281
282   void set_chain_length(const int aLength);
283   int get_chain_length();
284
285   void set_leaf_bone(bool state);
286   bool is_leaf_bone();
287
288   void set_bone_layers(std::string layers, std::vector<std::string> &layer_labels);
289   int get_bone_layers();
290   static std::string get_bone_layers(int bitfield);
291
292   void set_roll(float roll);
293   bool has_roll();
294   float get_roll();
295
296   void set_tail(float *vec);
297   float *get_tail();
298   bool has_tail();
299
300   void set_use_connect(int use_connect);
301   int get_use_connect();
302 };
303
304 /* a map to store bone extension maps
305  * std:string     : an armature name
306  * BoneExtended * : a map that contains extra data for bones
307  */
308 typedef std::map<std::string, BoneExtended *> BoneExtensionMap;
309
310 /*
311  * A class to organise bone extendion data for multiple Armatures.
312  * this is needed for the case where a Collada file contains 2 or more
313  * separate armatures.
314  */
315 class BoneExtensionManager {
316  private:
317   std::map<std::string, BoneExtensionMap *> extended_bone_maps;
318
319  public:
320   BoneExtensionMap &getExtensionMap(bArmature *armature);
321   ~BoneExtensionManager();
322 };
323
324 void bc_add_default_shader(bContext *C, Material *ma);
325 bNode *bc_get_master_shader(Material *ma);
326 COLLADASW::ColorOrTexture bc_get_cot(float r, float g, float b, float a);
327 COLLADASW::ColorOrTexture bc_get_base_color(bNode *shader);
328 bool bc_get_reflectivity(bNode *shader, double &reflectivity);
329 double bc_get_reflectivity(Material *ma);
330 COLLADASW::ColorOrTexture bc_get_base_color(Material *ma);
331
332 #endif