robot_description_builder

Struct JointBuilder

pub struct JointBuilder { /* private fields */ }

Implementations§

impl JointBuilder

pub fn new(name: impl Into<String>, joint_type: JointType) -> Self

pub fn add_origin_offset(self, offset: (f32, f32, f32)) -> Self

pub fn add_origin_rotation(self, rotation: (f32, f32, f32)) -> Self

pub fn set_transform_simple(&mut self, transform: Transform)

pub fn with_axis(&mut self, axis: (f32, f32, f32))

Add the axis to the JointBuillder.

impl JointBuilder

Non Builder functions

pub fn name(&self) -> &String

pub fn joint_type(&self) -> &JointType

pub fn transform(&self) -> Option<&Transform>

pub fn transform_mut(&mut self) -> Option<&mut Transform>

pub fn child(&self) -> Option<&LinkBuilder>

pub fn axis(&self) -> Option<(f32, f32, f32)>

pub fn axis_mut(&mut self) -> Option<&mut (f32, f32, f32)>

pub fn calibration(&self) -> &CalibrationData

pub fn calibration_mut(&mut self) -> &mut CalibrationData

pub fn dynamics(&self) -> &DynamicsData

pub fn dynamics_mut(&mut self) -> &mut DynamicsData

pub fn limit(&self) -> Option<&LimitData>

pub fn limit_mut(&mut self) -> &mut Option<LimitData>

pub fn mimic(&self) -> Option<&MimicBuilderData>

pub fn mimic_mut(&mut self) -> &mut Option<MimicBuilderData>

pub fn safety_controller(&self) -> Option<&SafetyControllerData>

pub fn safety_controller_mut(&mut self) -> &mut Option<SafetyControllerData>

Trait Implementations§

impl Clone for JointBuilder

fn clone(&self) -> JointBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for JointBuilder

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

Formats the value using the given formatter. Read more

impl Default for JointBuilder

fn default() -> JointBuilder

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

impl<Axis, Calibration, Dynamics, Limit, Mimic, SafetyController> From<SmartJointBuilder<ContinuousType, Axis, Calibration, Dynamics, Limit, Mimic, SafetyController>> for JointBuilder
where Axis: AxisDataType, Calibration: CalibrationDataType, Dynamics: DynamicsDataType, Limit: LimitDataType, Mimic: MimicDataType, SafetyController: SafetyControllerDataType,

fn from( value: SmartJointBuilder<ContinuousType, Axis, Calibration, Dynamics, Limit, Mimic, SafetyController>, ) -> Self

Converts to this type from the input type.

impl From<SmartJointBuilder<FixedType, NoAxis, NoCalibration, NoDynamics, NoLimit, NoMimic, NoSafetyController>> for JointBuilder

fn from( value: SmartJointBuilder<FixedType, NoAxis, NoCalibration, NoDynamics, NoLimit, NoMimic, NoSafetyController>, ) -> Self

Converts to this type from the input type.

impl From<SmartJointBuilder<FloatingType, NoAxis, NoCalibration, NoDynamics, NoLimit, NoMimic, NoSafetyController>> for JointBuilder

fn from( value: SmartJointBuilder<FloatingType, NoAxis, NoCalibration, NoDynamics, NoLimit, NoMimic, NoSafetyController>, ) -> Self

Converts to this type from the input type.

impl<Axis, Calibration, Dynamics, Limit, Mimic, SafetyController> From<SmartJointBuilder<PlanarType, Axis, Calibration, Dynamics, Limit, Mimic, SafetyController>> for JointBuilder
where Axis: AxisDataType, Calibration: CalibrationDataType, Dynamics: DynamicsDataType, Limit: LimitDataType, Mimic: MimicDataType, SafetyController: SafetyControllerDataType,

fn from( value: SmartJointBuilder<PlanarType, Axis, Calibration, Dynamics, Limit, Mimic, SafetyController>, ) -> Self

Converts to this type from the input type.

impl<Axis, Calibration, Dynamics, Mimic, SafetyController> From<SmartJointBuilder<PrismaticType, Axis, Calibration, Dynamics, WithLimit, Mimic, SafetyController>> for JointBuilder
where Axis: AxisDataType, Calibration: CalibrationDataType, Dynamics: DynamicsDataType, Mimic: MimicDataType, SafetyController: SafetyControllerDataType,

fn from( value: SmartJointBuilder<PrismaticType, Axis, Calibration, Dynamics, WithLimit, Mimic, SafetyController>, ) -> Self

Converts to this type from the input type.

impl<Axis, Calibration, Dynamics, Mimic, SafetyController> From<SmartJointBuilder<RevoluteType, Axis, Calibration, Dynamics, WithLimit, Mimic, SafetyController>> for JointBuilder
where Axis: AxisDataType, Calibration: CalibrationDataType, Dynamics: DynamicsDataType, Mimic: MimicDataType, SafetyController: SafetyControllerDataType,

fn from( value: SmartJointBuilder<RevoluteType, Axis, Calibration, Dynamics, WithLimit, Mimic, SafetyController>, ) -> Self

Converts to this type from the input type.

impl GroupIDChanger for JointBuilder

unsafe fn change_group_id_unchecked(&mut self, new_group_id: &str)

Unchecked replacement of the GroupID of the builder tree with new_group_id. Read more

fn apply_group_id(&mut self)

Applies GroupID delimiter replacements. Read more

fn change_group_id( &mut self, new_group_id: impl GroupID, ) -> Result<(), GroupIDError>

Replaces the GroupID of the builder tree with new_group_id. Read more

impl PartialEq for JointBuilder

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JointBuilder

Auto Trait Implementations§

impl Freeze for JointBuilder

impl !RefUnwindSafe for JointBuilder

impl Send for JointBuilder

impl Sync for JointBuilder

impl Unpin for JointBuilder

impl !UnwindSafe for JointBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,