mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT > Struct Template Reference

#include <mc_rtc/gui/plot/AbscissaOrdinate.h>

Inheritance diagram for mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >:
Collaboration diagram for mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >:

Public Types

using CacheT = std::vector< std::array< double, 2 > >
 

Public Member Functions

 AbscissaOrdinate (std::string_view name, UpdateCacheT update_fn, Color color, Style style, Side side)
 
void write (mc_rtc::MessagePackBuilder &builder) const
 
void update () const
 
AbscissaOrdinatestyle (Style style)
 
AbscissaOrdinateside (Side side)
 

Static Public Attributes

static constexpr Type type = Type::AbscissaOrdinate
 

Protected Attributes

std::string name_
 
UpdateCacheT update_fn_
 
Color color_
 
std::vector< std::array< double, 2 > > cache_
 
Style style_
 
Side side_
 

Detailed Description

template<typename UpdateCacheT>
struct mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >

For a given plot, this holds options on the ordinate plot and a callback that returns the current value

Member Typedef Documentation

◆ CacheT

template<typename UpdateCacheT >
using mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::CacheT = std::vector<std::array<double, 2> >

Constructor & Destructor Documentation

◆ AbscissaOrdinate()

template<typename UpdateCacheT >
mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::AbscissaOrdinate ( std::string_view  name,
UpdateCacheT  update_fn,
Color  color,
Style  style,
Side  side 
)
inline

Member Function Documentation

◆ side()

template<typename UpdateCacheT >
AbscissaOrdinate& mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::side ( Side  side)
inline

◆ style()

template<typename UpdateCacheT >
AbscissaOrdinate& mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::style ( Style  style)
inline

◆ update()

template<typename UpdateCacheT >
void mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::update ( ) const
inline

◆ write()

template<typename UpdateCacheT >
void mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::write ( mc_rtc::MessagePackBuilder builder) const
inline

Member Data Documentation

◆ cache_

template<typename UpdateCacheT >
std::vector<std::array<double, 2> > mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::cache_
mutableprotected

◆ color_

template<typename UpdateCacheT >
Color mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::color_
mutableprotected

◆ name_

template<typename UpdateCacheT >
std::string mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::name_
protected

◆ side_

template<typename UpdateCacheT >
Side mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::side_
protected

◆ style_

template<typename UpdateCacheT >
Style mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::style_
protected

◆ type

template<typename UpdateCacheT >
constexpr Type mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::type = Type::AbscissaOrdinate
staticconstexpr

◆ update_fn_

template<typename UpdateCacheT >
UpdateCacheT mc_rtc::gui::plot::impl::AbscissaOrdinate< UpdateCacheT >::update_fn_
protected

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