Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / collada / MeshImporter.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 \ingroup collada
18  */
19
20 #ifndef __MESHIMPORTER_H__
21 #define __MESHIMPORTER_H__
22
23 #include <map>
24 #include <vector>
25
26 #include "COLLADAFWIndexList.h"
27 #include "COLLADAFWPolygons.h"
28 #include "COLLADAFWInstanceGeometry.h"
29 #include "COLLADAFWMaterialBinding.h"
30 #include "COLLADAFWMesh.h"
31 #include "COLLADAFWMeshVertexData.h"
32 #include "COLLADAFWNode.h"
33 #include "COLLADAFWTextureCoordinateBinding.h"
34 #include "COLLADAFWTypes.h"
35 #include "COLLADAFWUniqueId.h"
36
37 #include "ArmatureImporter.h"
38 #include "collada_utils.h"
39
40 extern "C" {
41 #include "BLI_edgehash.h"
42 #include "DNA_material_types.h"
43 #include "DNA_mesh_types.h"
44 #include "DNA_meshdata_types.h"
45 #include "DNA_object_types.h"
46 #include "DNA_scene_types.h"
47
48 }
49
50 // only for ArmatureImporter to "see" MeshImporter::get_object_by_geom_uid
51 class MeshImporterBase
52 {
53 public:
54         virtual Object *get_object_by_geom_uid(const COLLADAFW::UniqueId& geom_uid) = 0;
55         virtual Mesh *get_mesh_by_geom_uid(const COLLADAFW::UniqueId& mesh_uid) = 0;
56         virtual std::string *get_geometry_name(const std::string &mesh_name) = 0;
57 };
58
59 class UVDataWrapper
60 {
61         COLLADAFW::MeshVertexData *mVData;
62 public:
63         UVDataWrapper(COLLADAFW::MeshVertexData& vdata);
64
65 #ifdef COLLADA_DEBUG
66         void print();
67 #endif
68
69         void getUV(int uv_index, float *uv);
70 };
71
72 class VCOLDataWrapper
73 {
74         COLLADAFW::MeshVertexData *mVData;
75 public:
76         VCOLDataWrapper(COLLADAFW::MeshVertexData& vdata);
77         void get_vcol(int v_index, MLoopCol *mloopcol);
78 };
79
80 class MeshImporter : public MeshImporterBase
81 {
82 private:
83
84         UnitConverter *unitconverter;
85
86         Main *m_bmain;
87         Scene *scene;
88         ViewLayer *view_layer;
89
90         ArmatureImporter *armature_importer;
91
92         std::map<std::string, std::string> mesh_geom_map; // needed for correct shape key naming
93         std::map<COLLADAFW::UniqueId, Mesh*> uid_mesh_map; // geometry unique id-to-mesh map
94         std::map<COLLADAFW::UniqueId, Object*> uid_object_map; // geom uid-to-object
95         std::vector<Object*> imported_objects; // list of imported objects
96
97         // this structure is used to assign material indices to polygons
98         // it holds a portion of Mesh faces and corresponds to a DAE primitive list (<triangles>, <polylist>, etc.)
99         struct Primitive {
100                 MPoly *mpoly;
101                 unsigned int totpoly;
102         };
103         typedef std::map<COLLADAFW::MaterialId, std::vector<Primitive> > MaterialIdPrimitiveArrayMap;
104         std::map<COLLADAFW::UniqueId, MaterialIdPrimitiveArrayMap> geom_uid_mat_mapping_map; // crazy name!
105         std::multimap<COLLADAFW::UniqueId, COLLADAFW::UniqueId> materials_mapped_to_geom; //< materials that have already been mapped to a geometry. A pair of geom uid and mat uid, one geometry can have several materials
106
107         bool set_poly_indices(MPoly *mpoly,
108                                                   MLoop *mloop,
109                                                   int loop_index,
110                                                   unsigned int *indices,
111                                                   int loop_count);
112
113         void set_face_uv(MLoopUV *mloopuv,
114                                          UVDataWrapper &uvs,
115                                          int loop_index,
116                                          COLLADAFW::IndexList& index_list,
117                                          int count);
118
119         void set_vcol(MLoopCol *mloopcol,
120                           VCOLDataWrapper &vob,
121                           int loop_index,
122                           COLLADAFW::IndexList& index_list,
123                           int count);
124
125 #ifdef COLLADA_DEBUG
126         void print_index_list(COLLADAFW::IndexList& index_list);
127 #endif
128
129         bool is_nice_mesh(COLLADAFW::Mesh *mesh);
130
131         void read_vertices(COLLADAFW::Mesh *mesh, Mesh *me);
132
133         bool primitive_has_useable_normals(COLLADAFW::MeshPrimitive *mp);
134         bool primitive_has_faces(COLLADAFW::MeshPrimitive *mp);
135
136         static void mesh_add_edges(Mesh *mesh, int len);
137
138         unsigned int get_loose_edge_count(COLLADAFW::Mesh *mesh);
139
140         CustomData create_edge_custom_data(EdgeHash *eh);
141
142         void allocate_poly_data(COLLADAFW::Mesh *collada_mesh, Mesh *me);
143
144         // TODO: import uv set names
145         void read_polys(COLLADAFW::Mesh *mesh, Mesh *me);
146         void read_lines(COLLADAFW::Mesh *mesh, Mesh *me);
147         unsigned int get_vertex_count(COLLADAFW::Polygons *mp, int index);
148
149         void get_vector(float v[3], COLLADAFW::MeshVertexData& arr, int i, int stride);
150
151         bool is_flat_face(unsigned int *nind, COLLADAFW::MeshVertexData& nor, int count);
152
153         std::vector<Object *> get_all_users_of(Mesh *reference_mesh);
154
155 public:
156
157         MeshImporter(UnitConverter *unitconv, ArmatureImporter *arm, Main *bmain, Scene *sce, ViewLayer *view_layer);
158
159         virtual Object *get_object_by_geom_uid(const COLLADAFW::UniqueId& geom_uid);
160
161         virtual Mesh *get_mesh_by_geom_uid(const COLLADAFW::UniqueId& geom_uid);
162
163         void optimize_material_assignements();
164
165         void assign_material_to_geom(
166                 COLLADAFW::MaterialBinding cmaterial,
167                 std::map<COLLADAFW::UniqueId, Material*>& uid_material_map,
168                 Object *ob, const COLLADAFW::UniqueId *geom_uid,
169                 short mat_index);
170
171
172         Object *create_mesh_object(COLLADAFW::Node *node, COLLADAFW::InstanceGeometry *geom,
173                                    bool isController,
174                                    std::map<COLLADAFW::UniqueId, Material*>& uid_material_map);
175
176         // create a mesh storing a pointer in a map so it can be retrieved later by geometry UID
177         bool write_geometry(const COLLADAFW::Geometry* geom);
178         std::string *get_geometry_name(const std::string &mesh_name);
179 };
180
181 #endif