Skip to main content

TransformedFK

Struct TransformedFK 

Source
pub struct TransformedFK<const N: usize, FK: FKChain<N>> { /* private fields */ }
Expand description

Wraps an FKChain with an optional prefix (base) and/or suffix (tool) transform.

  • fk applies only the prefix — intermediate frames stay in world coordinates without the tool offset.
  • fk_end and joint_axes_positions apply both — the end-effector includes the tool tip.

Implementations§

Source§

impl<const N: usize, FK: FKChain<N>> TransformedFK<N, FK>

Source

pub const fn new(inner: FK) -> Self

Source

pub const fn with_prefix(self, prefix: Affine3A) -> Self

Source

pub const fn with_suffix(self, suffix: Affine3A) -> Self

Source

pub const fn with_prefix_opt(self, prefix: Option<Affine3A>) -> Self

Infallible const-usable setter for the prefix. None clears any previously set prefix. Pair with compose_fixed_joints (const) to build the prefix from a slice of Fixed joints in a const context.

Source

pub const fn with_suffix_opt(self, suffix: Option<Affine3A>) -> Self

Infallible const-usable setter for the suffix. None clears any previously set suffix. Pair with compose_fixed_joints (const) to build the suffix from a slice of Fixed joints in a const context.

Source

pub fn with_prefix_joints( self, joints: &[URDFJoint], ) -> Result<Self, URDFBuildError>

Compose a slice of fixed URDF joints (parent→child order) and set the result as the base-side prefix transform, replacing any existing prefix. Every joint in joints must be URDFJointType::Fixed. An empty slice clears the prefix.

Source

pub fn with_suffix_joints( self, joints: &[URDFJoint], ) -> Result<Self, URDFBuildError>

Compose a slice of fixed URDF joints (parent→child order) and set the result as the tool-side suffix transform, replacing any existing suffix. Every joint in joints must be URDFJointType::Fixed. An empty slice clears the suffix.

Source

pub fn set_prefix(&mut self, prefix: Option<Affine3A>)

Source

pub fn set_suffix(&mut self, suffix: Option<Affine3A>)

Source

pub fn prefix(&self) -> Option<&Affine3A>

Source

pub fn suffix(&self) -> Option<&Affine3A>

Source

pub fn inner(&self) -> &FK

Trait Implementations§

Source§

impl<const N: usize, FK: Clone + FKChain<N>> Clone for TransformedFK<N, FK>

Source§

fn clone(&self) -> TransformedFK<N, FK>

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
Source§

impl<const N: usize, FK: Debug + FKChain<N>> Debug for TransformedFK<N, FK>

Source§

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

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

impl<const N: usize, FK: FKChain<N>> FKChain<N> for TransformedFK<N, FK>

Source§

type Error = <FK as FKChain<N>>::Error

Source§

fn base_tf(&self) -> Affine3A

Configuration-independent transform from the robot’s base frame to the world frame. Defaults to identity; wrappers that install a static prefix (e.g. TransformedFK with a prefix set, or URDFChain with fixed leading joints baked in) override this so downstream consumers (collision validators, visualizers) can place the static base body at the correct pose.
Source§

fn max_reach(&self) -> Result<f32, Self::Error>

Theoretical maximum reach: sum of link lengths (upper bound, ignores joint limits).
Source§

fn fk(&self, q: &SRobotQ<N>) -> Result<[Affine3A; N], Self::Error>

Source§

fn fk_end(&self, q: &SRobotQ<N>) -> Result<Affine3A, Self::Error>

Source§

fn joint_axes_positions( &self, q: &SRobotQ<N>, ) -> Result<([Vec3A; N], [Vec3A; N], Vec3A), Self::Error>

Returns joint rotation axes and axis-origin positions in world frame at configuration q, plus the end-effector position.
Source§

fn dof(&self) -> usize

Source§

fn jacobian(&self, q: &SRobotQ<N>) -> Result<[[f32; N]; 6], Self::Error>

Geometric Jacobian (6×N) at configuration q. Rows 0–2: linear velocity, rows 3–5: angular velocity.
Source§

fn jacobian_dot( &self, q: &SRobotQ<N>, qdot: &SRobotQ<N>, ) -> Result<[[f32; N]; 6], Self::Error>

First time-derivative of the geometric Jacobian.
Source§

fn jacobian_ddot( &self, q: &SRobotQ<N>, qdot: &SRobotQ<N>, qddot: &SRobotQ<N>, ) -> Result<[[f32; N]; 6], Self::Error>

Second time-derivative of the geometric Jacobian.

Auto Trait Implementations§

§

impl<const N: usize, FK> Freeze for TransformedFK<N, FK>
where FK: Freeze,

§

impl<const N: usize, FK> RefUnwindSafe for TransformedFK<N, FK>
where FK: RefUnwindSafe,

§

impl<const N: usize, FK> Send for TransformedFK<N, FK>

§

impl<const N: usize, FK> Sync for TransformedFK<N, FK>

§

impl<const N: usize, FK> Unpin for TransformedFK<N, FK>
where FK: Unpin,

§

impl<const N: usize, FK> UnsafeUnpin for TransformedFK<N, FK>
where FK: UnsafeUnpin,

§

impl<const N: usize, FK> UnwindSafe for TransformedFK<N, FK>
where FK: 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, 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.