Struct ForceConfig

Source

#[non_exhaustive]pub struct ForceConfig {
    pub link_distance: f32,
    pub charge: f32,
    pub theta: f32,
    pub charge_distance_max: f32,
    pub collide_padding: f32,
    pub collide_strength: f32,
    pub gravity: f32,
    pub group_strength: f32,
    pub velocity_decay: f32,
    pub alpha_min: f32,
    pub alpha_decay: f32,
}

Expand description

Tuning knobs, named after their d3-force counterparts.

ForceConfig::default().with_link_distance(90.).with_charge(-400.)

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§link_distance: f32

forceLink().distance(): rest length of an edge, in world units.

§charge: f32

forceManyBody().strength(): negative repels.

§theta: f32

forceManyBody().theta(): Barnes–Hut accuracy, lower is more exact.

§charge_distance_max: f32

Ignore charge beyond this distance; keeps far components from drifting apart.

§collide_padding: f32

forceCollide() padding added to each node’s radius.

§collide_strength: f32§gravity: f32

forceX/forceY pull toward the origin; holds disconnected components together.

§group_strength: f32

Pull of each group (community) member toward its group’s centroid, so communities form visible clusters. 0 disables.

§velocity_decay: f32§alpha_min: f32§alpha_decay: f32

Struct ForceConfig Copy item path

Fields (Non-exhaustive)§

Implementations§

impl ForceConfig

pub fn with_link_distance(self, value: f32) -> Self

pub fn with_charge(self, value: f32) -> Self

pub fn with_theta(self, value: f32) -> Self

pub fn with_charge_distance_max(self, value: f32) -> Self

pub fn with_collide_padding(self, value: f32) -> Self

pub fn with_collide_strength(self, value: f32) -> Self

pub fn with_gravity(self, value: f32) -> Self

pub fn with_group_strength(self, value: f32) -> Self

pub fn with_velocity_decay(self, value: f32) -> Self

impl ForceConfig

pub fn with_settle_ticks(self, ticks: u32, alpha_min: f32) -> Self

Trait Implementations§

impl Clone for ForceConfig

fn clone(&self) -> Self

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

impl Debug for ForceConfig

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

impl Default for ForceConfig

fn default() -> Self

Auto Trait Implementations§

impl Freeze for ForceConfig

impl RefUnwindSafe for ForceConfig

impl Send for ForceConfig

impl Sync for ForceConfig

impl Unpin for ForceConfig

impl UnsafeUnpin for ForceConfig

impl UnwindSafe for ForceConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T> NoneValue for Twhere T: Default,

type NoneType = T

fn null_value() -> T

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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

impl<R, P> ReadPrimitive<R> for Pwhere R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = !

fn try_from(value: U) -> Result<T, !>

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

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

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

Struct ForceConfig

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

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

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

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,

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

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

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

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

impl<T> NoneValue for T
where T: Default,

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

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

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

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

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