mittens-engine 0.7.0

A Vulkan and OpenXR scene engine with ECS, reactive signals, and Meow Meow scripting
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357

use crate::engine::ecs::RxWorld;
use crate::engine::ecs::rx::signal_pipeline::SignalPipelineOp;
use crate::engine::ecs::{ComponentId, IntentValue, Signal, World};

/// Pre-execution processor for intent signals.
///
/// This is intended to become the hook point for intent routing/forwarding based on
/// per-target “pipeline” components in the ECS topology.
///
/// Current behavior: no-op passthrough.
#[derive(Debug, Default)]
pub struct SignalPipelineProcessor;

impl SignalPipelineProcessor {
    pub fn new() -> Self {
        Self::default()
    }

    /// Process an intent-containing signal envelope before it is executed.
    ///
    /// This is a no-op for now (returns `env` unchanged).
    pub fn process_intent(&mut self, world: &World, rx: &RxWorld, mut env: Signal) -> Signal {
        let Some(intent) = env.intent.as_mut() else {
            return env;
        };

        let kind_name = intent.value.kind_name();

        let Some(component_id) = Self::recipient_component_id_mut(&mut intent.value) else {
            return env;
        };

        let mut routed = *component_id;
        for pipeline in rx.pipelines_for_component(*component_id).iter() {
            for op in pipeline.ops.iter() {
                match op {
                    SignalPipelineOp::RouteUpward(r) => {
                        if r.applies_to_intent_kind(kind_name) {
                            routed = r.route(world, routed);
                        }
                    }
                }
            }
        }
        *component_id = routed;

        env
    }

    /// Returns the standardized intent recipients, if the intent variant has them.
    pub fn recipient_component_id(value: &IntentValue) -> Option<ComponentId> {
        match value {
            IntentValue::SetColor { component_id, .. }
            | IntentValue::SetText { component_id, .. }
            | IntentValue::SetEmissiveIntensity { component_id, .. }
            | IntentValue::SetPosition { component_id, .. }
            | IntentValue::LookAt { component_id, .. }
            | IntentValue::GLTFArmatureVisible { component_id, .. }
            | IntentValue::SetLayoutAvailableWidth { component_id, .. }
            | IntentValue::SetLayoutAvailableHeight { component_id, .. }
            | IntentValue::SetLayoutInspect { component_id, .. }
            | IntentValue::SelectionSet { component_id, .. }
            | IntentValue::ToggleSet { component_id, .. }
            | IntentValue::CollisionVisualizationSet { component_id, .. }
            | IntentValue::SpringBoneVisualizationSet { component_id, .. }
            | IntentValue::CameraVisualizationSet { component_id, .. }
            | IntentValue::Detach { component_id }
            | IntentValue::RemoveSubtree { component_id }
            | IntentValue::AudioGraphRebuild { component_id }
            | IntentValue::RequestRaycast { component_id }
            | IntentValue::AudioLowPassSetCutoffHz { component_id, .. }
            | IntentValue::AudioBandPassSetCenterHz { component_id, .. }
            | IntentValue::OscillatorSetEnabled { component_id, .. }
            | IntentValue::OscillatorSetPitch { component_id, .. }
            | IntentValue::OscillatorScheduleSetPitch { component_id, .. }
            | IntentValue::AudioSchedulePlay { component_id, .. }
            | IntentValue::RegisterRenderable { component_id }
            | IntentValue::RemoveRenderable { component_id }
            | IntentValue::RegisterStencilClip { component_id }
            | IntentValue::UnregisterStencilClip { component_id }
            | IntentValue::RegisterRouter { component_id }
            | IntentValue::RegisterHttpServer { component_id }
            | IntentValue::RegisterHttpClient { component_id }
            | IntentValue::RegisterScrolling { component_id }
            | IntentValue::RegisterTransform { component_id }
            | IntentValue::UpdateTransform { component_id, .. }
            | IntentValue::RemoveTransform { component_id }
            | IntentValue::RegisterCamera3d { component_id }
            | IntentValue::RegisterCamera2d { component_id }
            | IntentValue::MakeActiveCamera { component_id }
            | IntentValue::RegisterInput { component_id }
            | IntentValue::RegisterUv { component_id }
            | IntentValue::RegisterLight { component_id }
            | IntentValue::RegisterColor { component_id }
            | IntentValue::RegisterOpacity { component_id }
            | IntentValue::RegisterTransparentCutout { component_id }
            | IntentValue::RegisterBackgroundColor { component_id }
            | IntentValue::RegisterRendererSettings { component_id }
            | IntentValue::RegisterRenderGraph { component_id }
            | IntentValue::RegisterAmbientLight { component_id }
            | IntentValue::RegisterEmissive { component_id }
            | IntentValue::RegisterLightQuantization { component_id }
            | IntentValue::RegisterTexture { component_id }
            | IntentValue::RegisterTextureFiltering { component_id }
            | IntentValue::RegisterText { component_id }
            | IntentValue::RegisterGLTF { component_id }
            | IntentValue::RegisterTextInput { component_id }
            | IntentValue::RegisterCollision { component_id }
            | IntentValue::RemoveCollision { component_id }
            | IntentValue::RegisterCollisionResponse { component_id }
            | IntentValue::RemoveCollisionResponse { component_id }
            | IntentValue::RegisterAvatarControl { component_id }
            | IntentValue::RegisterAvatarBodyYaw { component_id }
            | IntentValue::RegisterIkChain { component_id }
            | IntentValue::RegisterSecondaryMotion { component_id }
            | IntentValue::SecondaryMotionConfigurationChanged { component_id }
            | IntentValue::SecondaryMotionTopologyChanged { component_id }
            | IntentValue::SecondaryMotionGltfInitialized { component_id }
            | IntentValue::UnregisterSecondaryMotion { component_id }
            | IntentValue::ResetSecondaryMotion { component_id }
            | IntentValue::RegisterXr { component_id }
            | IntentValue::RegisterInputXr { component_id }
            | IntentValue::RegisterControllerXr { component_id }
            | IntentValue::RegisterInputXrGamepad { component_id }
            | IntentValue::RemoveInputXr { component_id }
            | IntentValue::RemoveControllerXr { component_id }
            | IntentValue::RemoveInputXrGamepad { component_id }
            | IntentValue::RegisterRaycast { component_id }
            | IntentValue::RegisterRaycastable { component_id }
            | IntentValue::RegisterPointer { component_id }
            | IntentValue::RegisterGrabbable { component_id }
            | IntentValue::RegisterDraggable { component_id }
            | IntentValue::RemoveRaycast { component_id }
            | IntentValue::RemoveRaycastable { component_id }
            | IntentValue::RegisterAnimation { component_id }
            | IntentValue::SetAnimationState { component_id, .. }
            | IntentValue::RegisterKeyframe { component_id }
            | IntentValue::RegisterAudioOutput { component_id }
            | IntentValue::AudioGraphDirtyImmediate { component_id }
            | IntentValue::RegisterAudioOscillator { component_id }
            | IntentValue::RegisterAudioClip { component_id }
            | IntentValue::RegisterAudioBufferSize { component_id }
            | IntentValue::RegisterClock { component_id }
            | IntentValue::RegisterTransformGizmo { component_id }
            | IntentValue::RegisterNormalVis { component_id }
            | IntentValue::RegisterEditor { component_id }
            | IntentValue::RegisterEditorUI { component_id }
            | IntentValue::ScheduleAudioOp { component_id, .. }
            | IntentValue::ScheduleAudioGraphSwap { component_id, .. }
            | IntentValue::ScheduleAudioPitchSetHz { component_id, .. }
            | IntentValue::ScheduleAudioOscillatorEnabled { component_id, .. }
            | IntentValue::ScheduleAudioGainSet { component_id, .. } => Some(*component_id),

            IntentValue::Noop
            | IntentValue::RetryXrRuntime
            | IntentValue::Print { .. }
            | IntentValue::ReplExec { .. }
            | IntentValue::Attach { .. }
            | IntentValue::AttachClone { .. }
            | IntentValue::QueryFindComponent { .. }
            | IntentValue::QueryFindAllComponents { .. }
            | IntentValue::RemoveChild { .. }
            | IntentValue::RemoveChildren { .. }
            | IntentValue::UpdateTransformWorld { .. }
            | IntentValue::TextInputSetFocus { .. }
            | IntentValue::TextInputClearFocus
            | IntentValue::TextInputInsertText { .. }
            | IntentValue::TextInputBackspace
            | IntentValue::TextInputDeleteForward
            | IntentValue::TextInputMoveCaret { .. }
            | IntentValue::TextInputMoveCaretTo { .. }
            | IntentValue::RegisterSignalRouteUpward { .. }
            | IntentValue::RemoveSignalRouteUpward { .. }
            | IntentValue::SpawnComponentTree { .. }
            | IntentValue::InitializePoseCapture { .. }
            | IntentValue::PoseCapture { .. }
            | IntentValue::PoseApply { .. }
            | IntentValue::PoseReset { .. }
            | IntentValue::HttpClientRequest { .. }
            | IntentValue::HttpServerReply { .. } => None,
        }
    }

    fn recipient_component_id_mut(value: &mut IntentValue) -> Option<&mut ComponentId> {
        match value {
            IntentValue::SetColor { component_id, .. }
            | IntentValue::SetText { component_id, .. }
            | IntentValue::SetEmissiveIntensity { component_id, .. }
            | IntentValue::SetPosition { component_id, .. }
            | IntentValue::LookAt { component_id, .. }
            | IntentValue::GLTFArmatureVisible { component_id, .. }
            | IntentValue::SetLayoutAvailableWidth { component_id, .. }
            | IntentValue::SetLayoutAvailableHeight { component_id, .. }
            | IntentValue::SetLayoutInspect { component_id, .. }
            | IntentValue::SelectionSet { component_id, .. }
            | IntentValue::ToggleSet { component_id, .. }
            | IntentValue::CollisionVisualizationSet { component_id, .. }
            | IntentValue::SpringBoneVisualizationSet { component_id, .. }
            | IntentValue::CameraVisualizationSet { component_id, .. }
            | IntentValue::Detach { component_id }
            | IntentValue::RemoveSubtree { component_id }
            | IntentValue::AudioGraphRebuild { component_id }
            | IntentValue::RequestRaycast { component_id }
            | IntentValue::AudioLowPassSetCutoffHz { component_id, .. }
            | IntentValue::AudioBandPassSetCenterHz { component_id, .. }
            | IntentValue::OscillatorSetEnabled { component_id, .. }
            | IntentValue::OscillatorSetPitch { component_id, .. }
            | IntentValue::OscillatorScheduleSetPitch { component_id, .. }
            | IntentValue::AudioSchedulePlay { component_id, .. }
            | IntentValue::RegisterRenderable { component_id }
            | IntentValue::RemoveRenderable { component_id }
            | IntentValue::RegisterStencilClip { component_id }
            | IntentValue::UnregisterStencilClip { component_id }
            | IntentValue::RegisterRouter { component_id }
            | IntentValue::RegisterHttpServer { component_id }
            | IntentValue::RegisterHttpClient { component_id }
            | IntentValue::RegisterScrolling { component_id }
            | IntentValue::RegisterTransform { component_id }
            | IntentValue::UpdateTransform { component_id, .. }
            | IntentValue::RemoveTransform { component_id }
            | IntentValue::RegisterCamera3d { component_id }
            | IntentValue::RegisterCamera2d { component_id }
            | IntentValue::MakeActiveCamera { component_id }
            | IntentValue::RegisterInput { component_id }
            | IntentValue::RegisterUv { component_id }
            | IntentValue::RegisterLight { component_id }
            | IntentValue::RegisterColor { component_id }
            | IntentValue::RegisterOpacity { component_id }
            | IntentValue::RegisterTransparentCutout { component_id }
            | IntentValue::RegisterBackgroundColor { component_id }
            | IntentValue::RegisterRendererSettings { component_id }
            | IntentValue::RegisterRenderGraph { component_id }
            | IntentValue::RegisterAmbientLight { component_id }
            | IntentValue::RegisterEmissive { component_id }
            | IntentValue::RegisterLightQuantization { component_id }
            | IntentValue::RegisterTexture { component_id }
            | IntentValue::RegisterTextureFiltering { component_id }
            | IntentValue::RegisterText { component_id }
            | IntentValue::RegisterGLTF { component_id }
            | IntentValue::RegisterTextInput { component_id }
            | IntentValue::RegisterCollision { component_id }
            | IntentValue::RemoveCollision { component_id }
            | IntentValue::RegisterCollisionResponse { component_id }
            | IntentValue::RemoveCollisionResponse { component_id }
            | IntentValue::RegisterAvatarControl { component_id }
            | IntentValue::RegisterAvatarBodyYaw { component_id }
            | IntentValue::RegisterIkChain { component_id }
            | IntentValue::RegisterSecondaryMotion { component_id }
            | IntentValue::SecondaryMotionConfigurationChanged { component_id }
            | IntentValue::SecondaryMotionTopologyChanged { component_id }
            | IntentValue::SecondaryMotionGltfInitialized { component_id }
            | IntentValue::UnregisterSecondaryMotion { component_id }
            | IntentValue::ResetSecondaryMotion { component_id }
            | IntentValue::RegisterXr { component_id }
            | IntentValue::RegisterInputXr { component_id }
            | IntentValue::RegisterControllerXr { component_id }
            | IntentValue::RegisterInputXrGamepad { component_id }
            | IntentValue::RemoveInputXr { component_id }
            | IntentValue::RemoveControllerXr { component_id }
            | IntentValue::RemoveInputXrGamepad { component_id }
            | IntentValue::RegisterRaycast { component_id }
            | IntentValue::RegisterRaycastable { component_id }
            | IntentValue::RegisterPointer { component_id }
            | IntentValue::RegisterGrabbable { component_id }
            | IntentValue::RegisterDraggable { component_id }
            | IntentValue::RemoveRaycast { component_id }
            | IntentValue::RemoveRaycastable { component_id }
            | IntentValue::RegisterAnimation { component_id }
            | IntentValue::SetAnimationState { component_id, .. }
            | IntentValue::RegisterKeyframe { component_id }
            | IntentValue::RegisterAudioOutput { component_id }
            | IntentValue::AudioGraphDirtyImmediate { component_id }
            | IntentValue::RegisterAudioOscillator { component_id }
            | IntentValue::RegisterAudioClip { component_id }
            | IntentValue::RegisterAudioBufferSize { component_id }
            | IntentValue::RegisterClock { component_id }
            | IntentValue::RegisterTransformGizmo { component_id }
            | IntentValue::RegisterNormalVis { component_id }
            | IntentValue::RegisterEditor { component_id }
            | IntentValue::RegisterEditorUI { component_id }
            | IntentValue::ScheduleAudioOp { component_id, .. }
            | IntentValue::ScheduleAudioGraphSwap { component_id, .. }
            | IntentValue::ScheduleAudioPitchSetHz { component_id, .. }
            | IntentValue::ScheduleAudioOscillatorEnabled { component_id, .. }
            | IntentValue::ScheduleAudioGainSet { component_id, .. } => Some(component_id),

            IntentValue::RegisterSignalRouteUpward { .. }
            | IntentValue::RemoveSignalRouteUpward { .. }
            | IntentValue::Noop
            | IntentValue::RetryXrRuntime
            | IntentValue::Print { .. }
            | IntentValue::ReplExec { .. }
            | IntentValue::Attach { .. }
            | IntentValue::AttachClone { .. }
            | IntentValue::QueryFindComponent { .. }
            | IntentValue::QueryFindAllComponents { .. }
            | IntentValue::RemoveChild { .. }
            | IntentValue::RemoveChildren { .. } => None,

            IntentValue::UpdateTransformWorld { .. } => None,
            IntentValue::TextInputSetFocus { .. } => None,
            IntentValue::TextInputClearFocus => None,
            IntentValue::TextInputInsertText { .. } => None,
            IntentValue::TextInputBackspace => None,
            IntentValue::TextInputDeleteForward => None,
            IntentValue::TextInputMoveCaret { .. } => None,
            IntentValue::TextInputMoveCaretTo { .. } => None,
            IntentValue::SpawnComponentTree { .. }
            | IntentValue::InitializePoseCapture { .. }
            | IntentValue::PoseCapture { .. }
            | IntentValue::PoseApply { .. }
            | IntentValue::PoseReset { .. }
            | IntentValue::HttpClientRequest { .. }
            | IntentValue::HttpServerReply { .. } => None,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::engine::ecs::component::{
        ColorComponent, SignalRouteUpwardComponent, TransformComponent,
    };
    use crate::engine::ecs::system::PipelineSystem;
    use crate::engine::ecs::{IntentSignal, Signal};

    #[test]
    fn routing_rewrites_one_recipient_and_preserves_scope() {
        let mut world = World::default();
        let routed_parent = world.add_component(TransformComponent::new());
        let recipient = world.add_component(ColorComponent::rgba(1.0, 1.0, 1.0, 1.0));
        let operator =
            world.add_component(SignalRouteUpwardComponent::new("set_color", "transform"));
        world.add_child(routed_parent, recipient).unwrap();
        world.add_child(recipient, operator).unwrap();

        let mut rx = RxWorld::default();
        PipelineSystem.register_signal_route_upward(&world, &mut rx, operator);
        let scope = operator;
        let signal = Signal::intent(
            scope,
            IntentSignal::now(IntentValue::SetColor {
                component_id: recipient,
                rgba: [0.0, 0.0, 0.0, 1.0],
            }),
        );

        let output = SignalPipelineProcessor.process_intent(&world, &rx, signal);
        assert_eq!(output.scope, scope);
        assert!(matches!(
            output.intent.map(|intent| intent.value),
            Some(IntentValue::SetColor { component_id, .. })
                if component_id == routed_parent
        ));
    }
}