EffectCraft: An open-source motion graphics and compositing tool written by scratch in pure Rust
#1010: add keys so keyed Orientation follows a tilted parent between the keys
Kristian Myrame78f115d71ca
diff --git a/crates/engine/src/commands/layer.rs b/crates/engine/src/commands/layer.rsindex 7208c1ff1..c112a4912 100644--- a/crates/engine/src/commands/layer.rs+++ b/crates/engine/src/commands/layer.rs@@ -789,10 +789,48 @@ fn reexpress_euler(correction: effectcraft_geom::Mat4, o: [f64; 3], reference: [nearest_euler(euler_zyx(world.0), reference)}+/// Largest angle (degrees) a baked Orientation may drift from the exact rotation between its keys.+const BAKE_TOLERANCE_DEGREES: f64 = 0.05;+/// How many times a segment may be halved while baking, and the most keys a property may end up with.+const BAKE_MAX_DEPTH: u32 = 10;+const BAKE_MAX_KEYS: usize = 4096;++/// The angle (degrees) between two rotations.+fn rotation_angle(a: effectcraft_geom::Mat4, b: effectcraft_geom::Mat4) -> f64 {+ let trace: f64 = (0..3).flat_map(|i| (0..3).map(move |j| (i, j))).map(|(i, j)| a.0[i][j] * b.0[i][j]).sum();+ ((trace - 1.0) / 2.0).clamp(-1.0, 1.0).acos().to_degrees()+}++/// Adds keys between `(ta, ea)` and `(tb, eb)` (already converted) wherever the straight Euler blend+/// between them drifts from `correction * Orientation(authored)` by more than the tolerance.+fn bake_between(+ correction: effectcraft_geom::Mat4,+ authored: &effectcraft_project::Property,+ (ta, ea): (Tick, [f64; 3]),+ (tb, eb): (Tick, [f64; 3]),+ depth: u32,+ out: &mut Vec<effectcraft_keyframe::Keyframe>,+) {+ use effectcraft_geom::{Mat4, Vec3};+ if depth == 0 || tb.0 - ta.0 < 2 || out.len() >= BAKE_MAX_KEYS {+ return;+ }+ let tm = Tick(ta.0 + (tb.0 - ta.0) / 2);+ let blend = [(ea[0] + eb[0]) / 2.0, (ea[1] + eb[1]) / 2.0, (ea[2] + eb[2]) / 2.0];+ let exact = correction * Mat4::orientation(Vec3::from(authored.value_at(tm).as_vec3()));+ if rotation_angle(Mat4::orientation(Vec3::from(blend)), exact) <= BAKE_TOLERANCE_DEGREES {+ return;+ }+ let em = nearest_euler(euler_zyx(exact.0), blend);+ bake_between(correction, authored, (ta, ea), (tm, em), depth - 1, out);+ out.push(effectcraft_keyframe::Keyframe::new(tm, KV::Vec3(em)));+ bake_between(correction, authored, (tm, em), (tb, eb), depth - 1, out);+}+/// Re-expresses Orientation as `correction * Orientation`. A Z-only correction shifts Z exactly in the-/// value and every key, so the paths between keys stay exact too. Any other correction is applied-/// only to a static value (`parent_fixes` leaves keyed Orientation alone then): Euler angles are-/// blended between keys, which no re-expression of the keys can reproduce.+/// value and every key. For any other correction a static value is converted directly; keys are+/// converted, and keys are added between them wherever the Euler blend between two keys would drift+/// from the exact rotation (the segments become linear, with the original easing baked in).fn reexpress_orientation(correction: effectcraft_geom::Mat4, pr: &mut effectcraft_project::Property) {if let Some(turn) = z_only_turn(correction) {// No turn (an identity correction) leaves every authored value as it is.@@ -811,6 +849,53 @@ fn reexpress_orientation(correction: effectcraft_geom::Mat4, pr: &mut effectcraf}let value = pr.value.as_vec3();pr.value = KV::Vec3(reexpress_euler(correction, value, value));+ if pr.keys.is_empty() {+ return;+ }+ let authored = pr.clone();+ // Each key keeps the authored change from the previous key on top of its converted value.+ let mut converted: Vec<[f64; 3]> = vec![];+ let mut prev: Option<([f64; 3], [f64; 3])> = None;+ for key in &authored.keys {+ let o = key.value.as_vec3();+ let reference = match prev {+ Some((before, after)) => [after[0] + o[0] - before[0], after[1] + o[1] - before[1], after[2] + o[2] - before[2]],+ None => o,+ };+ let n = reexpress_euler(correction, o, reference);+ converted.push(n);+ prev = Some((o, n));+ }+ use effectcraft_keyframe::Interp;+ let mut keys: Vec<effectcraft_keyframe::Keyframe> = vec![];+ let mut after_baked_segment = false;+ for (i, key) in authored.keys.iter().enumerate() {+ let mut k = key.clone();+ k.value = KV::Vec3(converted[i]);+ if after_baked_segment {+ k.in_interp = Interp::Linear;+ k.in_ease.clear();+ k.auto_bezier = false;+ k.continuous = false;+ }+ after_baked_segment = false;+ let segment = authored.keys.get(i + 1).filter(|_| key.out_interp != Interp::Hold);+ let mut between = vec![];+ if let Some(next) = segment {+ bake_between(correction, &authored, (key.time, converted[i]), (next.time, converted[i + 1]), BAKE_MAX_DEPTH, &mut between);+ // An eased segment, or one that gained keys, becomes a run of straight blends.+ if !between.is_empty() || key.out_interp != Interp::Linear || next.in_interp != Interp::Linear {+ k.out_interp = Interp::Linear;+ k.out_ease.clear();+ k.auto_bezier = false;+ k.continuous = false;+ after_baked_segment = true;+ }+ }+ keys.push(k);+ keys.extend(between);+ }+ pr.keys = keys;}/// Correction for a two-node rig's Orientation: after a uniform parent change its aim is@@ -912,10 +997,6 @@ pub(crate) fn parent_fixes(s: &Session, cid: ItemId, ids: &[LayerId], parent: Opif !correction.0.iter().flatten().all(|v| v.is_finite()) || !orientation_finite {return None;}- // Keys can only follow a Z-only correction exactly; otherwise they stay authored.- if !orientation.keys.is_empty() && z_only_turn(correction).is_none() {- return None;- }if let Some(scale) = scale {let values_finite = std::iter::once(&scale.value).chain(scale.keys.iter().map(|key| &key.value))diff --git a/crates/engine/src/tests_rig3d.rs b/crates/engine/src/tests_rig3d.rsindex ecae51cb1..d867337ac 100644--- a/crates/engine/src/tests_rig3d.rs+++ b/crates/engine/src/tests_rig3d.rs@@ -300,20 +300,27 @@ fn keyed_orientation_under_a_z_turn_keeps_the_direction_at_every_time() {}}-/// Under a tilted null the keys cannot follow exactly (Euler angles are blended between them), so-/// keyed Orientation stays as authored rather than changing the motion between the keys.+/// Under a tilted null the keys alone cannot follow (Euler angles are blended between them), so keys are+/// added between them: the light keeps its direction within a small angle at every time.#[test]-fn keyed_orientation_under_a_tilted_null_stays_authored() {- let mut s = session();- let light = s.execute("layer.newLight", json!({"kind": "Point", "position": [320, 180, -500]})).unwrap()["layer"].as_u64().unwrap();- for (time, value) in [(0.0, json!([-8.0, 12.0, -13.0])), (1.0, json!([5.0, 18.0, 14.0]))] {- s.execute("prop.addKey", json!({"layer": light, "path": "transform/orientation", "time": time, "value": value})).unwrap();+fn keyed_orientation_under_a_tilted_null_follows_between_the_keys() {+ {+ let mut s = session();+ let light = s.execute("layer.newLight", json!({"kind": "Point", "position": [320, 180, -500]})).unwrap()["layer"].as_u64().unwrap();+ for (time, value) in [(0.0, json!([-8.0, 12.0, -13.0])), (1.5, json!([50.0, 118.0, 74.0]))] {+ s.execute("prop.addKey", json!({"layer": light, "path": "transform/orientation", "time": time, "value": value})).unwrap();+ }+ let times = [0.0, 0.2, 0.5, 0.9, 1.3, 1.5].map(Tick::from_seconds_f64);+ let before = times.map(|t| frame_at(&s, light, t));+ let nul = rotated_null(&mut s, [20.0, -35.0, 60.0], 30.0);+ s.execute("layer.setParent", json!({"layers": [light], "parent": nul})).unwrap();+ for (t, b) in times.into_iter().zip(before) {+ let a = frame_at(&s, light, t);+ // 0.05 degrees is about 9e-4 of a radian on a unit vector.+ assert!((a.0 - b.0).length() < 1e-6 && (a.1 - b.1).length() < 2e-3, "at {t:?}: {:?} vs {:?}", a.1, b.1);+ }+ assert!(layer_in(&s, cid(&s), light).props.prop("transform/orientation").unwrap().keys.len() > 2, "keys were added between the two");}- let keys_before = layer_in(&s, cid(&s), light).props.prop("transform/orientation").unwrap().keys.iter().map(|k| k.value.as_vec3()).collect::<Vec<_>>();- let nul = rotated_null(&mut s, [20.0, -35.0, 60.0], 30.0);- s.execute("layer.setParent", json!({"layers": [light], "parent": nul})).unwrap();- let keys_after = layer_in(&s, cid(&s), light).props.prop("transform/orientation").unwrap().keys.iter().map(|k| k.value.as_vec3()).collect::<Vec<_>>();- assert_eq!(keys_before, keys_after);}// ---------------------------------------------------------------- from 3D model