simulator-sdk  1.14
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Public Attributes
Sim::Frame Class Reference

Frame defines a position in space and has a name. More...

#include <alrobotmodel.h>

List of all members.

Public Member Functions

 Frame ()
 creates an empty Frame, you should not use this.
 ~Frame ()
 destructor.
const std::string & name () const
 returns the name of the Frame.
const AL::Math::Transform & position () const
 returns the position of the Frame.
const FrameparentFrame () const
 returns the frame in which the position is defined.
const AL::Math::Transform & localPosition () const
 returns the position of the Frame frame in the parent Frame.

Static Public Member Functions

static AL::Math::Transform globalPosition (const Frame *frame)
 returns the position of the Frame frame in global Frame (generally robot's Torso).

Public Attributes

class FrameImpl * a_impl
 private implementation.

Detailed Description

Frame defines a position in space and has a name.

Definition at line 252 of file alrobotmodel.h.


Constructor & Destructor Documentation

Sim::Frame::Frame ( )

creates an empty Frame, you should not use this.

Warning:
The Frame being empty, every access to this object will throw.

Member Function Documentation

static AL::Math::Transform Sim::Frame::globalPosition ( const Frame frame)
static

returns the position of the Frame frame in global Frame (generally robot's Torso).

Remarks:
See the C++ reference of libalmath in Aldebaran's Documentation for more details on AL::Math::Transform.
const AL::Math::Transform& Sim::Frame::localPosition ( ) const

returns the position of the Frame frame in the parent Frame.

Remarks:
See the C++ reference of libalmath in Aldebaran's Documentation for more details on AL::Math::Transform.
const AL::Math::Transform& Sim::Frame::position ( ) const

returns the position of the Frame.

Remarks:
See the C++ reference of libalmath in Aldebaran's
Deprecated:
Documentation for more details on AL::Math::Transform.

The documentation for this class was generated from the following file: