Skip to content
Snippets Groups Projects
Commit 7b5b6d43 authored by Mirko Wächter's avatar Mirko Wächter
Browse files

added doc about pose frames

parent 34b11f25
No related branches found
No related tags found
No related merge requests found
......@@ -14,6 +14,12 @@ can be called. One needs to give the new frame and the \ref armarx::SharedRobotI
function.
- The third level are the LinkedCoordinates (e.g. \ref armarx::LinkedPose "LinkedPose"), which contain all the information needed to do frame transformations.
\section FramedPose-Possible-Frames Frames of coordinates
The frame of FramedX or LinkedX is technically just a string.
The possible values are the names of the robot nodes (use \ref RobotAPI-HowTos-RobotViewer "RobotViewer" app of Simox to inspect them).
For global poses the exists the global constant string variable armarx::GlobalFrame located in the FramedPose.h.
Use this variable if you specify global poses and an empty Agent-string. Empty frames should be avoided (though, an empty string is mostly considered as the global frame).
\section FramedPose-FramedPositionCreation Creation of new FramedPositions
To create a new FramedPosition (FramedOrientation, FramedVector and FramedPose work analogously) one needs
to know the position, the coordinate frame name and the agent name.
......
......@@ -54,7 +54,10 @@ namespace armarx
const VariantTypeId FramedPosition = Variant::addTypeName("::armarx::FramedPositionBase");
const VariantTypeId FramedOrientation = Variant::addTypeName("::armarx::FramedOrientationBase");
}
/**
* @ingroup RobotAPI-FramedPose
* Variable of the global coordinate system. use this if you are specifying a global pose.
* */
std::string const GlobalFrame = "Global";
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment