Skip to main content

Link

Struct Link 

Source
pub struct Link<'a> {
    pub name: &'a str,
    pub inertial: Inertial,
    pub visuals: Vec<Visual<'a>>,
    pub collisions: Vec<Collision<'a>>,
}
Expand description

One link of a built structure: the mass it has, and the shapes it is drawn and collided with.

A link that no stated joint attaches is added beneath the structure’s body frame by a fixed joint named <link>_joint, exactly as a mount link is, so stating a link is also how a structure grows one. Naming a link some joint already provides gives that link its body instead.

Every field but the name has a default: a link carries the same unit inertial a generated link does, and no geometry at all.

use phoxal_model::builder::{Inertia, Inertial, Link, RobotBuilder};

let robot = RobotBuilder::new("rover")
    .link(Link {
        name: "base_link",
        inertial: Inertial {
            mass_kg: 12.0,
            inertia: Inertia {
                ixx: 0.8,
                iyy: 1.2,
                izz: 1.6,
                ..Inertia::default()
            },
            ..Inertial::default()
        },
        ..Link::default()
    })
    .build()?;

let base = robot.structure().link("base_link").expect("the stated link");
assert_eq!(base.inertial().mass_kg(), 12.0);

Fields§

§name: &'a str

The link’s own identity, unique within its structure.

§inertial: Inertial

The link’s mass properties.

§visuals: Vec<Visual<'a>>

The shapes the link is drawn with.

§collisions: Vec<Collision<'a>>

The shapes the link collides with.

Trait Implementations§

Source§

impl<'a> Clone for Link<'a>

Source§

fn clone(&self) -> Link<'a>

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<'a> Debug for Link<'a>

Source§

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

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

impl<'a> Default for Link<'a>

Source§

fn default() -> Link<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Link<'a>

§

impl<'a> RefUnwindSafe for Link<'a>

§

impl<'a> Send for Link<'a>

§

impl<'a> Sync for Link<'a>

§

impl<'a> Unpin for Link<'a>

§

impl<'a> UnsafeUnpin for Link<'a>

§

impl<'a> UnwindSafe for Link<'a>

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> 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> 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> 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.