fyrox_ui/loader.rs
1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! User Interface loader.
22
23use crate::constructor::WidgetConstructorContainer;
24use crate::{
25 core::{uuid::Uuid, TypeUuidProvider},
26 UserInterface,
27};
28use fyrox_core::dyntype::DynTypeConstructorContainer;
29use fyrox_resource::{
30 io::ResourceIo,
31 loader::{BoxedLoaderFuture, LoaderPayload, ResourceLoader},
32 manager::ResourceManager,
33 state::LoadError,
34};
35use std::{path::PathBuf, sync::Arc};
36
37/// Default implementation for UI loading.
38pub struct UserInterfaceLoader {
39 pub resource_manager: ResourceManager,
40 pub constructors: Arc<WidgetConstructorContainer>,
41 pub dyn_type_constructors: Arc<DynTypeConstructorContainer>,
42}
43
44impl ResourceLoader for UserInterfaceLoader {
45 fn extensions(&self) -> &[&str] {
46 &["ui"]
47 }
48
49 fn is_native_extension(&self, ext: &str) -> bool {
50 fyrox_core::cmp_strings_case_insensitive(ext, "ui")
51 }
52
53 fn data_type_uuid(&self) -> Uuid {
54 UserInterface::type_uuid()
55 }
56
57 fn load(&self, path: PathBuf, io: Arc<dyn ResourceIo>) -> BoxedLoaderFuture {
58 let resource_manager = self.resource_manager.clone();
59 let constructors = self.constructors.clone();
60 let dyn_type_constructors = self.dyn_type_constructors.clone();
61 Box::pin(async move {
62 let io = io.as_ref();
63 let ui = UserInterface::load_from_file_ex(
64 &path,
65 constructors,
66 dyn_type_constructors,
67 resource_manager,
68 io,
69 )
70 .await
71 .map_err(LoadError::new)?;
72 Ok(LoaderPayload::new(ui))
73 })
74 }
75}