mc_rtc::gui::details::XYThetaImpl< GetT, SetT > Struct Template Reference

#include <mc_rtc/gui/XYTheta.h>

Inheritance diagram for mc_rtc::gui::details::XYThetaImpl< GetT, SetT >:
Collaboration diagram for mc_rtc::gui::details::XYThetaImpl< GetT, SetT >:

Public Member Functions

 XYThetaImpl (const std::string &name, GetT get_fn, SetT set_fn=nullptr)
 
void write (mc_rtc::MessagePackBuilder &builder)
 
 XYThetaImpl ()
 
- Public Member Functions inherited from mc_rtc::gui::CommonInputImpl< GetT, std::nullptr_t >
 CommonInputImpl (const std::string &name, GetT get_fn, std::nullptr_t set_fn)
 
 CommonInputImpl ()
 
- Public Member Functions inherited from mc_rtc::gui::CallbackElement< DataElement< GetT >, std::nullptr_t >
bool handleRequest (const mc_rtc::Configuration &data)
 
 CallbackElement (const std::string &name, std::nullptr_t cb, Args &&... args)
 
 CallbackElement ()
 
- Public Member Functions inherited from mc_rtc::gui::DataElement< GetT >
void write (mc_rtc::MessagePackBuilder &builder)
 
 DataElement (const std::string &name, GetT get_fn)
 
 DataElement ()
 
- Public Member Functions inherited from mc_rtc::gui::Element
const std::string & name () const
 
int id () const
 
void id (int idIn)
 
void write (mc_rtc::MessagePackBuilder &)
 
bool handleRequest (const mc_rtc::Configuration &)
 
 Element ()
 

Static Public Member Functions

constexpr static size_t write_size ()
 
- Static Public Member Functions inherited from mc_rtc::gui::DataElement< GetT >
static constexpr size_t write_size ()
 
- Static Public Member Functions inherited from mc_rtc::gui::Element
static constexpr size_t write_size ()
 

Static Public Attributes

static constexpr auto type = Elements::XYTheta
 

Additional Inherited Members

- Protected Member Functions inherited from mc_rtc::gui::Element
 Element (const std::string &name)
 
- Protected Attributes inherited from mc_rtc::gui::CallbackElement< DataElement< GetT >, std::nullptr_t >
std::nullptr_t cb_
 
- Protected Attributes inherited from mc_rtc::gui::DataElement< GetT >
GetT get_fn_
 
- Protected Attributes inherited from mc_rtc::gui::Element
std::string name_
 
int id_
 

Detailed Description

template<typename GetT, typename SetT = std::nullptr_t>
struct mc_rtc::gui::details::XYThetaImpl< GetT, SetT >

An XYTheta element represents an oriented point in the XY plane.

Altitude can be provided optionally.

This element is editable if

Template Parameters
SetTis not nullptr_t
GetTShould return a double array of size 3nullptr (x, y, theta) or 4 (x, y, theta, z)
SetTShould accept an Eigen::Vector4d that will contain (x, y, theta, z)

Constructor & Destructor Documentation

◆ XYThetaImpl() [1/2]

template<typename GetT , typename SetT = std::nullptr_t>
mc_rtc::gui::details::XYThetaImpl< GetT, SetT >::XYThetaImpl ( const std::string &  name,
GetT  get_fn,
SetT  set_fn = nullptr 
)
inline

◆ XYThetaImpl() [2/2]

template<typename GetT , typename SetT = std::nullptr_t>
mc_rtc::gui::details::XYThetaImpl< GetT, SetT >::XYThetaImpl ( )
inline

Invalid element

Member Function Documentation

◆ write()

template<typename GetT , typename SetT = std::nullptr_t>
void mc_rtc::gui::details::XYThetaImpl< GetT, SetT >::write ( mc_rtc::MessagePackBuilder builder)
inline

◆ write_size()

template<typename GetT , typename SetT = std::nullptr_t>
constexpr static size_t mc_rtc::gui::details::XYThetaImpl< GetT, SetT >::write_size ( )
inlinestaticconstexpr

Member Data Documentation

◆ type

template<typename GetT , typename SetT = std::nullptr_t>
constexpr auto mc_rtc::gui::details::XYThetaImpl< GetT, SetT >::type = Elements::XYTheta
staticconstexpr

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