 dcc03724a5
			
		
	
	
		dcc03724a5
		
	
	
	
	
		
			
			# Objective NOTE: This depends on #7267 and should not be merged until #7267 is merged. If you are reviewing this before that is merged, I highly recommend viewing the Base Sets commit instead of trying to find my changes amongst those from #7267. "Default sets" as described by the [Stageless RFC](https://github.com/bevyengine/rfcs/pull/45) have some [unfortunate consequences](https://github.com/bevyengine/bevy/discussions/7365). ## Solution This adds "base sets" as a variant of `SystemSet`: A set is a "base set" if `SystemSet::is_base` returns `true`. Typically this will be opted-in to using the `SystemSet` derive: ```rust #[derive(SystemSet, Clone, Hash, Debug, PartialEq, Eq)] #[system_set(base)] enum MyBaseSet { A, B, } ``` **Base sets are exclusive**: a system can belong to at most one "base set". Adding a system to more than one will result in an error. When possible we fail immediately during system-config-time with a nice file + line number. For the more nested graph-ey cases, this will fail at the final schedule build. **Base sets cannot belong to other sets**: this is where the word "base" comes from Systems and Sets can only be added to base sets using `in_base_set`. Calling `in_set` with a base set will fail. As will calling `in_base_set` with a normal set. ```rust app.add_system(foo.in_base_set(MyBaseSet::A)) // X must be a normal set ... base sets cannot be added to base sets .configure_set(X.in_base_set(MyBaseSet::A)) ``` Base sets can still be configured like normal sets: ```rust app.add_system(MyBaseSet::B.after(MyBaseSet::Ap)) ``` The primary use case for base sets is enabling a "default base set": ```rust schedule.set_default_base_set(CoreSet::Update) // this will belong to CoreSet::Update by default .add_system(foo) // this will override the default base set with PostUpdate .add_system(bar.in_base_set(CoreSet::PostUpdate)) ``` This allows us to build apis that work by default in the standard Bevy style. This is a rough analog to the "default stage" model, but it use the new "stageless sets" model instead, with all of the ordering flexibility (including exclusive systems) that it provides. --- ## Changelog - Added "base sets" and ported CoreSet to use them. ## Migration Guide TODO
		
			
				
	
	
		
			101 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			101 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Illustrates how to scale an object in each direction.
 | |
| 
 | |
| use std::f32::consts::PI;
 | |
| 
 | |
| use bevy::math::Vec3Swizzles;
 | |
| use bevy::prelude::*;
 | |
| 
 | |
| // Define a component to keep information for the scaled object.
 | |
| #[derive(Component)]
 | |
| struct Scaling {
 | |
|     scale_direction: Vec3,
 | |
|     scale_speed: f32,
 | |
|     max_element_size: f32,
 | |
|     min_element_size: f32,
 | |
| }
 | |
| 
 | |
| // Implement a simple initialization.
 | |
| impl Scaling {
 | |
|     fn new() -> Self {
 | |
|         Scaling {
 | |
|             scale_direction: Vec3::X,
 | |
|             scale_speed: 2.0,
 | |
|             max_element_size: 5.0,
 | |
|             min_element_size: 1.0,
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_startup_system(setup)
 | |
|         .add_system(change_scale_direction)
 | |
|         .add_system(scale_cube)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| // Startup system to setup the scene and spawn all relevant entities.
 | |
| fn setup(
 | |
|     mut commands: Commands,
 | |
|     mut meshes: ResMut<Assets<Mesh>>,
 | |
|     mut materials: ResMut<Assets<StandardMaterial>>,
 | |
| ) {
 | |
|     // Spawn a cube to scale.
 | |
|     commands.spawn((
 | |
|         PbrBundle {
 | |
|             mesh: meshes.add(Mesh::from(shape::Cube { size: 1.0 })),
 | |
|             material: materials.add(Color::WHITE.into()),
 | |
|             transform: Transform::from_rotation(Quat::from_rotation_y(PI / 4.0)),
 | |
|             ..default()
 | |
|         },
 | |
|         Scaling::new(),
 | |
|     ));
 | |
| 
 | |
|     // Spawn a camera looking at the entities to show what's happening in this example.
 | |
|     commands.spawn(Camera3dBundle {
 | |
|         transform: Transform::from_xyz(0.0, 10.0, 20.0).looking_at(Vec3::ZERO, Vec3::Y),
 | |
|         ..default()
 | |
|     });
 | |
| 
 | |
|     // Add a light source for better 3d visibility.
 | |
|     commands.spawn(PointLightBundle {
 | |
|         transform: Transform::from_translation(Vec3::ONE * 3.0),
 | |
|         ..default()
 | |
|     });
 | |
| }
 | |
| 
 | |
| // This system will check if a scaled entity went above or below the entities scaling bounds
 | |
| // and change the direction of the scaling vector.
 | |
| fn change_scale_direction(mut cubes: Query<(&mut Transform, &mut Scaling)>) {
 | |
|     for (mut transform, mut cube) in &mut cubes {
 | |
|         // If an entity scaled beyond the maximum of its size in any dimension
 | |
|         // the scaling vector is flipped so the scaling is gradually reverted.
 | |
|         // Additionally, to ensure the condition does not trigger again we floor the elements to
 | |
|         // their next full value, which should be max_element_size at max.
 | |
|         if transform.scale.max_element() > cube.max_element_size {
 | |
|             cube.scale_direction *= -1.0;
 | |
|             transform.scale = transform.scale.floor();
 | |
|         }
 | |
|         // If an entity scaled beyond the minimum of its size in any dimension
 | |
|         // the scaling vector is also flipped.
 | |
|         // Additionally the Values are ceiled to be min_element_size at least
 | |
|         // and the scale direction is flipped.
 | |
|         // This way the entity will change the dimension in which it is scaled any time it
 | |
|         // reaches its min_element_size.
 | |
|         if transform.scale.min_element() < cube.min_element_size {
 | |
|             cube.scale_direction *= -1.0;
 | |
|             transform.scale = transform.scale.ceil();
 | |
|             cube.scale_direction = cube.scale_direction.zxy();
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| // This system will scale any entity with assigned Scaling in each direction
 | |
| // by cycling through the directions to scale.
 | |
| fn scale_cube(mut cubes: Query<(&mut Transform, &Scaling)>, timer: Res<Time>) {
 | |
|     for (mut transform, cube) in &mut cubes {
 | |
|         transform.scale += cube.scale_direction * cube.scale_speed * timer.delta_seconds();
 | |
|     }
 | |
| }
 |