Skip to main content

CouplingResponse

Enum CouplingResponse 

Source
pub enum CouplingResponse {
    AttractToMin,
    RepelFromMax,
    AlignVelocity,
    FlowAdvect,
    DampenInside {
        factor: f32,
    },
    ContainmentWall,
    Open {
        predicate: String,
    },
}
Expand description

How a node responds to a field at its position.

Recognized core (force). The six force responses are the recognized core: seiche dispatches on them to integrate motion. This is the statements-over-schema “recognized core gets behavior” half; the responses are also the v1 surface.

Open tail. The coupling contract is deliberately open beyond force (the field-system extraction names visual, navigational, selection, semantic, and trigger families). CouplingResponse::Open carries any such response by an open IRI (COUPLING_VOCAB), stored faithfully and handled generically until a consumer recognizes it. The force integrator ignores Open, so the open tail never breaks dispatch. Recognized-core IRIs round-trip via recognized_iri / from_iri.

Variants§

§

AttractToMin

Move along -grad(scalar) (gradient descent on a potential).

§

RepelFromMax

Move along +grad(scalar) (gradient ascent).

§

AlignVelocity

Set velocity equal to the vector field at this position.

§

FlowAdvect

Advect: pos += dt * field(pos).

§

DampenInside

Multiplicative damping when inside a positive scalar region.

Fields

§factor: f32
§

ContainmentWall

Hard pushout when the scalar field exceeds zero.

§

Open

Open tail: a non-force response identified by an open IRI (see COUPLING_VOCAB). Stored faithfully, ignored by the force integrator, recognized by whatever consumer owns its family (paint, camera, …).

Fields

§predicate: String

Implementations§

Source§

impl CouplingResponse

Source

pub fn open(predicate: impl Into<String>) -> CouplingResponse

Build a response from an IRI, canonicalizing a recognized core IRI back to its typed variant and wrapping anything else as Self::Open.

Source

pub fn is_force(&self) -> bool

Whether this is a recognized force-core response (vs an open-tail one).

Source

pub fn predicate(&self) -> Option<&str>

The open predicate IRI for an Open response; None for the recognized force core (whose IRI is recognized_iri).

Source

pub fn recognized_iri(&self) -> Option<&'static str>

Canonical IRI for a recognized force-core response; None for Open. Variant params (e.g. DampenInside.factor) are statement-level data, not part of the IRI.

Source

pub fn from_iri(iri: &str) -> Option<CouplingResponse>

The recognized force-core response for a canonical IRI, if any. Inverse of recognized_iri. DampenInside comes back with factor = 1.0 (the no-op identity); the real factor is carried separately, not in the IRI.

Trait Implementations§

Source§

impl Clone for CouplingResponse

Source§

fn clone(&self) -> CouplingResponse

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 CouplingResponse

Source§

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

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

impl<'de> Deserialize<'de> for CouplingResponse

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CouplingResponse, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl IntoEnumIterator for CouplingResponse

Source§

impl PartialEq for CouplingResponse

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for CouplingResponse

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CouplingResponse

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T> MemoryPayload for T
where T: Clone + Debug + Serialize + for<'de> Deserialize<'de>,

Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.