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

#include <mc_rtc/gui/Point3D.h>

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

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

Public Member Functions
	Point3DImpl (const std::string &name, const PointConfig &config, GetT get_fn, SetT set_fn=nullptr)
	Point3DImpl ()
void	write (mc_rtc::MessagePackBuilder &builder)
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
static constexpr 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::Point3D

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::Point3DImpl< GetT, SetT >

Point3D should display a 3D point in the environment

A PointConfig is provided to control how the point is displayed

The point can be edited if

Template Parameters

SetT	is not std::nullptr_t

It will also trigger an ArrayLabel or ArrayInput with {"x", "y", "z"} labels

Template Parameters

GetT	Should return an Eigen::Vector3d
SetT	Will be called when the point is moved or the ArrayInput is triggered if non std::nullptr_t

Constructor & Destructor Documentation

Point3DImpl() [1/2]

template<typename GetT , typename SetT = std::nullptr_t>

mc_rtc::gui::details::Point3DImpl< GetT, SetT >::Point3DImpl ( const std::string &  name, const PointConfig &  config, GetT  get_fn, SetT  set_fn = nullptr  )

inline

Point3DImpl() [2/2]

template<typename GetT , typename SetT = std::nullptr_t>

mc_rtc::gui::details::Point3DImpl< GetT, SetT >::Point3DImpl ( )

inline

Invalid element

Member Function Documentation

write()

template<typename GetT , typename SetT = std::nullptr_t>

void mc_rtc::gui::details::Point3DImpl< GetT, SetT >::write ( mc_rtc::MessagePackBuilder &  builder )

inline

write_size()

template<typename GetT , typename SetT = std::nullptr_t>

static constexpr size_t mc_rtc::gui::details::Point3DImpl< GetT, SetT >::write_size ( )

inlinestaticconstexpr

Member Data Documentation

type

template<typename GetT , typename SetT = std::nullptr_t>

constexpr auto mc_rtc::gui::details::Point3DImpl< GetT, SetT >::type = Elements::Point3D

staticconstexpr

---

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

• include/mc_rtc/gui/Point3D.h