bevy_transform 0.1.0

Provides hierarchy and transform functionality for Bevy Engine
Documentation 
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

use crate::components::*;
use bevy_ecs::prelude::*;
use bevy_math::{Mat4, Quat, Vec3};

// TODO: "on changed" for all of these systems
pub fn local_transform_translation_system(
    mut query: Query<
        Without<
            Rotation,
            Without<Scale, Without<NonUniformScale, (&mut LocalTransform, &Translation)>>,
        >,
    >,
) {
    for (mut local, translation) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_translation(translation.0));
    }
}

pub fn local_transform_rotation_system(
    mut query: Query<
        Without<
            Translation,
            Without<Scale, Without<NonUniformScale, (&mut LocalTransform, &Rotation)>>,
        >,
    >,
) {
    for (mut local, rotation) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_quat(rotation.0));
    }
}

pub fn local_transform_scale_system(
    mut query: Query<
        Without<
            Translation,
            Without<Rotation, Without<NonUniformScale, (&mut LocalTransform, &Scale)>>,
        >,
    >,
) {
    for (mut local, scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale(Vec3::new(scale.0, scale.0, scale.0)));
    }
}

pub fn local_transform_non_uniform_scale_system(
    mut query: Query<
        Without<
            Translation,
            Without<Rotation, Without<Scale, (&mut LocalTransform, &NonUniformScale)>>,
        >,
    >,
) {
    for (mut local, non_uniform_scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale(non_uniform_scale.0));
    }
}

pub fn local_transform_translation_rotation_system(
    mut query: Query<
        Without<Scale, Without<NonUniformScale, (&mut LocalTransform, &Translation, &Rotation)>>,
    >,
) {
    for (mut local, translation, rotation) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_rotation_translation(rotation.0, translation.0));
    }
}

pub fn local_transform_translation_scale_system(
    mut query: Query<
        Without<Rotation, Without<NonUniformScale, (&mut LocalTransform, &Translation, &Scale)>>,
    >,
) {
    for (mut local, translation, scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale_rotation_translation(
            Vec3::new(scale.0, scale.0, scale.0),
            Quat::default(),
            translation.0,
        ));
    }
}

pub fn local_transform_translation_non_uniform_scale_system(
    mut query: Query<
        Without<Rotation, Without<Scale, (&mut LocalTransform, &Translation, &NonUniformScale)>>,
    >,
) {
    for (mut local, translation, non_uniform_scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale_rotation_translation(
            non_uniform_scale.0,
            Quat::default(),
            translation.0,
        ));
    }
}

pub fn local_transform_rotation_scale_system(
    mut query: Query<
        Without<Translation, Without<NonUniformScale, (&mut LocalTransform, &Rotation, &Scale)>>,
    >,
) {
    for (mut local, rotation, scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale_rotation_translation(
            Vec3::new(scale.0, scale.0, scale.0),
            rotation.0,
            Vec3::default(),
        ));
    }
}

pub fn local_transform_rotation_non_uniform_scale_system(
    mut query: Query<
        Without<Translation, Without<Scale, (&mut LocalTransform, &Rotation, &NonUniformScale)>>,
    >,
) {
    for (mut local, rotation, non_uniform_scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale_rotation_translation(
            non_uniform_scale.0,
            rotation.0,
            Vec3::default(),
        ));
    }
}

pub fn local_transform_translation_rotation_scale_system(
    mut query: Query<
        Without<NonUniformScale, (&mut LocalTransform, &Translation, &Rotation, &Scale)>,
    >,
) {
    for (mut local, translation, rotation, scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale_rotation_translation(
            Vec3::new(scale.0, scale.0, scale.0),
            rotation.0,
            translation.0,
        ));
    }
}

pub fn local_transform_translation_rotation_non_uniform_scale_system(
    mut query: Query<
        Without<
            Scale,
            (
                &mut LocalTransform,
                &Translation,
                &Rotation,
                &NonUniformScale,
            ),
        >,
    >,
) {
    for (mut local, translation, rotation, non_uniform_scale) in &mut query.iter() {
        *local = LocalTransform(Mat4::from_scale_rotation_translation(
            non_uniform_scale.0,
            rotation.0,
            translation.0,
        ));
    }
}

pub fn local_transform_systems() -> Vec<Box<dyn System>> {
    vec![
        local_transform_translation_system.system(),
        local_transform_rotation_system.system(),
        local_transform_scale_system.system(),
        local_transform_non_uniform_scale_system.system(),
        local_transform_translation_rotation_system.system(),
        local_transform_translation_scale_system.system(),
        local_transform_translation_non_uniform_scale_system.system(),
        local_transform_rotation_scale_system.system(),
        local_transform_rotation_non_uniform_scale_system.system(),
        local_transform_translation_rotation_scale_system.system(),
        local_transform_translation_rotation_non_uniform_scale_system.system(),
    ]
}

#[cfg(test)]
mod test {
    use super::*;
    use bevy_ecs::{Resources, Schedule, World};
    use bevy_math::{Mat4, Quat, Vec3};

    #[test]
    fn correct_local_transformation() {
        let mut world = World::default();
        let mut resources = Resources::default();

        let mut schedule = Schedule::default();
        schedule.add_stage("update");
        for system in local_transform_systems() {
            schedule.add_system_to_stage("update", system);
        }

        let local_transform = LocalTransform::identity();
        let t = Translation::new(1.0, 2.0, 3.0);
        let r = Rotation(Quat::from_rotation_ypr(1.0, 2.0, 3.0));
        let s = Scale(2.0);
        let nus = NonUniformScale::new(1.0, 2.0, 3.0);

        // Add every combination of transform types.
        let translation = world.spawn((local_transform, t));
        let rotation = world.spawn((local_transform, r));
        let scale = world.spawn((local_transform, s));
        let non_uniform_scale = world.spawn((local_transform, nus));
        let translation_and_rotation = world.spawn((local_transform, t, r));
        let translation_and_scale = world.spawn((local_transform, t, s));
        let translation_and_nus = world.spawn((local_transform, t, nus));
        let rotation_scale = world.spawn((local_transform, r, s));
        let rotation_nus = world.spawn((local_transform, r, nus));
        let translation_rotation_scale = world.spawn((local_transform, t, r, s));
        let translation_rotation_nus = world.spawn((local_transform, t, r, nus));

        // Run the system
        schedule.run(&mut world, &mut resources);

        // Verify that each was transformed correctly.
        assert_eq!(
            world.get::<LocalTransform>(translation).unwrap().0,
            Mat4::from_translation(t.0)
        );
        assert_eq!(
            world.get::<LocalTransform>(rotation).unwrap().0,
            Mat4::from_quat(r.0)
        );
        assert_eq!(
            world.get::<LocalTransform>(scale).unwrap().0,
            Mat4::from_scale(Vec3::new(s.0, s.0, s.0))
        );
        assert_eq!(
            world.get::<LocalTransform>(non_uniform_scale).unwrap().0,
            Mat4::from_scale(nus.0)
        );
        assert_eq!(
            world
                .get::<LocalTransform>(translation_and_rotation)
                .unwrap()
                .0,
            Mat4::from_rotation_translation(r.0, t.0)
        );
        assert_eq!(
            world
                .get::<LocalTransform>(translation_and_scale)
                .unwrap()
                .0,
            Mat4::from_scale_rotation_translation(Vec3::new(s.0, s.0, s.0), Quat::default(), t.0)
        );
        assert_eq!(
            world.get::<LocalTransform>(translation_and_nus).unwrap().0,
            Mat4::from_scale_rotation_translation(nus.0, Quat::default(), t.0)
        );
        assert_eq!(
            world.get::<LocalTransform>(rotation_scale).unwrap().0,
            Mat4::from_scale_rotation_translation(Vec3::new(s.0, s.0, s.0), r.0, Vec3::default())
        );
        assert_eq!(
            world.get::<LocalTransform>(rotation_nus).unwrap().0,
            Mat4::from_scale_rotation_translation(nus.0, r.0, Vec3::default())
        );
        assert_eq!(
            world
                .get::<LocalTransform>(translation_rotation_scale)
                .unwrap()
                .0,
            Mat4::from_scale_rotation_translation(Vec3::new(s.0, s.0, s.0), r.0, t.0)
        );
        assert_eq!(
            world
                .get::<LocalTransform>(translation_rotation_nus)
                .unwrap()
                .0,
            Mat4::from_scale_rotation_translation(nus.0, r.0, t.0)
        );
    }
}