d3e020a1e7
I'm opening this prematurely; consider this an RFC that predates RFCs and therefore not super-RFC-like. This PR does two "big" things: decouple run criteria from system sets, reimagine system sets as weapons of mass system description. ### What it lets us do: * Reuse run criteria within a stage. * Pipe output of one run criteria as input to another. * Assign labels, dependencies, run criteria, and ambiguity sets to many systems at the same time. ### Things already done: * Decoupled run criteria from system sets. * Mass system description superpowers to `SystemSet`. * Implemented `RunCriteriaDescriptor`. * Removed `VirtualSystemSet`. * Centralized all run criteria of `SystemStage`. * Extended system descriptors with per-system run criteria. * `.before()` and `.after()` for run criteria. * Explicit order between state driver and related run criteria. Fixes #1672. * Opt-in run criteria deduplication; default behavior is to panic. * Labels (not exposed) for state run criteria; state run criteria are deduplicated. ### API issues that need discussion: * [`FixedTimestep::step(1.0).label("my label")`](eaccf857cd/crates/bevy_ecs/src/schedule/run_criteria.rs (L120-L122)) and [`FixedTimestep::step(1.0).with_label("my label")`](eaccf857cd/crates/bevy_core/src/time/fixed_timestep.rs (L86-L89)) are both valid but do very different things. --- I will try to maintain this post up-to-date as things change. Do check the diffs in "edited" thingy from time to time. Co-authored-by: Carter Anderson <mcanders1@gmail.com>
116 lines
2.7 KiB
Rust
116 lines
2.7 KiB
Rust
pub use bevy_ecs_macros::{AmbiguitySetLabel, RunCriteriaLabel, StageLabel, SystemLabel};
|
|
|
|
use std::{
|
|
any::Any,
|
|
borrow::Cow,
|
|
fmt::Debug,
|
|
hash::{Hash, Hasher},
|
|
};
|
|
|
|
pub trait DynEq: Any {
|
|
fn as_any(&self) -> &dyn Any;
|
|
|
|
fn dyn_eq(&self, other: &dyn DynEq) -> bool;
|
|
}
|
|
|
|
impl<T> DynEq for T
|
|
where
|
|
T: Any + Eq,
|
|
{
|
|
fn as_any(&self) -> &dyn Any {
|
|
self
|
|
}
|
|
|
|
fn dyn_eq(&self, other: &dyn DynEq) -> bool {
|
|
if let Some(other) = other.as_any().downcast_ref::<T>() {
|
|
return self == other;
|
|
}
|
|
false
|
|
}
|
|
}
|
|
|
|
pub trait DynHash: DynEq {
|
|
fn as_dyn_eq(&self) -> &dyn DynEq;
|
|
|
|
fn dyn_hash(&self, state: &mut dyn Hasher);
|
|
}
|
|
|
|
impl<T> DynHash for T
|
|
where
|
|
T: DynEq + Hash,
|
|
{
|
|
fn as_dyn_eq(&self) -> &dyn DynEq {
|
|
self
|
|
}
|
|
|
|
fn dyn_hash(&self, mut state: &mut dyn Hasher) {
|
|
T::hash(self, &mut state);
|
|
self.type_id().hash(&mut state);
|
|
}
|
|
}
|
|
|
|
pub trait StageLabel: DynHash + Debug + Send + Sync + 'static {
|
|
#[doc(hidden)]
|
|
fn dyn_clone(&self) -> Box<dyn StageLabel>;
|
|
}
|
|
pub(crate) type BoxedStageLabel = Box<dyn StageLabel>;
|
|
|
|
pub trait SystemLabel: DynHash + Debug + Send + Sync + 'static {
|
|
#[doc(hidden)]
|
|
fn dyn_clone(&self) -> Box<dyn SystemLabel>;
|
|
}
|
|
pub(crate) type BoxedSystemLabel = Box<dyn SystemLabel>;
|
|
|
|
pub trait AmbiguitySetLabel: DynHash + Debug + Send + Sync + 'static {
|
|
#[doc(hidden)]
|
|
fn dyn_clone(&self) -> Box<dyn AmbiguitySetLabel>;
|
|
}
|
|
pub(crate) type BoxedAmbiguitySetLabel = Box<dyn AmbiguitySetLabel>;
|
|
|
|
pub trait RunCriteriaLabel: DynHash + Debug + Send + Sync + 'static {
|
|
#[doc(hidden)]
|
|
fn dyn_clone(&self) -> Box<dyn RunCriteriaLabel>;
|
|
}
|
|
pub(crate) type BoxedRunCriteriaLabel = Box<dyn RunCriteriaLabel>;
|
|
|
|
macro_rules! impl_label {
|
|
($trait_name:ident) => {
|
|
impl PartialEq for dyn $trait_name {
|
|
fn eq(&self, other: &Self) -> bool {
|
|
self.dyn_eq(other.as_dyn_eq())
|
|
}
|
|
}
|
|
|
|
impl Eq for dyn $trait_name {}
|
|
|
|
impl Hash for dyn $trait_name {
|
|
fn hash<H: Hasher>(&self, state: &mut H) {
|
|
self.dyn_hash(state);
|
|
}
|
|
}
|
|
|
|
impl Clone for Box<dyn $trait_name> {
|
|
fn clone(&self) -> Self {
|
|
self.dyn_clone()
|
|
}
|
|
}
|
|
|
|
impl $trait_name for Cow<'static, str> {
|
|
fn dyn_clone(&self) -> Box<dyn $trait_name> {
|
|
Box::new(self.clone())
|
|
}
|
|
}
|
|
|
|
impl $trait_name for &'static str {
|
|
fn dyn_clone(&self) -> Box<dyn $trait_name> {
|
|
Box::new(<&str>::clone(self))
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
impl_label!(StageLabel);
|
|
impl_label!(SystemLabel);
|
|
impl_label!(AmbiguitySetLabel);
|
|
impl_label!(RunCriteriaLabel);
|