Struct MagnetismConfig 

pub struct MagnetismConfig { /* private fields */ }

Per-view magnetism configuration, installed via SceneView::magnetism.

Holds the consumer’s policy — the accept/reject predicate and the on_connect handler — plus presentation knobs. The scene supplies the mechanism (snap math, broad-phase, feedback rendering, the connection event); this config is where the consumer plugs its policy in.

Implementations

impl MagnetismConfig

pub fn new( predicate: impl Fn(&MagnetRef, &MagnetRef) -> MagnetVerdict + 'static, ) -> Self

A config with the given accept/reject predicate and defaults: 14 px capture radius, markers during interaction, the built-in feedback renderer, m to toggle keyboard connect mode, enabled. Install an on_connect handler to actually do something on connect.

pub fn on_connect( self, f: impl Fn(&MagnetConnection, &mut EventContext<'_>) + 'static, ) -> Self

The handler invoked when a connection is formed (mouse release or keyboard confirm). Runs with a live EventContext and no scene borrow held, so it may mutate the model (add an edge item, reparent), call scene.add_a11y_relation, or fire an intent.

pub fn capture_px(self, px: f32) -> Self

Capture and grab radius in screen pixels (converted to scene units by dividing by the live zoom, so snapping feels consistent at any zoom). Default 14.

pub fn markers(self, markers: MarkerVisibility) -> Self

When magnet markers are painted. Default MarkerVisibility::DuringInteraction.

pub fn feedback( self, f: impl Fn(&mut Canvas, &PaintContext<'_>, &MagnetFeedback) + 'static, ) -> Self

Replace the built-in feedback renderer with a custom one. The closure paints in scene coordinates (the canvas already has the view transform pushed).

pub fn connect_key(self, key: Key) -> Self

The key that toggles keyboard connect mode while the SceneView is focused. Default m.

pub fn enabled(self, on: impl Into<Prop<bool>>) -> Self

Set the enabled state, statically or reactively (an app-owned signal drives enabled/disabled from e.g. a toolbar toggle).

pub fn enabled_signal(&self) -> Signal<bool>

The reactive enabled signal, for a toolbar to read or bind.

pub fn is_enabled(&self) -> bool

Whether magnetism is currently enabled.

Trait Implementations

impl Clone for MagnetismConfig

fn clone(&self) -> MagnetismConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MagnetismConfig

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

Formats the value using the given formatter.