Pose

Struct Pose 

Source
pub struct Pose { /* private fields */ }
Expand description

Use Frame::add_pose to create a new pose.

Implementations§

Source§

impl Pose

Source

pub fn frame(&self) -> Option<Frame>

Returns the parent frame of this pose.

§Returns

Some(Frame) if the parent frame is still valid, or None if the frame has been dropped or no longer exists.

§Example
use cartesian_tree::Frame;
use nalgebra::{Vector3, UnitQuaternion};

let frame = Frame::new_origin("base");
let pose = frame.add_pose(Vector3::new(0.0, 0.0, 0.0), UnitQuaternion::identity());
assert_eq!(pose.frame().unwrap().name(), "base");
Source

pub fn transformation(&self) -> Isometry3<f64>

Returns the transformation from this pose to its parent frame.

§Returns

The transformation of the pose in its parent frame.

Source

pub fn update<O>(&mut self, position: Vector3<f64>, orientation: O)
where O: IntoOrientation,

Updates the pose’s transformation relative to its parent.

§Arguments
  • position: A 3D vector representing the new translational offset from the parent.
  • orientation: An orientation convertible into a unit quaternion for new orientational offset from the parent.
§Example
use cartesian_tree::Frame;
use nalgebra::{Vector3, UnitQuaternion};

let root = Frame::new_origin("root");
let mut pose = root.add_pose(Vector3::new(0.0, 0.0, 1.0), UnitQuaternion::identity());
pose.update(Vector3::new(1.0, 0.0, 0.0), UnitQuaternion::identity());
Source

pub fn in_frame(&self, target: &Frame) -> Result<Pose, CartesianTreeError>

Transforms this pose into the coordinate system of the given target frame.

§Arguments
  • target - The frame to express this pose in.
§Returns
  • Ok(Pose) a new Pose, expressed in the target frame.
  • Err(String) if the frame hierarchy cannot be resolved (due to dropped frames or no common ancestor).
§Example
use cartesian_tree::Frame;
use nalgebra::{Vector3, UnitQuaternion};

let root = Frame::new_origin("root");
let pose = root.add_pose(Vector3::new(0.0, 0.0, 1.0), UnitQuaternion::identity());
let new_frame = root.add_child("child", Vector3::new(1.0, 0.0, 0.0), UnitQuaternion::identity()).unwrap();
let pose_in_new_frame = pose.in_frame(&new_frame);

Trait Implementations§

Source§

impl Clone for Pose

Source§

fn clone(&self) -> Pose

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 Debug for Pose

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Pose

§

impl !RefUnwindSafe for Pose

§

impl !Send for Pose

§

impl !Sync for Pose

§

impl Unpin for Pose

§

impl !UnwindSafe for Pose

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