Struct Magnet 

pub struct Magnet { /* private fields */ }

A magnetism anchor attached to a scene item.

Built fluently and handed to SceneModel::add_magnet. Carries a local-frame position, a MagnetRole, an optional type-erased payload, an enabled flag, and an optional accessibility label.

Implementations

impl Magnet

pub fn new(local_pos: Point) -> Self

A magnet at local_pos in the owning item’s local frame, role Bidirectional, no payload, enabled.

pub fn role(self, role: MagnetRole) -> Self

Set the connection direction (advisory — see MagnetRole).

pub fn payload<P: 'static>(self, payload: P) -> Self

Attach a type-erased payload the predicate and the connection event can downcast. Cheap to carry around (held in an Rc).

pub fn payload_rc(self, payload: Rc<dyn Any>) -> Self

Attach an already-Rc-wrapped payload (use when several magnets share one payload object).

pub fn label(self, label: impl Into<LocalizedString>) -> Self

The accessibility name announced for this magnet’s synthetic AT node. Defaults to a generic role-based label when unset.

pub fn enabled(self, on: bool) -> Self

Disabled magnets are skipped by broad-phase, feedback, the keyboard cycle, and AT emission. Enabled by default.

Trait Implementations

impl Clone for Magnet

fn clone(&self) -> Magnet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Magnet

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

Formats the value using the given formatter.