diff options
author | Campbell Barton <campbell@blender.org> | 2022-04-05 00:44:36 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-04-05 00:49:36 +0300 |
commit | 744369c1144ec4c4685732e6fb06ba7b9513de41 (patch) | |
tree | 88576f816d27f989d9a851e2c564eaa6410cfcc0 /source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh | |
parent | 22184f3aeef6181dd755579753ea6c92b2117578 (diff) |
Cleanup: move doc-strings into headers
- The comment for create_normals was moved into an inline note
as it's not related to the public API.
- Use a colon after parameters.
Ref T92709
Diffstat (limited to 'source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh')
-rw-r--r-- | source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh b/source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh index c8d8b78fc0e..24d026d75e5 100644 --- a/source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh +++ b/source/blender/io/wavefront_obj/importer/obj_import_file_reader.hh @@ -22,10 +22,20 @@ class OBJParser { Vector<std::string> mtl_libraries_; public: + /** + * Open OBJ file at the path given in import parameters. + */ OBJParser(const OBJImportParams &import_params); + /** + * Read the OBJ file line by line and create OBJ Geometry instances. Also store all the vertex + * and UV vertex coordinates in a struct accessible by all objects. + */ void parse(Vector<std::unique_ptr<Geometry>> &r_all_geometries, GlobalVertices &r_global_vertices); + /** + * Return a list of all material library filepaths referenced by the OBJ file. + */ Span<std::string> mtl_libraries() const; }; @@ -144,8 +154,14 @@ class MTLParser { blender::fstream mtl_file_; public: + /** + * Open material library file. + */ MTLParser(StringRef mtl_library_, StringRefNull obj_filepath); + /** + * Read MTL file(s) and add MTLMaterial instances to the given Map reference. + */ void parse_and_store(Map<std::string, std::unique_ptr<MTLMaterial>> &r_mtl_materials); }; } // namespace blender::io::obj |