mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface > Struct Template Reference

#include <mc_rtc/gui/Force.h>

Inheritance diagram for mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >:

Collaboration diagram for mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >:

Public Member Functions
	ForceROImpl (const std::string &name, const ForceConfig &config, GetForce get_force_fn, GetSurface get_surface_fn)
void	write (mc_rtc::MessagePackBuilder &builder, bool ro=true)
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::Element
static constexpr size_t	write_size ()

Static Public Attributes
static constexpr auto	type = Elements::Force

Additional Inherited Members
Protected Member Functions inherited from mc_rtc::gui::Element
	Element (const std::string &name)
Protected Attributes inherited from mc_rtc::gui::Element
std::string	name_
int	id_

Detailed Description

template<typename GetForce, typename GetSurface>
struct mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >

Force should display a force vector in 3D environment

The display style of the element can be configured

See also

ForceConfig

Additionally an ArrayLabel with labels {"cx", "cy", "cz", "fx", "fy", "fz"} is created

Template Parameters

GetForce	Should return an sva::ForceVecd
GetSurface	Should return an sva::PTransformd where the force will be displayed

Constructor & Destructor Documentation

ForceROImpl()

template<typename GetForce , typename GetSurface >

mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >::ForceROImpl ( const std::string &  name, const ForceConfig &  config, GetForce  get_force_fn, GetSurface  get_surface_fn  )

inline

Member Function Documentation

write()

template<typename GetForce , typename GetSurface >

void mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >::write ( mc_rtc::MessagePackBuilder &  builder, bool  ro = true  )

inline

write_size()

template<typename GetForce , typename GetSurface >

static constexpr size_t mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >::write_size ( )

inlinestaticconstexpr

Member Data Documentation

type

template<typename GetForce , typename GetSurface >

constexpr auto mc_rtc::gui::details::ForceROImpl< GetForce, GetSurface >::type = Elements::Force

staticconstexpr

---

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

• include/mc_rtc/gui/Force.h