diff options
| author | Juan Linietsky | 2014-02-09 22:10:30 -0300 |
|---|---|---|
| committer | Juan Linietsky | 2014-02-09 22:10:30 -0300 |
| commit | 0b806ee0fc9097fa7bda7ac0109191c9c5e0a1ac (patch) | |
| tree | 276c4d099e178eb67fbd14f61d77b05e3808e9e3 /core/io/resource_loader.h | |
| parent | 0e49da1687bc8192ed210947da52c9e5c5f301bb (diff) | |
| download | godot-0b806ee.tar.gz godot-0b806ee.tar.zst godot-0b806ee.zip | |
GODOT IS OPEN SOURCE
Diffstat (limited to 'core/io/resource_loader.h')
| -rw-r--r-- | core/io/resource_loader.h | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/core/io/resource_loader.h b/core/io/resource_loader.h new file mode 100644 index 000000000..70b1a7958 --- /dev/null +++ b/core/io/resource_loader.h @@ -0,0 +1,114 @@ +/*************************************************************************/ +/* resource_loader.h */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* http://www.godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/*************************************************************************/ +#ifndef RESOURCE_LOADER_H +#define RESOURCE_LOADER_H + +#include "resource.h" + +/** + @author Juan Linietsky <reduzio@gmail.com> +*/ + +class ResourceInteractiveLoader : public Reference { + + OBJ_TYPE(ResourceInteractiveLoader,Reference); +protected: + + static void _bind_methods(); +public: + + virtual void set_local_path(const String& p_local_path)=0; + virtual Ref<Resource> get_resource()=0; + virtual Error poll()=0; + virtual int get_stage() const=0; + virtual int get_stage_count() const=0; + virtual Error wait(); + + ResourceInteractiveLoader() {} +}; + + +class ResourceFormatLoader { +public: + + virtual Ref<ResourceInteractiveLoader> load_interactive(const String &p_path); + virtual RES load(const String &p_path,const String& p_original_path=""); + virtual void get_recognized_extensions(List<String> *p_extensions) const=0; + virtual void get_recognized_extensions_for_type(const String& p_type,List<String> *p_extensions) const; + bool recognize(const String& p_extension) const; + virtual bool handles_type(const String& p_type) const=0; + virtual String get_resource_type(const String &p_path) const=0; + virtual void get_dependencies(const String& p_path,List<String> *p_dependencies); + virtual Error load_import_metadata(const String &p_path, Ref<ResourceImportMetadata>& r_var) const { return ERR_UNAVAILABLE; } + + virtual ~ResourceFormatLoader() {} +}; + + +typedef void (*ResourceLoadErrorNotify)(void *p_ud,const String& p_text); + + +class ResourceLoader { + + enum { + MAX_LOADERS=64 + }; + + static ResourceFormatLoader *loader[MAX_LOADERS]; + static int loader_count; + static bool timestamp_on_load; + + static void* err_notify_ud; + static ResourceLoadErrorNotify err_notify; + static bool abort_on_missing_resource; + + static String find_complete_path(const String& p_path,const String& p_type); +public: + + + + static Ref<ResourceInteractiveLoader> load_interactive(const String &p_path,const String& p_type_hint="",bool p_no_cache=false); + static RES load(const String &p_path,const String& p_type_hint="",bool p_no_cache=false); + static Ref<ResourceImportMetadata> load_import_metadata(const String &p_path); + + static void get_recognized_extensions_for_type(const String& p_type,List<String> *p_extensions); + static void add_resource_format_loader(ResourceFormatLoader *p_format_loader); + static String get_resource_type(const String &p_path); + static void get_dependencies(const String& p_path,List<String> *p_dependencies); + + + static void set_timestamp_on_load(bool p_timestamp) { timestamp_on_load=p_timestamp; } + + static void notify_load_error(const String& p_err) { if (err_notify) err_notify(err_notify_ud,p_err); } + static void set_error_notify_func(void* p_ud,ResourceLoadErrorNotify p_err_notify) { err_notify=p_err_notify; err_notify_ud=p_ud;} + static void set_abort_on_missing_resources(bool p_abort) { abort_on_missing_resource=p_abort; } + static bool get_abort_on_missing_resources() { return abort_on_missing_resource; } +}; + +#endif |
