Berserk
ResourceImporter.hpp
Go to the documentation of this file.
1 /**********************************************************************************/
2 /* This file is part of Berserk Engine project */
3 /* https://github.com/EgorOrachyov/Berserk */
4 /**********************************************************************************/
5 /* MIT License */
6 /* */
7 /* Copyright (c) 2018 - 2021 Egor Orachyov */
8 /* */
9 /* Permission is hereby granted, free of charge, to any person obtaining a copy */
10 /* of this software and associated documentation files (the "Software"), to deal */
11 /* in the Software without restriction, including without limitation the rights */
12 /* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell */
13 /* copies of the Software, and to permit persons to whom the Software is */
14 /* furnished to do so, subject to the following conditions: */
15 /* */
16 /* The above copyright notice and this permission notice shall be included in all */
17 /* copies or substantial portions of the Software. */
18 /* */
19 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR */
20 /* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, */
21 /* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE */
22 /* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER */
23 /* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, */
24 /* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE */
25 /* SOFTWARE. */
26 /**********************************************************************************/
27 
28 #ifndef BERSERK_RESOURCEIMPORTER_HPP
29 #define BERSERK_RESOURCEIMPORTER_HPP
30 
31 #include <core/Config.hpp>
32 #include <core/Typedefs.hpp>
33 #include <resource/Resource.hpp>
34 
35 #include <vector>
36 
38 
48 class ResourceImportOptions : public RefCnt {
49 public:
50  BRK_API ~ResourceImportOptions() override = default;
51 };
52 
58  bool failed = false;
61  std::vector<Ref<Resource>> resources;
62 };
63 
69 public:
70  BRK_API virtual ~ResourceImporter() = default;
71 
78 
84  BRK_API virtual const std::vector<String> &GetSupportedExtensions() const = 0;
85 
93  BRK_API virtual void Import(const String &fullpath, const Ref<ResourceImportOptions> &options, ResourceImportResult &result) = 0;
94 };
95 
101 
102 #endif//BERSERK_RESOURCEIMPORTER_HPP
#define BRK_NS_END
Definition: Config.hpp:48
#define BRK_API
Definition: Config.hpp:32
Reference counted base object.
Definition: RefCnt.hpp:52
Base class for import options to import specific resource.
Definition: ResourceImporter.hpp:48
BRK_API ~ResourceImportOptions() override=default
Base class responsible for importing a specific resource type.
Definition: ResourceImporter.hpp:68
virtual BRK_API void Import(const String &fullpath, const Ref< ResourceImportOptions > &options, ResourceImportResult &result)=0
Imports resource or set of resources.
virtual BRK_API Ref< ResourceImportOptions > CreateDefaultOptions() const =0
Creates default importer options for import.
virtual BRK_API ~ResourceImporter()=default
virtual BRK_API const std::vector< String > & GetSupportedExtensions() const =0
Get list of supported file extensions for import.
Utf-8 encoded std based default string class.
Definition: GLDevice.cpp:46
Data returned after resource.
Definition: ResourceImporter.hpp:57
std::vector< Ref< Resource > > resources
Definition: ResourceImporter.hpp:61
String error
Definition: ResourceImporter.hpp:59
Ref< Resource > resource
Definition: ResourceImporter.hpp:60
bool failed
Definition: ResourceImporter.hpp:58