Struct Reference 

pub struct Reference {
    pub label: String,
    pub accepts: Vec<String>,
    pub value: Vec<Picked>,
    pub multiple: bool,
    pub required: bool,
    pub armed: bool,
    pub preview: Preview,
}

Elements of the part a step builds on, picked in the viewport: any element of one of the kinds accepts (see geop_core_program::element::Kind::NAME). One element, or — multiple — any number, a pick adding or taking out one. Which of them the step can use is the operation’s to say, in what it holds (Picked::tone).

The editor does all of the editing (see crate::step_editor): arming it for picks, removing and clearing elements. An operation only ever gets what it holds now, as super::Value::Elements.

Fields

label: String

accepts: Vec<String>

value: Vec<Picked>

multiple: bool

required: bool

Whether the step needs it to hold something before it can be built; one that is not is only ever picked for when asked to.

armed: bool

Whether a click in the viewport picks for it now.

preview: Preview

What an editor draws of what a click would pick for it, while the pointer is over it.

Implementations

impl Reference

pub fn waiting(&self) -> bool

Whether it is waiting for what the step needs: required, and empty.

pub fn elements(&self) -> impl Iterator<Item = &PickedElement>

The elements it holds.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Reference

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Reference

fn eq(&self, other: &Reference) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Reference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Reference