ec34fe01d1
# Objective Finish documenting `bevy_scene`. ## Solution Document the remaining items and add a crate-level `warn(missing_doc)` attribute as for the other crates with completed documentation.
101 lines
3.8 KiB
Rust
101 lines
3.8 KiB
Rust
use bevy_asset::Handle;
|
|
use bevy_derive::{Deref, DerefMut};
|
|
use bevy_ecs::{
|
|
bundle::Bundle,
|
|
change_detection::ResMut,
|
|
entity::Entity,
|
|
prelude::{Changed, Component, Without},
|
|
system::{Commands, Query},
|
|
};
|
|
#[cfg(feature = "bevy_render")]
|
|
use bevy_render::prelude::{InheritedVisibility, ViewVisibility, Visibility};
|
|
use bevy_transform::components::{GlobalTransform, Transform};
|
|
|
|
use crate::{DynamicScene, InstanceId, Scene, SceneSpawner};
|
|
|
|
/// [`InstanceId`] of a spawned scene. It can be used with the [`SceneSpawner`] to
|
|
/// interact with the spawned scene.
|
|
#[derive(Component, Deref, DerefMut)]
|
|
pub struct SceneInstance(InstanceId);
|
|
|
|
/// A component bundle for a [`Scene`] root.
|
|
///
|
|
/// The scene from `scene` will be spawn as a child of the entity with this component.
|
|
/// Once it's spawned, the entity will have a [`SceneInstance`] component.
|
|
#[derive(Default, Bundle)]
|
|
pub struct SceneBundle {
|
|
/// Handle to the scene to spawn.
|
|
pub scene: Handle<Scene>,
|
|
/// Transform of the scene root entity.
|
|
pub transform: Transform,
|
|
/// Global transform of the scene root entity.
|
|
pub global_transform: GlobalTransform,
|
|
|
|
/// User-driven visibility of the scene root entity.
|
|
#[cfg(feature = "bevy_render")]
|
|
pub visibility: Visibility,
|
|
/// Inherited visibility of the scene root entity.
|
|
#[cfg(feature = "bevy_render")]
|
|
pub inherited_visibility: InheritedVisibility,
|
|
/// Algorithmically-computed visibility of the scene root entity for rendering.
|
|
#[cfg(feature = "bevy_render")]
|
|
pub view_visibility: ViewVisibility,
|
|
}
|
|
|
|
/// A component bundle for a [`DynamicScene`] root.
|
|
///
|
|
/// The dynamic scene from `scene` will be spawn as a child of the entity with this component.
|
|
/// Once it's spawned, the entity will have a [`SceneInstance`] component.
|
|
#[derive(Default, Bundle)]
|
|
pub struct DynamicSceneBundle {
|
|
/// Handle to the scene to spawn.
|
|
pub scene: Handle<DynamicScene>,
|
|
/// Transform of the scene root entity.
|
|
pub transform: Transform,
|
|
/// Global transform of the scene root entity.
|
|
pub global_transform: GlobalTransform,
|
|
|
|
/// User-driven visibility of the scene root entity.
|
|
#[cfg(feature = "bevy_render")]
|
|
pub visibility: Visibility,
|
|
/// Inherited visibility of the scene root entity.
|
|
#[cfg(feature = "bevy_render")]
|
|
pub inherited_visibility: InheritedVisibility,
|
|
/// Algorithmically-computed visibility of the scene root entity for rendering.
|
|
#[cfg(feature = "bevy_render")]
|
|
pub view_visibility: ViewVisibility,
|
|
}
|
|
|
|
/// System that will spawn scenes from [`SceneBundle`].
|
|
pub fn scene_spawner(
|
|
mut commands: Commands,
|
|
mut scene_to_spawn: Query<
|
|
(Entity, &Handle<Scene>, Option<&mut SceneInstance>),
|
|
(Changed<Handle<Scene>>, Without<Handle<DynamicScene>>),
|
|
>,
|
|
mut dynamic_scene_to_spawn: Query<
|
|
(Entity, &Handle<DynamicScene>, Option<&mut SceneInstance>),
|
|
(Changed<Handle<DynamicScene>>, Without<Handle<Scene>>),
|
|
>,
|
|
mut scene_spawner: ResMut<SceneSpawner>,
|
|
) {
|
|
for (entity, scene, instance) in &mut scene_to_spawn {
|
|
let new_instance = scene_spawner.spawn_as_child(scene.clone(), entity);
|
|
if let Some(mut old_instance) = instance {
|
|
scene_spawner.despawn_instance(**old_instance);
|
|
*old_instance = SceneInstance(new_instance);
|
|
} else {
|
|
commands.entity(entity).insert(SceneInstance(new_instance));
|
|
}
|
|
}
|
|
for (entity, dynamic_scene, instance) in &mut dynamic_scene_to_spawn {
|
|
let new_instance = scene_spawner.spawn_dynamic_as_child(dynamic_scene.clone(), entity);
|
|
if let Some(mut old_instance) = instance {
|
|
scene_spawner.despawn_instance(**old_instance);
|
|
*old_instance = SceneInstance(new_instance);
|
|
} else {
|
|
commands.entity(entity).insert(SceneInstance(new_instance));
|
|
}
|
|
}
|
|
}
|