1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
// Copyright (c) 2019 Autonomous Robots and Cognitive Systems Laboratory
// Author: Daniel Garcia-Vaglio <degv364@gmail.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
#![doc(
html_logo_url = "https://assets.gitlab-static.net/uploads/-/system/project/avatar/12217395/arcos-kdl-logo.png?width=128",
html_favicon_url = "https://assets.gitlab-static.net/uploads/-/system/project/avatar/12217395/arcos-kdl-logo.png?width=128"
)]
#![deny(missing_docs)]
/*!
# ARCOS-KDL
## ARCOS-Lab Kinematics and Dynamic Library.
arcos-kdl has been designed to be as similar as possible to
[orocos-kdl](http://www.orocos.org/wiki/orocos/kdl-wiki)
## Building
Execute:
```.bash
cargo build --lib
```
## Testing
Execute:
```.bash
cargo test
```
## Documentation
Execute:
```.bash
cargo doc
```
## Examples:
### Forward velocity kinematics
Given the current state at each joint we want to calculate the
velocity at the end-effector.
```.rust
extern crate arcos_kdl;
use arcos_kdl::prelude::*;
fn main() {
println!("Documentation!");
}
```
*/
/// Implementation of Kinematic chains
pub mod chains;
/// Forward kinematics differential solver
pub mod forward_diff_kinematics;
/// Forward kinematics solver
pub mod forward_kinematics;
/// Basic geometric constructs like Homogeneous transformations
pub mod geometry;
/// Inverse Kinematics differential solver
pub mod inverse_diff_kinematics;
/// Implementation of Hexadimensional kinematic Jacobians
pub mod jacobian;
/// Implementation of robotic Joints
pub mod joint;
/// Implementation of a kinematic robotic arm
pub mod kinematic_arm;
/// Implementation of kinematic chain segments
pub mod segment;
/// Special SVD computation algorithm
pub mod svd_eigen;
/// Re-exporting usefull stuff
pub mod prelude {
pub use crate::chains::Chain;
pub use crate::forward_diff_kinematics::ForwardDiffKinematicsSolver;
pub use crate::forward_kinematics::ForwardKinematicsSolver;
pub use crate::geometry::{
add_delta, diff, invert_frame, new_ref_base, new_ref_frame, new_ref_point, EulerBuild,
Frame, Introspection, Rotation, RotationRepresentations, Twist, Vector,
};
pub use crate::inverse_diff_kinematics::InverseDiffKinematicsSolver;
pub use crate::jacobian::{Jacobian, JointOperations};
pub use crate::joint::{Joint, JointType};
pub use crate::kinematic_arm::{KinematicArm, SegmentDescription};
pub use crate::segment::Segment;
}