Add Vpeol3dSnapToPlane

Author: idanarye

CHANGELOG.md

@@ -48,6 +48,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - UI editing support for `Vpeol3dScale` with separate X, Y, Z drag values.
 - UI editing support for `Vpeol2dRotatation` using degrees.
 - UI editing support for `Vpeol2dScale` with separate X, Y drag values.
+- `Vpeol3dSnapToPlane` to force an entity on a specific plane.
 
 ### Changed
 - Improved editor ergonomics with better organized workspace instead of single

assets/levels3d/example.yol

@@ -1 +1 @@
-[{"format_version":2,"app_format_version":0},{},[[{"type":"Planet","name":"","uuid":"c8aa8fdd-5431-473c-8774-b069c95f794f"},{"PlanetSettings":{"radius":1.0},"Vpeol3dPosition":[-7.047080993652344,6.785710334777832,0.0]}],[{"type":"Planet","name":"","uuid":"2d676a47-146f-49f0-bba7-cf58a8833b1f"},{"PlanetSettings":{"radius":1.0},"Vpeol3dPosition":[16.688783645629883,-3.0687923431396484,0.0]}],[{"type":"PlanetPointer","name":""},{"LaserPointer":{"target":{"uuid":"c8aa8fdd-5431-473c-8774-b069c95f794f"}},"Vpeol3dPosition":[15.614945411682129,-6.67572021484375e-6,-34.80355453491211]}],[{"type":"Spaceship","name":""},{"SpaceshipSettings":{"enabled":true,"rotation_speed":2.0,"speed":2.0},"Vpeol3dPosition":[1.2451118230819702,-2.86102294921875e-6,21.062850952148438]}]]]
+[{"format_version":2,"app_format_version":0},{},[[{"type":"Planet","name":"","uuid":"c8aa8fdd-5431-473c-8774-b069c95f794f"},{"Vpeol3dPosition":[-7.047080993652344,6.785710334777832,0.0],"Vpeol3dRotation":[0.0,0.0,0.0,1.0],"Vpeol3dScale":[1.0,1.0,1.0]}],[{"type":"Planet","name":"","uuid":"2d676a47-146f-49f0-bba7-cf58a8833b1f"},{"Vpeol3dPosition":[16.688783645629883,-3.0687923431396484,0.0],"Vpeol3dRotation":[0.0,0.0,0.0,1.0],"Vpeol3dScale":[1.0,1.0,1.0]}],[{"type":"Spaceship","name":""},{"SpaceshipSettings":{"enabled":true,"rotation_speed":2.0,"speed":2.0},"Vpeol3dPosition":[1.2451118230819702,-2.86102294921875e-6,21.062850952148438]}],[{"type":"PlanetPointer","name":""},{"LaserPointer":{"target":{"uuid":"c8aa8fdd-5431-473c-8774-b069c95f794f"}},"Vpeol3dPosition":[3.227558135986328,2.0,-29.523635864257812]}]]]

examples/example3d.rs

@@ -71,6 +71,10 @@ fn main() {
             .with::<Vpeol3dPosition>()
             .with::<LaserPointer>()
             .insert_on_init(|| SimpleSphere)
+            .insert_on_init_during_editor(|| Vpeol3dSnapToPlane {
+                normal: Dir3::Y,
+                offset: 2.0,
+            })
     });
     app.add_yoleck_auto_edit::<LaserPointer>();
     app.add_systems(YoleckSchedule::Populate, populate_simple_sphere);

src/vpeol.rs

@@ -37,8 +37,8 @@ pub mod prelude {
     #[cfg(feature = "vpeol_3d")]
     pub use crate::vpeol_3d::{
         Vpeol3dCameraControl, Vpeol3dCameraMode, Vpeol3dPluginForEditor, Vpeol3dPluginForGame,
-        Vpeol3dPosition, Vpeol3dRotation, Vpeol3dScale, Vpeol3dTranslationGizmoConfig,
-        Vpeol3dTranslationGizmoMode, YoleckCameraChoices,
+        Vpeol3dPosition, Vpeol3dRotation, Vpeol3dScale, Vpeol3dSnapToPlane,
+        Vpeol3dTranslationGizmoConfig, Vpeol3dTranslationGizmoMode, YoleckCameraChoices,
     };
 }
 

src/vpeol_3d.rs

@@ -1030,6 +1030,23 @@ pub fn vpeol_3d_camera_mode_selector(
 #[cfg_attr(feature = "bevy_reflect", derive(bevy::reflect::Reflect))]
 pub struct Vpeol3dPosition(pub Vec3);
 
+/// Add this to an entity with [`Vpeol3dPosition`] to force it to be on a specific plane while
+/// editing.
+///
+/// This is useful for 2D games that use 3D graphics but don't want to allow free positioning of
+/// entities on all axes.
+///
+/// Note that this is not a [`YoleckComponent`]. Do not add it with
+/// [`insert_on_init_during_editor`](YoleckEntityType::with). The best way to add it is by using
+/// [`insert_on_init_during_editor`](YoleckEntityType::insert_on_init_during_editor) which also
+/// allows setting the data.
+#[derive(Component)]
+pub struct Vpeol3dSnapToPlane {
+    pub normal: Dir3,
+    /// Offset of the plane from the origin of axes
+    pub offset: f32,
+}
+
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum Vpeol3dTranslationGizmoMode {
     World,
@@ -1113,7 +1130,12 @@ impl CommonDragPlane {
 
 fn vpeol_3d_edit_transform_group(
     mut ui: ResMut<YoleckUi>,
-    position_edit: YoleckEdit<(Entity, &mut Vpeol3dPosition, Option<&VpeolDragPlane>)>,
+    position_edit: YoleckEdit<(
+        Entity,
+        &mut Vpeol3dPosition,
+        Option<&VpeolDragPlane>,
+        Option<&Vpeol3dSnapToPlane>,
+    )>,
     rotation_edit: YoleckEdit<&mut Vpeol3dRotation>,
     scale_edit: YoleckEdit<&mut Vpeol3dScale>,
     global_drag_plane: Res<VpeolDragPlane>,
@@ -1136,7 +1158,12 @@ fn vpeol_3d_edit_transform_group(
 
 fn vpeol_3d_edit_position_impl(
     ui: &mut egui::Ui,
-    mut edit: YoleckEdit<(Entity, &mut Vpeol3dPosition, Option<&VpeolDragPlane>)>,
+    mut edit: YoleckEdit<(
+        Entity,
+        &mut Vpeol3dPosition,
+        Option<&VpeolDragPlane>,
+        Option<&Vpeol3dSnapToPlane>,
+    )>,
     global_drag_plane: &VpeolDragPlane,
     passed_data: &YoleckPassedData,
 ) {
@@ -1149,7 +1176,7 @@ fn vpeol_3d_edit_position_impl(
 
     let mut common_drag_plane = CommonDragPlane::NotDecidedYet;
 
-    for (entity, position, drag_plane) in edit.iter_matching() {
+    for (entity, position, drag_plane, _) in edit.iter_matching() {
         let VpeolDragPlane(drag_plane) = drag_plane.unwrap_or(global_drag_plane);
         common_drag_plane.consider(*drag_plane.normal);
 
@@ -1180,8 +1207,12 @@ fn vpeol_3d_edit_position_impl(
     });
 
     if transition.is_finite() && transition != Vec3::ZERO {
-        for (_, mut position, _) in edit.iter_matching_mut() {
+        for (_, mut position, _, snap) in edit.iter_matching_mut() {
             position.0 += transition;
+            if let Some(snap) = snap {
+                let displacement = position.0.project_onto(*snap.normal);
+                position.0 += snap.offset * snap.normal - displacement;
+            }
         }
     }
 }