bevy_child_window 0.2.1

Allows you to create an embed child window in Bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

//! Provides the feature to create a child window
//!
//! You can create a child window by inserting [`ParentWindow`].
//! The window belonging to the same entity as its component will be displayed within the area of the parent window.
//!
//! # Example
//! ```no_run
//! use bevy::prelude::*;
//! use bevy_child_window::ParentWindow;
//!
//! fn spawn_child_window(
//!     mut commands: Commands,
//!    parent_window: Query<Entity, With<ParentWindow>>,
//! ){
//!     commands.spawn((
//!         ParentWindow(parent_window.single().expect("Parent not found")),
//!         Window::default(),
//!    ));
//! }
//! ```

#![allow(clippy::type_complexity)]

mod platform_impl;
use bevy::app::{App, Plugin};
use bevy::ecs::component::HookContext;
use bevy::ecs::world::DeferredWorld;
use bevy::prelude::{Component, Entity, Reflect, ReflectComponent, ReflectDefault, ReflectDeserialize, ReflectSerialize};
use serde::{Deserialize, Serialize};

#[allow(missing_docs)]
pub mod prelude {
    pub use crate::ChildWindowPlugin;
    pub use crate::ParentWindow;
}

/// Provides the feature to create a child window
///
/// You can create a child window by inserting [`ParentWindow`].
/// The window belonging to the same entity as its component will be displayed within the area of the parent window.
///
/// # Example
/// ```no_run
/// use bevy::prelude::*;
/// use bevy_child_window::ParentWindow;
///
/// fn spawn_child_window(
///     mut commands: Commands,
///    parent_window: Query<Entity, With<ParentWindow>>,
/// ){
///     commands.spawn((
///         ParentWindow(parent_window.single().expect("Parent not found")),
///         Window::default(),
///    ));
/// }
/// ```
pub struct ChildWindowPlugin;

impl Plugin for ChildWindowPlugin {
    fn build(&self, app: &mut App) {
        app
            .register_type::<ParentWindow>()
            .register_type::<UnInitializeWindow>()
            .add_plugins(platform_impl::ChildWindowPlugin);

        app
            .world_mut()
            .register_component_hooks::<ParentWindow>()
            .on_add(|mut world: DeferredWorld, context: HookContext| {
                world.commands().entity(context.entity).insert(UnInitializeWindow);
            });
    }
}

/// Specifies the entity of the parent window.
///
/// The window belonging to the same entity as this component will be displayed within the area of the parent window.
///
/// # Example
/// ```no_run
/// use bevy::prelude::*;
/// use bevy_child_window::ParentWindow;
///
/// fn spawn_child_window(
///     mut commands: Commands,
///    parent_window: Query<Entity, With<ParentWindow>>,
/// ){
///     commands.spawn((
///         ParentWindow(parent_window.single().expect("Parent not found")),
///         Window::default(),
///    ));
/// }
/// ```
#[derive(Component, Reflect, Serialize, Deserialize)]
#[reflect(Component, Serialize, Deserialize)]
pub struct ParentWindow(pub Entity);

#[derive(Component, Reflect, Serialize, Deserialize, Default)]
#[reflect(Component, Serialize, Deserialize, Default)]
struct UnInitializeWindow;