Enum widgetry::mapspace::WorldOutcome

pub enum WorldOutcome<ID: ObjectID> {
    ClickedFreeSpace(Pt2D),
    Dragging {
        obj: ID,
        dx: f64,
        dy: f64,
        cursor: Pt2D,
    },
    Keypress(&'static str, ID),
    ClickedObject(ID),
    HoverChanged(Option<ID>, Option<ID>),
    Nothing,
}

The result of a World handling an event

Variants

ClickedFreeSpace(Pt2D)

A left click occurred while not hovering on any object

Dragging

Fields

obj: ID

dx: f64

dy: f64

cursor: Pt2D

An object is being dragged. The given offsets are relative to the previous dragging event. The current position of the cursor is included. If you’re dragging a large object, applying the offset will likely feel more natural than centering on the cursor.

Keypress(&'static str, ID)

While hovering on an object with a defined hotkey, that key was pressed.

ClickedObject(ID)

A hoverable object was clicked

HoverChanged(Option<ID>, Option<ID>)

The object being hovered on changed from (something before, to something after). Note this transition may also occur outside of event – such as during delete or initialize_hover.

TODO Bug in the map_editor: If you delete one object, then the caller does initialize_hover and we immediately wind up on another road beneath, we don’t detect this and start showing road points.

Nothing

Nothing interesting happened

Implementations

impl<I: ObjectID> WorldOutcome<I>

pub fn maybe_map_id<O: ObjectID, F: Fn(I) -> Option<O>>(
    self,
    f: F
) -> Option<WorldOutcome<O>>

If the outcome references some ID, transform it to another type. This is useful when some component owns a World that contains a few different types of objects, some of which are managed by another component that only cares about its IDs.

Trait Implementations

impl<ID: Clone + ObjectID> Clone for WorldOutcome<ID>

fn clone(&self) -> WorldOutcome<ID>

Returns a copy of the value.

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

Performs copy-assignment from source.