Support overriding global interpolation for individual entities

Author: Jondolf

src/interpolation.rs

@@ -1,4 +1,6 @@
-use crate::{RotationEasingState, ScaleEasingState, TranslationEasingState};
+#![allow(clippy::type_complexity)]
+
+use crate::*;
 use bevy::{
     ecs::component::{ComponentHooks, StorageType},
     prelude::*,
@@ -90,48 +92,102 @@ impl Component for ScaleInterpolation {
     }
 }
 
-pub fn update_translation_interpolation_start(
-    mut query: Query<(&Transform, &mut TranslationEasingState), With<TranslationInterpolation>>,
+/// Explicitly marks this entity as having translation interpolation disabled.
+///
+/// This can be used to override [`TransformInterpolationPlugin::global_translation_interpolation`]
+/// for this entity if the option is `true`.
+#[derive(Component, Clone, Copy, Debug, Default, PartialEq, Eq, Reflect)]
+#[reflect(Component, Debug, Default)]
+pub struct NoTranslationInterpolation;
+
+/// Explicitly marks this entity as having rotation interpolation disabled.
+///
+/// This can be used to override [`TransformInterpolationPlugin::global_rotation_interpolation`]
+/// for this entity if the option is `true`.
+#[derive(Component, Clone, Copy, Debug, Default, PartialEq, Eq, Reflect)]
+#[reflect(Component, Debug, Default)]
+pub struct NoRotationInterpolation;
+
+/// Explicitly marks this entity as having scale interpolation disabled.
+///
+/// This can be used to override [`TransformInterpolationPlugin::global_scale_interpolation`]
+/// for this entity if the option is `true`.
+#[derive(Component, Clone, Copy, Debug, Default, PartialEq, Eq, Reflect)]
+#[reflect(Component, Debug, Default)]
+pub struct NoScaleInterpolation;
+
+pub(crate) fn update_translation_interpolation_start(
+    mut query: Query<
+        (&Transform, &mut TranslationEasingState),
+        (
+            With<TranslationInterpolation>,
+            Without<NoTranslationInterpolation>,
+        ),
+    >,
 ) {
     for (transform, mut easing) in &mut query {
         easing.start = Some(transform.translation);
     }
 }
 
-pub fn update_translation_interpolation_end(
-    mut query: Query<(&Transform, &mut TranslationEasingState), With<TranslationInterpolation>>,
+pub(crate) fn update_translation_interpolation_end(
+    mut query: Query<
+        (&Transform, &mut TranslationEasingState),
+        (
+            With<TranslationInterpolation>,
+            Without<NoTranslationInterpolation>,
+        ),
+    >,
 ) {
     for (transform, mut easing) in &mut query {
         easing.end = Some(transform.translation);
     }
 }
 
-pub fn update_rotation_interpolation_start(
-    mut query: Query<(&Transform, &mut RotationEasingState), With<RotationInterpolation>>,
+pub(crate) fn update_rotation_interpolation_start(
+    mut query: Query<
+        (&Transform, &mut RotationEasingState),
+        (
+            With<RotationInterpolation>,
+            Without<NoRotationInterpolation>,
+        ),
+    >,
 ) {
     for (transform, mut easing) in &mut query {
         easing.start = Some(transform.rotation);
     }
 }
 
-pub fn update_rotation_interpolation_end(
-    mut query: Query<(&Transform, &mut RotationEasingState), With<RotationInterpolation>>,
+pub(crate) fn update_rotation_interpolation_end(
+    mut query: Query<
+        (&Transform, &mut RotationEasingState),
+        (
+            With<RotationInterpolation>,
+            Without<NoRotationInterpolation>,
+        ),
+    >,
 ) {
     for (transform, mut easing) in &mut query {
         easing.end = Some(transform.rotation);
     }
 }
 
-pub fn update_scale_interpolation_start(
-    mut query: Query<(&Transform, &mut ScaleEasingState), With<ScaleInterpolation>>,
+pub(crate) fn update_scale_interpolation_start(
+    mut query: Query<
+        (&Transform, &mut ScaleEasingState),
+        (With<ScaleInterpolation>, Without<NoScaleInterpolation>),
+    >,
 ) {
     for (transform, mut easing) in &mut query {
         easing.start = Some(transform.scale);
     }
 }
 
-pub fn update_scale_interpolation_end(
-    mut query: Query<(&Transform, &mut ScaleEasingState), With<ScaleInterpolation>>,
+pub(crate) fn update_scale_interpolation_end(
+    mut query: Query<
+        (&Transform, &mut ScaleEasingState),
+        (With<ScaleInterpolation>, Without<NoScaleInterpolation>),
+    >,
 ) {
     for (transform, mut easing) in &mut query {
         easing.end = Some(transform.scale);

src/lib.rs

@@ -8,8 +8,17 @@ pub use interpolation::*;
 /// Performs transform interpolation.
 #[derive(Debug, Default)]
 pub struct TransformInterpolationPlugin {
+    /// If `true`, translation will be interpolated for all entities with the [`Transform`] component by default.
+    ///
+    /// This can be overridden for individual entities by adding the [`NoTranslationInterpolation`] component.
     pub global_translation_interpolation: bool,
+    /// If `true`, rotation will be interpolated for all entities with the [`Transform`] component by default.
+    ///
+    /// This can be overridden for individual entities by adding the [`NoRotationInterpolation`] component.
     pub global_rotation_interpolation: bool,
+    /// If `true`, scale will be interpolated for all entities with the [`Transform`] component by default.
+    ///
+    /// This can be overridden for individual entities by adding the [`NoScaleInterpolation`] component.
     pub global_scale_interpolation: bool,
 }
 
@@ -28,7 +37,7 @@ impl Plugin for TransformInterpolationPlugin {
 
         app.configure_sets(
             PostUpdate,
-            TransformInterpolationSet.before(TransformSystem::TransformPropagate),
+            TransformEasingSet.before(TransformSystem::TransformPropagate),
         );
 
         app.add_systems(
@@ -58,7 +67,7 @@ impl Plugin for TransformInterpolationPlugin {
 
         app.add_systems(
             PostUpdate,
-            (ease_translation, ease_rotation, ease_scale).in_set(TransformInterpolationSet),
+            (ease_translation, ease_rotation, ease_scale).in_set(TransformEasingSet),
         );
 
         let interpolate_translation = self.global_translation_interpolation;
@@ -89,7 +98,7 @@ impl Plugin for TransformInterpolationPlugin {
 ///
 /// [transform interpolation]: TransformInterpolation
 #[derive(SystemSet, Clone, Copy, Debug, PartialEq, Eq, Hash)]
-pub struct TransformInterpolationSet;
+pub struct TransformEasingSet;
 
 /// Stores the start and end states used for interpolating the translation of an entity.
 /// The change in translation is smoothed from `start` to `end` in between [`FixedUpdate`] runs.