Cleanup: remove redundant, invalid info from headers
[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 collada_utils.h
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
32 #include <vector>
33 #include <map>
34 #include <set>
35 #include <algorithm>
36
37 extern "C" {
38 #include "DNA_object_types.h"
39 #include "DNA_anim_types.h"
40 #include "DNA_constraint_types.h"
41 #include "DNA_mesh_types.h"
42 #include "DNA_lamp_types.h"
43 #include "DNA_camera_types.h"
44
45 #include "DNA_customdata_types.h"
46 #include "DNA_texture_types.h"
47 #include "DNA_scene_types.h"
48
49 #include "RNA_access.h"
50
51 #include "BLI_linklist.h"
52 #include "BLI_utildefines.h"
53 #include "BLI_string.h"
54
55 #include "BKE_main.h"
56 #include "BKE_context.h"
57 #include "BKE_object.h"
58 #include "BKE_scene.h"
59 #include "BKE_idprop.h"
60 #include "BKE_node.h"
61 }
62
63 #include "DEG_depsgraph_query.h"
64
65 #include "ImportSettings.h"
66 #include "ExportSettings.h"
67 #include "collada_internal.h"
68 #include "BCSampleData.h"
69 #include "BlenderContext.h"
70
71 constexpr int LIMITTED_PRECISION = 6;
72
73 struct Depsgraph;
74
75 typedef std::map<COLLADAFW::UniqueId, Image*> UidImageMap;
76 typedef std::map<std::string, Image*> KeyImageMap;
77 typedef std::map<COLLADAFW::TextureMapId, std::vector<MTex *> > TexIndexTextureArrayMap;
78 typedef std::set<Object *> BCObjectSet;
79
80 extern void bc_update_scene(BlenderContext &blender_context, float ctime);
81
82 /* Action helpers */
83
84 std::vector<bAction *> bc_getSceneActions(const bContext *C, Object *ob, bool all_actions);
85
86 /* Action helpers */
87
88 inline bAction *bc_getSceneObjectAction(Object *ob)
89 {
90         return (ob->adt && ob->adt->action) ? ob->adt->action : NULL;
91 }
92
93 /* Returns Lamp Action or NULL */
94 inline bAction *bc_getSceneLampAction(Object *ob)
95 {
96         if (ob->type != OB_LAMP)
97                 return NULL;
98
99         Lamp *lamp = (Lamp *)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         Camera *camera = (Camera *)ob->data;
110         return (camera->adt && camera->adt->action) ? camera->adt->action : NULL;
111 }
112
113 /* returns material action or NULL */
114 inline bAction *bc_getSceneMaterialAction(Material *ma)
115 {
116         if (ma == NULL)
117                 return NULL;
118
119         return (ma->adt && ma->adt->action) ? ma->adt->action : NULL;
120 }
121
122 inline void bc_setSceneObjectAction(bAction *action, Object *ob)
123 {
124         if (ob->adt)
125                 ob->adt->action = action;
126 }
127
128 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 = "_");
129
130
131 extern float bc_get_float_value(const COLLADAFW::FloatOrDoubleArray& array, unsigned int index);
132 extern int bc_test_parent_loop(Object *par, Object *ob);
133
134 extern void bc_get_children(std::vector<Object *> &child_set, Object *ob, ViewLayer *view_layer);
135 extern bool bc_validateConstraints(bConstraint *con);
136
137 extern int bc_set_parent(Object *ob, Object *par, bContext *C, bool is_parent_space = true);
138 extern Object *bc_add_object(Main *bmain, Scene *scene, ViewLayer *view_layer, int type, const char *name);
139 extern Mesh *bc_get_mesh_copy(
140         BlenderContext &blender_context, Object *ob, BC_export_mesh_type export_mesh_type, bool apply_modifiers, bool triangulate);
141
142 extern Object *bc_get_assigned_armature(Object *ob);
143 extern Object *bc_get_highest_selected_ancestor_or_self(LinkNode *export_set, Object *ob);
144 extern bool bc_is_base_node(LinkNode *export_set, Object *ob);
145 extern bool bc_is_in_Export_set(LinkNode *export_set, Object *ob, ViewLayer *view_layer);
146 extern bool bc_has_object_type(LinkNode *export_set, short obtype);
147
148 extern int bc_is_marked(Object *ob);
149 extern void bc_remove_mark(Object *ob);
150 extern void bc_set_mark(Object *ob);
151
152 extern char *bc_CustomData_get_layer_name(const CustomData *data, int type, int n);
153 extern char *bc_CustomData_get_active_layer_name(const CustomData *data, int type);
154
155 extern void bc_bubble_sort_by_Object_name(LinkNode *export_set);
156 extern bool bc_is_root_bone(Bone *aBone, bool deform_bones_only);
157 extern int  bc_get_active_UVLayer(Object *ob);
158
159 std::string bc_find_bonename_in_path(std::string path, std::string probe);
160
161 inline std::string bc_string_after(const std::string& s, const char c)
162 {
163         size_t i = s.rfind(c, s.length());
164         if (i != std::string::npos) {
165                 return(s.substr(i + 1, s.length() - i));
166         }
167         return(s);
168 }
169
170 inline bool bc_startswith(std::string const & value, std::string const & starting)
171 {
172         if (starting.size() > value.size())
173                 return false;
174         return (value.substr(0, starting.size()) == starting);
175 }
176
177 #if 0  /* UNUSED */
178 inline bool bc_endswith(std::string const & value, std::string const & ending)
179 {
180         if (ending.size() > value.size()) return false;
181         return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
182 }
183 #endif
184
185 extern std::string bc_replace_string(std::string data, const std::string& pattern, const std::string& replacement);
186 extern std::string bc_url_encode(std::string data);
187 extern void bc_match_scale(Object *ob, UnitConverter &bc_unit, bool scale_to_scene);
188 extern void bc_match_scale(std::vector<Object *> *objects_done, UnitConverter &unit_converter, bool scale_to_scene);
189
190 extern void bc_decompose(float mat[4][4], float *loc, float eul[3], float quat[4], float *size);
191 extern void bc_rotate_from_reference_quat(float quat_to[4], float quat_from[4], float mat_to[4][4]);
192
193 extern void bc_triangulate_mesh(Mesh *me);
194 extern bool bc_is_leaf_bone(Bone *bone);
195 extern EditBone *bc_get_edit_bone(bArmature * armature, char *name);
196 extern int bc_set_layer(int bitfield, int layer, bool enable);
197 extern int bc_set_layer(int bitfield, int layer);
198
199 inline bool bc_in_range(float a, float b, float range) {
200         return fabsf(a - b) < range;
201 }
202 void bc_copy_m4_farray(float r[4][4], float *a);
203 void bc_copy_farray_m4(float *r, float a[4][4]);
204 void bc_copy_darray_m4d(double *r, double a[4][4]);
205 void bc_copy_m4d_v44(double(&r)[4][4], std::vector<std::vector<double>> &a);
206 void bc_copy_v44_m4d(std::vector<std::vector<double>> &a, double(&r)[4][4]);
207
208 void bc_sanitize_mat(float mat[4][4], int precision);
209 void bc_sanitize_mat(double mat[4][4], int precision);
210 void bc_sanitize_v3(double v[3], int precision);
211 void bc_sanitize_v3(float v[3], int precision);
212
213 extern IDProperty *bc_get_IDProperty(Bone *bone, std::string key);
214 extern void bc_set_IDProperty(EditBone *ebone, const char *key, float value);
215 extern void bc_set_IDPropertyMatrix(EditBone *ebone, const char *key, float mat[4][4]);
216
217 extern float bc_get_property(Bone *bone, std::string key, float def);
218 extern void bc_get_property_vector(Bone *bone, std::string key, float val[3], const float def[3]);
219 extern bool bc_get_property_matrix(Bone *bone, std::string key, float mat[4][4]);
220
221 extern void bc_enable_fcurves(bAction *act, char *bone_name);
222 extern bool bc_bone_matrix_local_get(Object *ob, Bone *bone, Matrix &mat, bool for_opensim);
223 extern bool bc_is_animated(BCMatrixSampleMap &values);
224 extern bool bc_has_animations(Scene *sce, LinkNode &node);
225 extern bool bc_has_animations(Object *ob);
226
227
228 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);
229
230 class BCPolygonNormalsIndices
231 {
232         std::vector<unsigned int> normal_indices;
233
234         public:
235
236         void add_index(unsigned int index) {
237                 normal_indices.push_back(index);
238         }
239
240         unsigned int operator[](unsigned int i) {
241                 return normal_indices[i];
242         }
243
244 };
245
246 class BoneExtended {
247
248 private:
249         char  name[MAXBONENAME];
250         int   chain_length;
251         bool  is_leaf;
252         float tail[3];
253         float roll;
254
255         int   bone_layers;
256         int   use_connect;
257         bool  has_custom_tail;
258         bool  has_custom_roll;
259
260 public:
261
262         BoneExtended(EditBone *aBone);
263
264         void set_name(char *aName);
265         char *get_name();
266
267         void set_chain_length(const int aLength);
268         int  get_chain_length();
269
270         void set_leaf_bone(bool state);
271         bool is_leaf_bone();
272
273         void set_bone_layers(std::string layers, std::vector<std::string> &layer_labels);
274         int get_bone_layers();
275         static std::string get_bone_layers(int bitfield);
276
277         void set_roll(float roll);
278         bool has_roll();
279         float get_roll();
280
281         void set_tail(float *vec);
282         float *get_tail();
283         bool has_tail();
284
285         void set_use_connect(int use_connect);
286         int get_use_connect();
287 };
288
289 /* a map to store bone extension maps
290  * std:string     : an armature name
291  * BoneExtended * : a map that contains extra data for bones
292  */
293 typedef std::map<std::string, BoneExtended *> BoneExtensionMap;
294
295 /*
296  * A class to organise bone extendion data for multiple Armatures.
297  * this is needed for the case where a Collada file contains 2 or more
298  * separate armatures.
299  */
300 class BoneExtensionManager {
301 private:
302         std::map<std::string, BoneExtensionMap *> extended_bone_maps;
303
304 public:
305         BoneExtensionMap &getExtensionMap(bArmature *armature);
306         ~BoneExtensionManager();
307 };
308
309 void bc_add_default_shader(bContext *C, Material *ma);
310 bNode *bc_get_master_shader(Material *ma);
311 COLLADASW::ColorOrTexture bc_get_cot(float r, float g, float b, float a);
312 COLLADASW::ColorOrTexture bc_get_base_color(bNode *shader);
313 COLLADASW::ColorOrTexture bc_get_base_color(Material *ma);
314 COLLADASW::ColorOrTexture bc_get_specular_color(bNode *shader);
315 COLLADASW::ColorOrTexture bc_get_specular_color(Material *ma, bool use_fallback);
316
317 #endif