Struct Mate 

pub struct Mate {
    pub kind: MateKind,
    pub entities: Vec<MateEntity>,
    pub joints: Vec<String>,
}

A mate: what two entities must be to each other — or, for a coupling, two joints. Serializes flat: {"type": "distance", "value": 1.0, "entities": [...]}.

One being edited may hold fewer than two entities or joints yet; only a complete one (Mate::is_complete) holds anything.

Fields

kind: MateKind

entities: Vec<MateEntity>

joints: Vec<String>

The joints a coupling ties, by their names in the part: add_part(gear2,m1).

Implementations

impl Mate

pub fn constraint(kind: Kind, entities: Vec<MateEntity>) -> Self

A constraint of kind between entities.

pub fn joint(kind: JointKind, entities: Vec<MateEntity>) -> Self

A joint of kind between entities: the first part’s connector, then the second’s.

pub fn fixed_here() -> Self

A fixed mate of no entity yet: in a step that places a part, it holds that part (see AddPart).

pub fn is_fixed(&self) -> bool

Whether it holds a part fixed.

pub fn coupling(kind: CouplingKind, joints: Vec<String>) -> Self

A coupling of kind between the joints named joints.

pub fn pair(&self) -> Option<[&MateEntity; 2]>

Its two entities, if it has exactly two.

pub fn is_complete(&self) -> bool

Whether it has what it holds together: two entities, or for a coupling two joints.

pub fn needs(&self) -> String

What an entity has to be for this kind of mate, in words — for a coupling, what its joints have to be.

Trait Implementations

impl Clone for Mate

fn clone(&self) -> Mate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Mate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Mate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Mate