Skip to main content

MapSettings

Struct MapSettings 

Source
pub struct MapSettings {
    pub max_zoom: f32,
    pub min_zoom: f32,
    pub line_visible_zoom: f32,
    pub label_visible_zoom: f32,
    pub node_text_visibility: VisibilitySetting,
    pub marker_animation: SteadyAnimation,
    pub node_text_size: f32,
    pub label_text_size: f32,
    pub styles: Vec<Style>,
}
Expand description

Configuration of a Map widget.

MapSettings::default() provides sensible zoom limits plus a light and a dark theme; the widget picks the style to apply based on egui::Visuals::dark_mode, using styles[0] in light mode and styles[1] in dark mode.

Fields§

§max_zoom: f32

Maximum zoom factor.

§min_zoom: f32

Minimum zoom factor.

§line_visible_zoom: f32

Zoom threshold above which connection lines become visible.

§label_visible_zoom: f32

Zoom threshold above which node names become visible when node_text_visibility is VisibilitySetting::Always.

§node_text_visibility: VisibilitySetting

Controls when node names are displayed.

§marker_animation: SteadyAnimation

Effect drawn on nodes registered with Map::update_marker.

Persistent, so it keeps the app repainting for as long as a marker exists. Ignored when a NodeTemplate is installed.

Node state set through NodeHandle picks its own effect per node and does not read this field.

§node_text_size: f32

Font size, in screen pixels, of the node names.

This is a screen-space size: it deliberately does not scale with the zoom factor, so a name stays exactly as readable when the map is zoomed all the way out as when it is zoomed in. Because the nodes pack closer together as you zoom out while the names keep their size, names take up proportionally more of the view down there — use label_visible_zoom or node_text_visibility to control when they are worth showing at all.

§label_text_size: f32

Font size, in screen pixels, of the free-floating MapLabels.

Screen-space, exactly like node_text_size.

§styles: Vec<Style>

Per-mode styles; index 0 is used in light mode, index 1 in dark mode. Their colors are kept in sync with the active MapTheme – see Map::set_theme – rather than set here.

Implementations§

Source§

impl MapSettings

Source

pub fn new() -> Self

Creates settings with all zoom thresholds set to 0.0 and a single transparent style.

Prefer MapSettings::default() unless you really need to build the configuration from scratch.

Trait Implementations§

Source§

impl Clone for MapSettings

Source§

fn clone(&self) -> MapSettings

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 Debug for MapSettings

Source§

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

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

impl Default for MapSettings

Source§

fn default() -> Self

Returns the default configuration: zoom from 0.1 to 2.0, connection lines visible above 0.2, node names above 0.58, and built-in light and dark themes.

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
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
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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 = !

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more