ee0a85766d
# Objective The docs on SpatialBundle's pub const constructors mention that one is "visible" when it's actually inherited, which afaik means it's conditional on its parent's visibility. I feel it's more correct like this. _Also I'm seeing how making a PR from github.dev works hopefully nothing weird happens_
66 lines
2.1 KiB
Rust
66 lines
2.1 KiB
Rust
use bevy_ecs::prelude::Bundle;
|
|
use bevy_transform::prelude::{GlobalTransform, Transform};
|
|
|
|
use crate::view::{InheritedVisibility, ViewVisibility, Visibility};
|
|
|
|
/// A [`Bundle`] that allows the correct positional rendering of an entity.
|
|
///
|
|
/// It consists of transform components,
|
|
/// controlling position, rotation and scale of the entity,
|
|
/// but also visibility components,
|
|
/// which determine whether the entity is visible or not.
|
|
///
|
|
/// Parent-child hierarchies of entities must contain
|
|
/// all the [`Component`]s in this `Bundle`
|
|
/// to be rendered correctly.
|
|
///
|
|
/// [`Component`]: bevy_ecs::component::Component
|
|
#[derive(Bundle, Clone, Debug, Default)]
|
|
pub struct SpatialBundle {
|
|
/// The visibility of the entity.
|
|
pub visibility: Visibility,
|
|
/// The inherited visibility of the entity.
|
|
pub inherited_visibility: InheritedVisibility,
|
|
/// The view visibility of the entity.
|
|
pub view_visibility: ViewVisibility,
|
|
/// The transform of the entity.
|
|
pub transform: Transform,
|
|
/// The global transform of the entity.
|
|
pub global_transform: GlobalTransform,
|
|
}
|
|
|
|
impl SpatialBundle {
|
|
/// Creates a new [`SpatialBundle`] from a [`Transform`].
|
|
///
|
|
/// This initializes [`GlobalTransform`] as identity, and visibility as visible
|
|
#[inline]
|
|
pub const fn from_transform(transform: Transform) -> Self {
|
|
SpatialBundle {
|
|
transform,
|
|
..Self::INHERITED_IDENTITY
|
|
}
|
|
}
|
|
|
|
/// A [`SpatialBundle`] with inherited visibility and identity transform.
|
|
pub const INHERITED_IDENTITY: Self = SpatialBundle {
|
|
visibility: Visibility::Inherited,
|
|
inherited_visibility: InheritedVisibility::HIDDEN,
|
|
view_visibility: ViewVisibility::HIDDEN,
|
|
transform: Transform::IDENTITY,
|
|
global_transform: GlobalTransform::IDENTITY,
|
|
};
|
|
|
|
/// An invisible [`SpatialBundle`] with identity transform.
|
|
pub const HIDDEN_IDENTITY: Self = SpatialBundle {
|
|
visibility: Visibility::Hidden,
|
|
..Self::INHERITED_IDENTITY
|
|
};
|
|
}
|
|
|
|
impl From<Transform> for SpatialBundle {
|
|
#[inline]
|
|
fn from(transform: Transform) -> Self {
|
|
Self::from_transform(transform)
|
|
}
|
|
}
|