 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
		
			
				
	
	
		
			158 lines
		
	
	
		
			5.9 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			158 lines
		
	
	
		
			5.9 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Shows multiple transformations of objects.
 | |
| 
 | |
| use std::f32::consts::PI;
 | |
| 
 | |
| use bevy::prelude::*;
 | |
| 
 | |
| // A struct for additional data of for a moving cube.
 | |
| #[derive(Component)]
 | |
| struct CubeState {
 | |
|     start_pos: Vec3,
 | |
|     move_speed: f32,
 | |
|     turn_speed: f32,
 | |
| }
 | |
| 
 | |
| // A struct adding information to a scalable entity,
 | |
| // that will be stationary at the center of the scene.
 | |
| #[derive(Component)]
 | |
| struct Center {
 | |
|     max_size: f32,
 | |
|     min_size: f32,
 | |
|     scale_factor: f32,
 | |
| }
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_startup_system(setup)
 | |
|         .add_system(move_cube)
 | |
|         .add_system(rotate_cube)
 | |
|         .add_system(scale_down_sphere_proportional_to_cube_travel_distance)
 | |
|         .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>>,
 | |
| ) {
 | |
|     // Add an object (sphere) for visualizing scaling.
 | |
|     commands.spawn((
 | |
|         PbrBundle {
 | |
|             mesh: meshes.add(
 | |
|                 Mesh::try_from(shape::Icosphere {
 | |
|                     radius: 3.0,
 | |
|                     subdivisions: 32,
 | |
|                 })
 | |
|                 .unwrap(),
 | |
|             ),
 | |
|             material: materials.add(Color::YELLOW.into()),
 | |
|             transform: Transform::from_translation(Vec3::ZERO),
 | |
|             ..default()
 | |
|         },
 | |
|         Center {
 | |
|             max_size: 1.0,
 | |
|             min_size: 0.1,
 | |
|             scale_factor: 0.05,
 | |
|         },
 | |
|     ));
 | |
| 
 | |
|     // Add the cube to visualize rotation and translation.
 | |
|     // This cube will circle around the center_sphere
 | |
|     // by changing its rotation each frame and moving forward.
 | |
|     // Define a start transform for an orbiting cube, that's away from our central object (sphere)
 | |
|     // and rotate it so it will be able to move around the sphere and not towards it.
 | |
|     let cube_spawn =
 | |
|         Transform::from_translation(Vec3::Z * -10.0).with_rotation(Quat::from_rotation_y(PI / 2.));
 | |
|     commands.spawn((
 | |
|         PbrBundle {
 | |
|             mesh: meshes.add(Mesh::from(shape::Cube { size: 1.0 })),
 | |
|             material: materials.add(Color::WHITE.into()),
 | |
|             transform: cube_spawn,
 | |
|             ..default()
 | |
|         },
 | |
|         CubeState {
 | |
|             start_pos: cube_spawn.translation,
 | |
|             move_speed: 2.0,
 | |
|             turn_speed: 0.2,
 | |
|         },
 | |
|     ));
 | |
| 
 | |
|     // 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 move the cube forward.
 | |
| fn move_cube(mut cubes: Query<(&mut Transform, &mut CubeState)>, timer: Res<Time>) {
 | |
|     for (mut transform, cube) in &mut cubes {
 | |
|         // Move the cube forward smoothly at a given move_speed.
 | |
|         let forward = transform.forward();
 | |
|         transform.translation += forward * cube.move_speed * timer.delta_seconds();
 | |
|     }
 | |
| }
 | |
| 
 | |
| // This system will rotate the cube slightly towards the center_sphere.
 | |
| // Due to the forward movement the resulting movement
 | |
| // will be a circular motion around the center_sphere.
 | |
| fn rotate_cube(
 | |
|     mut cubes: Query<(&mut Transform, &mut CubeState), Without<Center>>,
 | |
|     center_spheres: Query<&Transform, With<Center>>,
 | |
|     timer: Res<Time>,
 | |
| ) {
 | |
|     // Calculate the point to circle around. (The position of the center_sphere)
 | |
|     let mut center: Vec3 = Vec3::ZERO;
 | |
|     for sphere in ¢er_spheres {
 | |
|         center += sphere.translation;
 | |
|     }
 | |
|     // Update the rotation of the cube(s).
 | |
|     for (mut transform, cube) in &mut cubes {
 | |
|         // Calculate the rotation of the cube if it would be looking at the sphere in the center.
 | |
|         let look_at_sphere = transform.looking_at(center, transform.local_y());
 | |
|         // Interpolate between the current rotation and the fully turned rotation
 | |
|         // when looking a the sphere,  with a given turn speed to get a smooth motion.
 | |
|         // With higher speed the curvature of the orbit would be smaller.
 | |
|         let incremental_turn_weight = cube.turn_speed * timer.delta_seconds();
 | |
|         let old_rotation = transform.rotation;
 | |
|         transform.rotation = old_rotation.lerp(look_at_sphere.rotation, incremental_turn_weight);
 | |
|     }
 | |
| }
 | |
| 
 | |
| // This system will scale down the sphere in the center of the scene
 | |
| // according to the traveling distance of the orbiting cube(s) from their start position(s).
 | |
| fn scale_down_sphere_proportional_to_cube_travel_distance(
 | |
|     cubes: Query<(&Transform, &CubeState), Without<Center>>,
 | |
|     mut centers: Query<(&mut Transform, &Center)>,
 | |
| ) {
 | |
|     // First we need to calculate the length of between
 | |
|     // the current position of the orbiting cube and the spawn position.
 | |
|     let mut distances = 0.0;
 | |
|     for (cube_transform, cube_state) in &cubes {
 | |
|         distances += (cube_state.start_pos - cube_transform.translation).length();
 | |
|     }
 | |
|     // Now we use the calculated value to scale the sphere in the center accordingly.
 | |
|     for (mut transform, center) in &mut centers {
 | |
|         // Calculate the new size from the calculated distances and the centers scale_factor.
 | |
|         // Since we want to have the sphere at its max_size at the cubes spawn location we start by
 | |
|         // using the max_size as start value and subtract the distances scaled by a scaling factor.
 | |
|         let mut new_size: f32 = center.max_size - center.scale_factor * distances;
 | |
| 
 | |
|         // The new size should also not be smaller than the centers min_size.
 | |
|         // Therefore the max value out of (new_size, center.min_size) is used.
 | |
|         new_size = new_size.max(center.min_size);
 | |
| 
 | |
|         // Now scale the sphere uniformly in all directions using new_size.
 | |
|         // Here Vec3:splat is used to create a vector with new_size in x, y and z direction.
 | |
|         transform.scale = Vec3::splat(new_size);
 | |
|     }
 | |
| }
 |