rmf_site_picking 0.0.2

Picking utilities and workflows for rmf_site_editor
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

use bevy_derive::{Deref, DerefMut};
use bevy_ecs::prelude::*;
use crossflow::Service;

use crate::SelectionCandidate;

#[derive(Debug, Clone, Copy, Event)]
pub struct RunSelector {
    /// The select workflow will run this service until it terminates and then
    /// revert back to the inspector selector.
    pub selector: Service<Option<Entity>, ()>,
    /// If there is input for the selector, it will be stored in a [`SelectorInput`][1]
    /// component in this entity. The entity will be despawned as soon as the
    /// input is extracted.
    ///
    /// [1]: crate::select::components::SelectorInput
    pub input: Option<Entity>,
}

/// Used as an event to command a change in the hovered entity.
#[derive(Default, Debug, Clone, Copy, Deref, DerefMut, Event)]
pub struct Hover(pub Option<Entity>);

/// Used as an event to command a change in the selected entity.
#[derive(Default, Debug, Clone, Copy, Deref, DerefMut, Event)]
pub struct Select(pub Option<SelectionCandidate>);

impl Select {
    pub fn new(candidate: Option<Entity>) -> Select {
        Select(candidate.map(|c| SelectionCandidate::new(c)))
    }

    pub fn provisional(candidate: Entity) -> Select {
        Select(Some(SelectionCandidate::provisional(candidate)))
    }
}

/// Used as an event to command a change in the double clicked entity.
#[derive(Debug, Clone, Copy, Deref, DerefMut, Event)]
pub struct DoubleClickSelect(pub Entity);