Merge branch 'blender2.7'
[blender.git] / source / blender / collada / collada_utils.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): Chingiz Dyussenov, Arystanbek Dyussenov, Nathan Letwory.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file collada_utils.h
24  *  \ingroup collada
25  */
26
27 #ifndef __COLLADA_UTILS_H__
28 #define __COLLADA_UTILS_H__
29
30 #include "COLLADAFWMeshPrimitive.h"
31 #include "COLLADAFWGeometry.h"
32 #include "COLLADAFWFloatOrDoubleArray.h"
33 #include "COLLADAFWTypes.h"
34 #include "COLLADASWEffectProfile.h"
35 #include "COLLADAFWColorOrTexture.h"
36
37
38 #include <vector>
39 #include <map>
40 #include <set>
41 #include <algorithm>
42
43 extern "C" {
44 #include "DNA_object_types.h"
45 #include "DNA_anim_types.h"
46 #include "DNA_constraint_types.h"
47 #include "DNA_mesh_types.h"
48 #include "DNA_lamp_types.h"
49 #include "DNA_camera_types.h"
50
51 #include "DNA_customdata_types.h"
52 #include "DNA_texture_types.h"
53 #include "DNA_scene_types.h"
54
55 #include "RNA_access.h"
56
57 #include "BLI_linklist.h"
58 #include "BLI_utildefines.h"
59 #include "BLI_string.h"
60
61 #include "BKE_main.h"
62 #include "BKE_context.h"
63 #include "BKE_object.h"
64 #include "BKE_scene.h"
65 #include "BKE_idprop.h"
66 #include "BKE_node.h"
67 }
68
69 #include "DEG_depsgraph_query.h"
70
71 #include "ImportSettings.h"
72 #include "ExportSettings.h"
73 #include "collada_internal.h"
74 #include "BCSampleData.h"
75 #include "BlenderContext.h"
76
77 constexpr int LIMITTED_PRECISION = 6;
78
79 struct Depsgraph;
80
81 typedef std::map<COLLADAFW::UniqueId, Image*> UidImageMap;
82 typedef std::map<std::string, Image*> KeyImageMap;
83 typedef std::map<COLLADAFW::TextureMapId, std::vector<MTex *> > TexIndexTextureArrayMap;
84 typedef std::set<Object *> BCObjectSet;
85
86 extern void bc_update_scene(BlenderContext &blender_context, float ctime);
87
88 /* Action helpers */
89
90 std::vector<bAction *> bc_getSceneActions(const bContext *C, Object *ob, bool all_actions);
91
92 /* Action helpers */
93
94 inline bAction *bc_getSceneObjectAction(Object *ob)
95 {
96         return (ob->adt && ob->adt->action) ? ob->adt->action : NULL;
97 }
98
99 /* Returns Lamp Action or NULL */
100 inline bAction *bc_getSceneLampAction(Object *ob)
101 {
102         if (ob->type != OB_LAMP)
103                 return NULL;
104
105         Lamp *lamp = (Lamp *)ob->data;
106         return (lamp->adt && lamp->adt->action) ? lamp->adt->action : NULL;
107 }
108
109 /* Return Camera Action or NULL */
110 inline bAction *bc_getSceneCameraAction(Object *ob)
111 {
112         if (ob->type != OB_CAMERA)
113                 return NULL;
114
115         Camera *camera = (Camera *)ob->data;
116         return (camera->adt && camera->adt->action) ? camera->adt->action : NULL;
117 }
118
119 /* returns material action or NULL */
120 inline bAction *bc_getSceneMaterialAction(Material *ma)
121 {
122         if (ma == NULL)
123                 return NULL;
124
125         return (ma->adt && ma->adt->action) ? ma->adt->action : NULL;
126 }
127
128 inline void bc_setSceneObjectAction(bAction *action, Object *ob)
129 {
130         if (ob->adt)
131                 ob->adt->action = action;
132 }
133
134 std::string bc_get_action_id(std::string action_name, std::string ob_name, std::string channel_type, std::string axis_name, std::string axis_separator = "_");
135
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 void bc_get_children(std::vector<Object *> &child_set, Object *ob, ViewLayer *view_layer);
141 extern bool bc_validateConstraints(bConstraint *con);
142
143 extern int bc_set_parent(Object *ob, Object *par, bContext *C, bool is_parent_space = true);
144 extern Object *bc_add_object(Main *bmain, Scene *scene, ViewLayer *view_layer, int type, const char *name);
145 extern Mesh *bc_get_mesh_copy(
146         BlenderContext &blender_context, Object *ob, BC_export_mesh_type export_mesh_type, bool apply_modifiers, 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()) return false;
187         return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
188 }
189 #endif
190
191 extern std::string bc_replace_string(std::string data, const std::string& pattern, const std::string& replacement);
192 extern std::string bc_url_encode(std::string data);
193 extern void bc_match_scale(Object *ob, UnitConverter &bc_unit, bool scale_to_scene);
194 extern void bc_match_scale(std::vector<Object *> *objects_done, UnitConverter &unit_converter, bool scale_to_scene);
195
196 extern void bc_decompose(float mat[4][4], float *loc, float eul[3], float quat[4], float *size);
197 extern void bc_rotate_from_reference_quat(float quat_to[4], float quat_from[4], float mat_to[4][4]);
198
199 extern void bc_triangulate_mesh(Mesh *me);
200 extern bool bc_is_leaf_bone(Bone *bone);
201 extern EditBone *bc_get_edit_bone(bArmature * armature, char *name);
202 extern int bc_set_layer(int bitfield, int layer, bool enable);
203 extern int bc_set_layer(int bitfield, int layer);
204
205 inline bool bc_in_range(float a, float b, float range) {
206         return fabsf(a - b) < range;
207 }
208 void bc_copy_m4_farray(float r[4][4], float *a);
209 void bc_copy_farray_m4(float *r, float a[4][4]);
210 void bc_copy_darray_m4d(double *r, double a[4][4]);
211 void bc_copy_m4d_v44(double(&r)[4][4], std::vector<std::vector<double>> &a);
212 void bc_copy_v44_m4d(std::vector<std::vector<double>> &a, double(&r)[4][4]);
213
214 void bc_sanitize_mat(float mat[4][4], int precision);
215 void bc_sanitize_mat(double mat[4][4], int precision);
216 void bc_sanitize_v3(double v[3], int precision);
217 void bc_sanitize_v3(float v[3], int precision);
218
219 extern IDProperty *bc_get_IDProperty(Bone *bone, std::string key);
220 extern void bc_set_IDProperty(EditBone *ebone, const char *key, float value);
221 extern void bc_set_IDPropertyMatrix(EditBone *ebone, const char *key, float mat[4][4]);
222
223 extern float bc_get_property(Bone *bone, std::string key, float def);
224 extern void bc_get_property_vector(Bone *bone, std::string key, float val[3], const float def[3]);
225 extern bool bc_get_property_matrix(Bone *bone, std::string key, float mat[4][4]);
226
227 extern void bc_enable_fcurves(bAction *act, char *bone_name);
228 extern bool bc_bone_matrix_local_get(Object *ob, Bone *bone, Matrix &mat, bool for_opensim);
229 extern bool bc_is_animated(BCMatrixSampleMap &values);
230 extern bool bc_has_animations(Scene *sce, LinkNode &node);
231 extern bool bc_has_animations(Object *ob);
232
233
234 extern void bc_create_restpose_mat(const ExportSettings *export_settings, Bone *bone, float to_mat[4][4], float world[4][4], bool use_local_space);
235
236 class BCPolygonNormalsIndices
237 {
238         std::vector<unsigned int> normal_indices;
239
240         public:
241
242         void add_index(unsigned int index) {
243                 normal_indices.push_back(index);
244         }
245
246         unsigned int operator[](unsigned int i) {
247                 return normal_indices[i];
248         }
249
250 };
251
252 class BoneExtended {
253
254 private:
255         char  name[MAXBONENAME];
256         int   chain_length;
257         bool  is_leaf;
258         float tail[3];
259         float roll;
260
261         int   bone_layers;
262         int   use_connect;
263         bool  has_custom_tail;
264         bool  has_custom_roll;
265
266 public:
267
268         BoneExtended(EditBone *aBone);
269
270         void set_name(char *aName);
271         char *get_name();
272
273         void set_chain_length(const int aLength);
274         int  get_chain_length();
275
276         void set_leaf_bone(bool state);
277         bool is_leaf_bone();
278
279         void set_bone_layers(std::string layers, std::vector<std::string> &layer_labels);
280         int get_bone_layers();
281         static std::string get_bone_layers(int bitfield);
282
283         void set_roll(float roll);
284         bool has_roll();
285         float get_roll();
286
287         void set_tail(float *vec);
288         float *get_tail();
289         bool has_tail();
290
291         void set_use_connect(int use_connect);
292         int get_use_connect();
293 };
294
295 /* a map to store bone extension maps
296  * std:string     : an armature name
297  * BoneExtended * : a map that contains extra data for bones
298  */
299 typedef std::map<std::string, BoneExtended *> BoneExtensionMap;
300
301 /*
302  * A class to organise bone extendion data for multiple Armatures.
303  * this is needed for the case where a Collada file contains 2 or more
304  * separate armatures.
305  */
306 class BoneExtensionManager {
307 private:
308         std::map<std::string, BoneExtensionMap *> extended_bone_maps;
309
310 public:
311         BoneExtensionMap &getExtensionMap(bArmature *armature);
312         ~BoneExtensionManager();
313 };
314
315 void bc_add_default_shader(bContext *C, Material *ma);
316 bNode *bc_get_master_shader(Material *ma);
317 COLLADASW::ColorOrTexture bc_get_cot(float r, float g, float b, float a);
318 COLLADASW::ColorOrTexture bc_get_base_color(bNode *shader);
319 COLLADASW::ColorOrTexture bc_get_base_color(Material *ma);
320 COLLADASW::ColorOrTexture bc_get_specular_color(bNode *shader);
321 COLLADASW::ColorOrTexture bc_get_specular_color(Material *ma, bool use_fallback);
322
323 #endif