1/**************************************************************************/
2/* editor_import_plugin.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef EDITOR_IMPORT_PLUGIN_H
32#define EDITOR_IMPORT_PLUGIN_H
33
34#include "core/io/resource_importer.h"
35#include "core/variant/typed_array.h"
36
37class EditorImportPlugin : public ResourceImporter {
38 GDCLASS(EditorImportPlugin, ResourceImporter);
39
40protected:
41 static void _bind_methods();
42
43 GDVIRTUAL0RC(String, _get_importer_name)
44 GDVIRTUAL0RC(String, _get_visible_name)
45 GDVIRTUAL0RC(int, _get_preset_count)
46 GDVIRTUAL1RC(String, _get_preset_name, int)
47 GDVIRTUAL0RC(Vector<String>, _get_recognized_extensions)
48 GDVIRTUAL2RC(TypedArray<Dictionary>, _get_import_options, String, int)
49 GDVIRTUAL0RC(String, _get_save_extension)
50 GDVIRTUAL0RC(String, _get_resource_type)
51 GDVIRTUAL0RC(float, _get_priority)
52 GDVIRTUAL0RC(int, _get_import_order)
53 GDVIRTUAL3RC(bool, _get_option_visibility, String, StringName, Dictionary)
54 GDVIRTUAL5RC(Error, _import, String, String, Dictionary, TypedArray<String>, TypedArray<String>)
55
56 Error _append_import_external_resource(const String &p_file, const Dictionary &p_custom_options = Dictionary(), const String &p_custom_importer = String(), Variant p_generator_parameters = Variant());
57
58public:
59 EditorImportPlugin();
60 virtual String get_importer_name() const override;
61 virtual String get_visible_name() const override;
62 virtual void get_recognized_extensions(List<String> *p_extensions) const override;
63 virtual String get_preset_name(int p_idx) const override;
64 virtual int get_preset_count() const override;
65 virtual String get_save_extension() const override;
66 virtual String get_resource_type() const override;
67 virtual float get_priority() const override;
68 virtual int get_import_order() const override;
69 virtual void get_import_options(const String &p_path, List<ImportOption> *r_options, int p_preset) const override;
70 virtual bool get_option_visibility(const String &p_path, const String &p_option, const HashMap<StringName, Variant> &p_options) const override;
71 virtual Error import(const String &p_source_file, const String &p_save_path, const HashMap<StringName, Variant> &p_options, List<String> *r_platform_variants, List<String> *r_gen_files, Variant *r_metadata = nullptr) override;
72 Error append_import_external_resource(const String &p_file, const HashMap<StringName, Variant> &p_custom_options = HashMap<StringName, Variant>(), const String &p_custom_importer = String(), Variant p_generator_parameters = Variant());
73};
74
75#endif // EDITOR_IMPORT_PLUGIN_H
76