Skip to main content

DrawingInteractionMode

Enum DrawingInteractionMode 

Source
pub enum DrawingInteractionMode {
    SingleClick,
    ClickClick,
    DragToDraw,
    ContinuousDraw,
    MultiPoint,
    NotDrawing,
}
Expand description

How a drawing tool captures points from mouse/pointer input.

Every DrawingToolType maps to exactly one interaction mode via DrawingToolType::interaction_mode(). The mode governs the full creation flow: how many clicks are needed, whether dragging is involved, and when the drawing is marked as complete.

§Example

use egui_charts::config::{DrawingToolType, DrawingInteractionMode};

assert_eq!(
    DrawingToolType::TrendLine.interaction_mode(),
    DrawingInteractionMode::ClickClick,
);
assert_eq!(
    DrawingToolType::Rect.interaction_mode(),
    DrawingInteractionMode::DragToDraw,
);

Variants§

§

SingleClick

Click once to place (e.g., HorizontalLine, TextLabel, arrow markers).

The drawing is created and completed with a single click. Only one ChartPoint is captured.

§

ClickClick

Click to set the first point, move, then click to set the second point (e.g., TrendLine, Ray, ExtendedLine).

A preview line follows the cursor between the first and second clicks.

§

DragToDraw

Press the mouse button to set the first point, drag to the second point, and release to complete (e.g., Rect, Circle, FibonacciRetracement).

§

ContinuousDraw

Hold the mouse button and draw a freehand path; release to complete (e.g., Brush, Highlighter).

Points are continuously appended while the button is held.

§

MultiPoint

Click to add points one at a time; double-click or press Enter to finish (e.g., Polyline, XABCDPattern, ElliottImpulse).

The number of required points varies by tool (see DrawingToolType::required_points()). Some tools (like Polyline) have no fixed limit.

§

NotDrawing

Not a drawing tool – cursor/interaction modes only (e.g., CrossCursor, Eraser).

These tools modify the cursor or provide utility functions but do not create Drawing objects.

Trait Implementations§

Source§

impl Clone for DrawingInteractionMode

Source§

fn clone(&self) -> DrawingInteractionMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DrawingInteractionMode

Source§

impl Debug for DrawingInteractionMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DrawingInteractionMode

Source§

impl Hash for DrawingInteractionMode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DrawingInteractionMode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DrawingInteractionMode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AsId for T
where T: Hash + Debug,

§

impl<T> AsIdSalt for T
where T: Hash + Debug,

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T
where T: Send + Sync + ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.