Skip to main content

Crate use_frame

Crate use_frame 

Source
Expand description

§use-frame

Primitive coordinate frame vocabulary for RustUse robotics.

This crate provides frame names, frame kinds, frame references, and parent/child frame relations. It does not implement TF trees, transform buffers, coordinate conversion, or geometry math.

§Example

use use_frame::{FrameKind, FrameName, FrameRef, FrameRelation};

let parent = FrameRef::new(FrameName::new("base_link")?, FrameKind::Base);
let child = FrameRef::new(FrameName::new("tool0")?, FrameKind::Tool);
let relation = FrameRelation::new(parent, child);

assert_eq!(relation.parent().name().as_str(), "base_link");
assert_eq!(relation.child().kind(), &FrameKind::Tool);

The relation labels a parent and child. It does not compute transforms.

§License

Licensed under either the MIT license or Apache License, Version 2.0. Primitive robotics frame vocabulary.

Structs§

FrameName
A non-empty robotics frame name.
FrameRef
A named frame reference with a descriptive kind.
FrameRelation
A descriptive parent/child frame relation.

Enums§

FrameKind
Descriptive robotics frame kind vocabulary.
FrameKindParseError
Error returned when parsing frame kinds fails.
FrameTextError
Errors returned while constructing frame text values.