YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::math::FrameTransform Class Reference

#include <yarp/math/FrameTransform.h>

+ Inheritance diagram for yarp::math::FrameTransform:

Public Types

enum  display_transform_mode_t {
  rotation_as_quaternion =0 ,
  rotation_as_matrix =1 ,
  rotation_as_rpy =2
}
 
- Public Types inherited from yarp::math::FrameTransformData
typedef yarp::os::idl::Unwrapped< FrameTransformData > unwrapped
 

Public Member Functions

bool isValid () const
 
 FrameTransform ()
 
 FrameTransform (const std::string &parent, const std::string &child, double inTX, double inTY, double inTZ, double inRX, double inRY, double inRZ, double inRW)
 
 ~FrameTransform ()
 
void transFromVec (double X, double Y, double Z)
 
void rotFromRPY (double R, double P, double Y)
 
yarp::sig::Vector getRPYRot () const
 
yarp::sig::Matrix toMatrix () const
 
bool fromMatrix (const yarp::sig::Matrix &mat)
 
std::string toString (display_transform_mode_t format=rotation_as_quaternion) const
 
- Public Member Functions inherited from yarp::math::FrameTransformData
 FrameTransformData ()=default
 
 FrameTransformData (const std::string &src_frame_id, const std::string &dst_frame_id, const double timestamp, const bool isStatic, const yarp::math::Translation &translation, const yarp::math::Quaternion &rotation)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
 
- Public Attributes inherited from yarp::math::FrameTransformData
std::string src_frame_id {}
 
std::string dst_frame_id {}
 
double timestamp {0.000000}
 
bool isStatic {false}
 
yarp::math::Translation translation {}
 
yarp::math::Quaternion rotation {}
 

Detailed Description

Definition at line 17 of file FrameTransform.h.

Member Enumeration Documentation

◆ display_transform_mode_t

Enumerator
rotation_as_quaternion 
rotation_as_matrix 
rotation_as_rpy 

Definition at line 53 of file FrameTransform.h.

Constructor & Destructor Documentation

◆ FrameTransform() [1/2]

FrameTransform::FrameTransform ( )

Definition at line 20 of file FrameTransform.cpp.

◆ FrameTransform() [2/2]

FrameTransform::FrameTransform ( const std::string &  parent,
const std::string &  child,
double  inTX,
double  inTY,
double  inTZ,
double  inRX,
double  inRY,
double  inRZ,
double  inRW 
)

Definition at line 25 of file FrameTransform.cpp.

◆ ~FrameTransform()

FrameTransform::~FrameTransform ( )
default

Member Function Documentation

◆ fromMatrix()

bool FrameTransform::fromMatrix ( const yarp::sig::Matrix &  mat)

Definition at line 88 of file FrameTransform.cpp.

◆ getRPYRot()

yarp::sig::Vector FrameTransform::getRPYRot ( ) const

Definition at line 68 of file FrameTransform.cpp.

◆ isValid()

bool FrameTransform::isValid ( ) const

Definition at line 41 of file FrameTransform.cpp.

◆ rotFromRPY()

void FrameTransform::rotFromRPY ( double  R,
double  P,
double  Y 
)

Definition at line 56 of file FrameTransform.cpp.

◆ toMatrix()

yarp::sig::Matrix FrameTransform::toMatrix ( ) const

Definition at line 77 of file FrameTransform.cpp.

◆ toString()

std::string FrameTransform::toString ( display_transform_mode_t  format = rotation_as_quaternion) const

Definition at line 108 of file FrameTransform.cpp.

◆ transFromVec()

void FrameTransform::transFromVec ( double  X,
double  Y,
double  Z 
)

Definition at line 51 of file FrameTransform.cpp.


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