Struct k::joint::Mimic

source ·
pub struct Mimic<T: RealField> {
    pub multiplier: T,
    pub origin: T,
}
Expand description

Information for copying joint state of other joint

For example, Mimic is used to calculate the position of the gripper(R) from gripper(L). In that case, the code like below will be used.

let mimic_for_gripper_r = k::joint::Mimic::new(-1.0, 0.0);

output position (mimic_position() is calculated by joint positions = joint[name] * multiplier + origin

Fields§

§multiplier: T§origin: T

Implementations§

source§

impl<T> Mimic<T>
where T: RealField,

source

pub fn new(multiplier: T, origin: T) -> Self

Create new instance of Mimic

§Examples
let m = k::joint::Mimic::<f64>::new(1.0, 0.5);
source

pub fn mimic_position(&self, from_position: T) -> T

Calculate the mimic joint position

§Examples
let m = k::joint::Mimic::<f64>::new(1.0, 0.5);
assert_eq!(m.mimic_position(0.2), 0.7); // 0.2 * 1.0 + 0.5
let m = k::joint::Mimic::<f64>::new(-2.0, -0.4);
assert_eq!(m.mimic_position(0.2), -0.8); // 0.2 * -2.0 - 0.4

Trait Implementations§

source§

impl<T: Clone + RealField> Clone for Mimic<T>

source§

fn clone(&self) -> Mimic<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug + RealField> Debug for Mimic<T>

source§

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

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

impl<T> From<&Mimic> for Mimic<T>
where T: RealField,

source§

fn from(urdf_mimic: &Mimic) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> Freeze for Mimic<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Mimic<T>
where T: RefUnwindSafe,

§

impl<T> Send for Mimic<T>

§

impl<T> Sync for Mimic<T>

§

impl<T> Unpin for Mimic<T>
where T: Unpin,

§

impl<T> UnwindSafe for Mimic<T>
where T: UnwindSafe,

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

source§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
source§

impl<T> WithSubscriber for T

source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more