760c645de1
Adopted from and closes https://github.com/bevyengine/bevy/pull/9914 by @djeedai # Objective Fix the use of `TypeRegistry` instead of `TypeRegistryArc` in dynamic scene and its serializer. Rename `DynamicScene::serialize_ron()` into `serialize()` to highlight the fact this is not about serializing to RON specifically, but rather about serializing to the official Bevy scene format (`.scn` / `.scn.ron`) which the `SceneLoader` can deserialize (and which happens to be based in RON, but that not the object here). Also make the link with the documentation of `SceneLoader` so users understand the full serializing cycle of a Bevy dynamic scene. Document `SceneSerializer` with an example showing how to serialize to a custom format (here: RON), which is easily transposed to serializing into any other format. Fixes #9520 ## Changelog ### Changed * `SceneSerializer` and all related serializing helper types now take a `&TypeRegistry` instead of a `&TypeRegistryArc`. ([SceneSerializer needlessly uses specifically &TypeRegistryArc #9520](https://github.com/bevyengine/bevy/issues/9520)) * `DynamicScene::serialize_ron()` was renamed to `serialize()`. ## Migration Guide * `SceneSerializer` and all related serializing helper types now take a `&TypeRegistry` instead of a `&TypeRegistryArc`. You can upgrade by getting the former from the latter with `TypeRegistryArc::read()`, _e.g._ ```diff let registry_arc: TypeRegistryArc = [...]; - let serializer = SceneSerializer(&scene, ®istry_arc); + let registry = registry_arc.read(); + let serializer = SceneSerializer(&scene, ®istry); ``` * Rename `DynamicScene::serialize_ron()` to `serialize()`. --------- Co-authored-by: Jerome Humbert <djeedai@gmail.com> Co-authored-by: Alice Cecile <alice.i.cecil@gmail.com> Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com> Co-authored-by: James Liu <contact@jamessliu.com>
69 lines
2.0 KiB
Rust
69 lines
2.0 KiB
Rust
use crate::ron;
|
|
#[cfg(feature = "serialize")]
|
|
use crate::serde::SceneDeserializer;
|
|
use crate::DynamicScene;
|
|
use bevy_asset::{io::Reader, AssetLoader, AsyncReadExt, LoadContext};
|
|
use bevy_ecs::reflect::AppTypeRegistry;
|
|
use bevy_ecs::world::{FromWorld, World};
|
|
use bevy_reflect::TypeRegistryArc;
|
|
#[cfg(feature = "serialize")]
|
|
use serde::de::DeserializeSeed;
|
|
use thiserror::Error;
|
|
|
|
/// Asset loader for a Bevy dynamic scene (`.scn` / `.scn.ron`).
|
|
///
|
|
/// The loader handles assets serialized with [`DynamicScene::serialize`].
|
|
#[derive(Debug)]
|
|
pub struct SceneLoader {
|
|
type_registry: TypeRegistryArc,
|
|
}
|
|
|
|
impl FromWorld for SceneLoader {
|
|
fn from_world(world: &mut World) -> Self {
|
|
let type_registry = world.resource::<AppTypeRegistry>();
|
|
SceneLoader {
|
|
type_registry: type_registry.0.clone(),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Possible errors that can be produced by [`SceneLoader`]
|
|
#[non_exhaustive]
|
|
#[derive(Debug, Error)]
|
|
pub enum SceneLoaderError {
|
|
/// An [IO Error](std::io::Error)
|
|
#[error("Error while trying to read the scene file: {0}")]
|
|
Io(#[from] std::io::Error),
|
|
/// A [RON Error](ron::error::SpannedError)
|
|
#[error("Could not parse RON: {0}")]
|
|
RonSpannedError(#[from] ron::error::SpannedError),
|
|
}
|
|
|
|
#[cfg(feature = "serialize")]
|
|
impl AssetLoader for SceneLoader {
|
|
type Asset = DynamicScene;
|
|
type Settings = ();
|
|
type Error = SceneLoaderError;
|
|
|
|
async fn load<'a>(
|
|
&'a self,
|
|
reader: &'a mut Reader<'_>,
|
|
_settings: &'a (),
|
|
_load_context: &'a mut LoadContext<'_>,
|
|
) -> Result<Self::Asset, Self::Error> {
|
|
let mut bytes = Vec::new();
|
|
reader.read_to_end(&mut bytes).await?;
|
|
let mut deserializer = ron::de::Deserializer::from_bytes(&bytes)?;
|
|
let scene_deserializer = SceneDeserializer {
|
|
type_registry: &self.type_registry.read(),
|
|
};
|
|
Ok(scene_deserializer
|
|
.deserialize(&mut deserializer)
|
|
.map_err(|e| deserializer.span_error(e))?)
|
|
}
|
|
|
|
fn extensions(&self) -> &[&str] {
|
|
&["scn", "scn.ron"]
|
|
}
|
|
}
|