iridescence
Loading...
Searching...
No Matches
guik::AsyncLightViewer Class Reference

#include <async_light_viewer.hpp>

Inheritance diagram for guik::AsyncLightViewer:
Collaboration diagram for guik::AsyncLightViewer:

Public Member Functions

virtual ~AsyncLightViewer ()
void invoke (const std::function< void()> &func)
 Invoke a task in the visualization thread.
void invoke_after_rendering (const std::function< void()> &func)
 Invoke a task after rendering in the visualization thread.
void invoke_once (const std::string &label, const std::function< void()> &func)
 Invoke a labeled task only once in the life time of the viewer.
void clear_images ()
 Clear all images.
void remove_image (const std::string &name)
 Remove an image by name.
void update_image (const std::string &name, int width, int height, const std::vector< unsigned char > &rgba_bytes, double scale=-1.0, int order=-1)
 Register or update an image.
void clear_plots (bool clear_settings=true)
 Clear all plots.
void remove_plot (const std::string &plot_name, const std::string &label="")
 Remove a plot by name.
void setup_plot (const std::string &plot_name, int width, int height, int plot_flags=0, int x_flags=0, int y_flags=0, int order=-1)
 Setup a plot.
void link_plot_axis (const std::string &plot_name, int link_id, int axis)
 Link an axis of a plot to a link ID.
void link_plot_axes (const std::string &plot_name, int link_id, int axes=-1)
 Link multiple axes of a plot to a link ID.
void setup_legend (const std::string &plot_name, int loc, int flags=0)
 Setup the legend for a plot.
void fit_plot (const std::string &plot_name)
 Fit the plot view to the data range.
void fit_all_plots ()
 Fit all plots to their data ranges.
void setup_plot_group_order (const std::string &group_name, int order)
 Setup the plot group order.
void update_plot (const std::string &plot_name, const std::string &label, const std::shared_ptr< const PlotData > &plot)
 Update a plot with new data.
void update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< double > &ys, int line_flags=0, size_t max_num_data=2048)
 Update a line plot.
void update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< double > &xs, const std::vector< double > &ys, int line_flags=0, size_t max_num_data=2048)
 Update a line plot.
void update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< double > &ys, int scatter_flags=0)
 Update a scatter plot.
void update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< double > &xs, const std::vector< double > &ys, int scatter_flags=0)
 Update a scatter plot.
void update_plot_stairs (const std::string &plot_name, const std::string &label, const std::vector< double > &ys, int stairs_flags=0)
 Update a stairs plot.
void update_plot_stairs (const std::string &plot_name, const std::string &label, const std::vector< double > &xs, const std::vector< double > &ys, int stairs_flags=0)
 Update a stairs plot.
void update_plot_histogram (const std::string &plot_name, const std::string &label, const std::vector< double > &xs, int bins=-2, const Eigen::Vector2d &range=Eigen::Vector2d(0.0, 0.0), int histogram_flags=0)
 Update a histogram plot.
void update_plot_histogram (const std::string &plot_name, const std::string &label, const std::vector< double > &xs, const std::vector< double > &ys, int x_bins=-2, int y_bins=-2, const Eigen::Vector2d &x_range=Eigen::Vector2d(0.0, 0.0), const Eigen::Vector2d &y_range=Eigen::Vector2d(0.0, 0.0), int histogram_flags=0)
 Update a 2D histogram plot.
template<typename T>
auto update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< T > &ys, int line_flags=0, size_t max_num_data=8192 *12) -> std::enable_if_t< std::is_arithmetic_v< T >, void >
 Update a line plot.
template<typename T1, typename T2>
void update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< T1 > &xs, const std::vector< T2 > &ys, int line_flags=0, size_t max_num_data=8192 *12)
 Update a line plot.
template<typename T, int D, typename Alloc>
void update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > &data, int line_flags=0, size_t max_num_data=8192 *12)
 Update a line plot.
template<typename T, typename Func>
auto update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< T > &data, const Func &transform, int line_flags=0, size_t max_num_data=8192 *12) -> std::enable_if_t<!std::is_arithmetic_v< decltype(transform(data[0]))>, void >
 Update a line plot.
template<typename T, typename Func>
auto update_plot_line (const std::string &plot_name, const std::string &label, const std::vector< T > &data, const Func &transform, int line_flags=0, size_t max_num_data=8192 *12) -> std::enable_if_t< std::is_arithmetic_v< decltype(transform(data[0]))>, void >
 Update a line plot.
template<typename T>
auto update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< T > &ys, int scatter_flags=0) -> std::enable_if_t< std::is_arithmetic_v< T >, void >
 Update a scatter plot.
template<typename T1, typename T2>
void update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< T1 > &xs, const std::vector< T2 > &ys, int scatter_flags=0)
 Update a scatter plot.
template<typename T, int D, typename Alloc>
void update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > &data, int scatter_flags=0)
 Update a scatter plot.
template<typename T, typename Func>
auto update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< T > &data, const Func &transform, int scatter_flags=0, size_t max_num_data=8192 *12) -> std::enable_if_t<!std::is_arithmetic_v< decltype(transform(data[0]))>, void >
 Update a scatter plot.
template<typename T, typename Func>
auto update_plot_scatter (const std::string &plot_name, const std::string &label, const std::vector< T > &data, const Func &transform, int scatter_flags=0, size_t max_num_data=8192 *12) -> std::enable_if_t< std::is_arithmetic_v< decltype(transform(data[0]))>, void >
 Update a scatter plot.
template<typename T>
void update_plot_stairs (const std::string &plot_name, const std::string &label, const std::vector< T > &ys, int stairs_flags=0)
 Update a stairs plot.
template<typename T1, typename T2>
void update_plot_stairs (const std::string &plot_name, const std::string &label, const std::vector< T1 > &xs, const std::vector< T2 > &ys, int stairs_flags=0)
 Update a stairs plot.
template<typename T>
void update_plot_histogram (const std::string &plot_name, const std::string &label, const std::vector< T > &xs, int bins=-2, const Eigen::Vector2d &range=Eigen::Vector2d(0.0, 0.0), int histogram_flags=0)
 Update a histogram plot.
template<typename T1, typename T2>
void update_plot_histogram (const std::string &plot_name, const std::string &label, const std::vector< T1 > &xs, const std::vector< T2 > &ys, int x_bins=-2, int y_bins=-2, const Eigen::Vector2d &x_range=Eigen::Vector2d(0.0, 0.0), const Eigen::Vector2d &y_range=Eigen::Vector2d(0.0, 0.0), int histogram_flags=0)
 Update a 2D histogram plot.
void set_plot_style (const std::string &plot_name, const std::string &label, const PlotStyleConstPtr &style)
 Set the style for a plot.
void set_line_style (const std::string &plot_name, const std::string &label, const Eigen::Vector4f &color=Eigen::Vector4f(0, 0, 0, -1), float weight=-1)
 Set the line style for a plot.
void set_scatter_style (const std::string &plot_name, const std::string &label, int marker=0, float size=-1, const Eigen::Vector4f &fill=Eigen::Vector4f(0, 0, 0, -1), float weight=-1, const Eigen::Vector4f &outline=Eigen::Vector4f(0, 0, 0, -1))
 Set the scatter style for a plot.
AsyncLightViewerContext async_sub_viewer (const std::string &context_name, const Eigen::Vector2i &canvas_size=Eigen::Vector2i(-1, -1))
 Create a async sub viewer context.
void remove_async_sub_viewer (const std::string &context_name)
 Remove an async sub viewer context.
Public Member Functions inherited from guik::AsyncLightViewerContext
 AsyncLightViewerContext ()
 AsyncLightViewerContext (LightViewerContext *context)
 ~AsyncLightViewerContext ()
void clear ()
 Clear everything in the viewer (callbacks, filters, drawables, texts).
void clear_text ()
 Clear texts.
void append_text (const std::string &text)
 Append debug text to the viewer. This method is thread-safe.
void register_ui_callback (const std::string &name, const std::function< void()> &callback=0)
 Register a UI callback function.
void remove_ui_callback (const std::string &name)
 Remove a UI callback function.
void disable_xy_grid ()
 Disable XY grid drawing.
void enable_xy_grid ()
 Enable XY grid drawing.
void set_draw_xy_grid (bool draw_xy_grid)
 Set enable/disable XY grid drawing.
void set_colormap (glk::COLORMAP colormap)
 Set colormap used for RAINBOW and VERTEX_COLORMAP modes.
void enable_partial_rendering (double clear_thresh=1e-6)
 Enable partial rendering.
void disable_partial_rendering ()
 Disable partial rendering.
void enable_backface_culling ()
 Enable backface culling. Fragments with back-facing normals will not be rendered.
void disable_backface_culling ()
 Disable backface culling.
void set_backface_culling_range (const Eigen::Vector2f &range)
 Set range of normal.z for backface culling.
void set_point_shape (float point_size=1.0f, bool metric=true, bool circle=true)
 Set point shape properties.
void clear_drawables ()
 Clear all drawables.
void clear_drawables (const std::function< bool(const std::string &)> &fn)
 Clear drawables that satisfy the given condition.
void remove_drawable (const std::string &name)
 Remove a drawable by name.
void remove_drawable (const std::regex &regex)
 Remove all drawables that match the given regex.
void save_camera_settings (const std::string &path)
 Save camera settings to a file.
void load_camera_settings (const std::string &path)
 Load camera settings from a file.
void save_color_buffer (const std::string &filename)
 Save color buffer to an image file (PNG).
void save_depth_buffer (const std::string &filename, bool real_scale=true)
 Save depth buffer to a file (PNG).
void reset_center ()
 Reset camera center to the center of the screen.
void lookat (const Eigen::Vector3f &pt)
 Make the camera look at a point.
template<typename Vector>
void lookat (const Vector &pt)
 Make the camera look at a point.
void lookat (const Eigen::Isometry3f &T_world_sensor)
 Make the camera look at a transform.
void lookat (const Eigen::Isometry3d &T_world_sensor)
 Make the camera look at a transform.
void use_orbit_camera_control (double distance=80.0, double theta=0.0, double phi=-60.0f *M_PI/180.0f)
 Use orbit camera control (XY plane) useful for systems in which XYZ = front-left-up like LiDAR odometry.
void use_orbit_camera_control_xz (double distance=80.0, double theta=0.0, double phi=0.0)
 Use orbit camera control (XZ plane) useful for systems in which XYZ = right-down-forward like visual odometry.
void use_topdown_camera_control (double distance=80.0, double theta=0.0)
 Use top-down camera control useful for 2D SLAM.
void use_arcball_camera_control (double distance=80.0, double theta=0.0, double phi=-60.0f *M_PI/180.0f)
 Use arcball camera control.
void use_fps_camera_control (double fovy_deg=60.0)
 Use FPS game-like camera control.
void use_sensor_view_camera_control (const Eigen::Isometry3f &T_sensor_camera=Eigen::Translation3f(-5.0f, 0.0f, 0.1f) *Eigen::Isometry3f::Identity(), double smoothing_factor_trans=0.75, double smoothing_factor_rot=0.9)
 Use TPS-like sensor-view camera control .
void use_perspective_projection_control (float fovy_deg=30.0f, float near_=1.0f, float far_=1000.0f)
 Use perspective projection control.
void use_orthographic_projection_control (float width=10.0f, float near_=1.0f, float far_=1000.0f)
 Use orthographic projection control.
void update_drawable_setting (const std::string &name, const ShaderSetting &shader_setting)
 Update a drawable's shader setting.
void update_points (const std::string &name, const float *data, int stride, int num_points, const ShaderSetting &shader_setting)
 Register or update a point cloud buffer.
template<typename Scalar, int Dim>
void update_points (const std::string &name, const Eigen::Matrix< Scalar, Dim, 1 > *points, int num_points, const ShaderSetting &shader_setting)
 Register or update a point cloud buffer.
template<typename Scalar, int Dim, typename Allocator>
void update_points (const std::string &name, const std::vector< Eigen::Matrix< Scalar, Dim, 1 >, Allocator > &points, const ShaderSetting &shader_setting)
 Register or update a point cloud buffer.
void update_points (const std::string &name, const float *vertices, int vertex_stride, const float *colors, int color_stride, int num_points, const ShaderSetting &shader_setting)
 Register or update a point cloud buffer with colors.
template<typename ScalarV, int DimV, typename ScalarC, int DimC>
void update_points (const std::string &name, const Eigen::Matrix< ScalarV, DimV, 1 > *points, const Eigen::Matrix< ScalarC, DimC, 1 > *colors, int num_points, const ShaderSetting &shader_setting)
 Register or update a point cloud buffer with colors.
template<typename ScalarV, int DimV, typename AllocatorV, typename ScalarC, int DimC, typename AllocatorC>
void update_points (const std::string &name, const std::vector< Eigen::Matrix< ScalarV, DimV, 1 >, AllocatorV > &points, const std::vector< Eigen::Matrix< ScalarC, DimC, 1 >, AllocatorC > &colors, const ShaderSetting &shader_setting)
 Register or update a point cloud buffer with colors.
template<typename Scalar, int Dim>
void update_normal_dists (const std::string &name, const Eigen::Matrix< Scalar, Dim, 1 > *points, const Eigen::Matrix< Scalar, Dim, Dim > *covs, int num_points, float sigma, const ShaderSetting &shader_setting)
 Register or update a normal distribution set.
template<typename Scalar, int Dim, typename Alloc1, typename Alloc2>
void update_normal_dists (const std::string &name, const std::vector< Eigen::Matrix< Scalar, Dim, 1 >, Alloc1 > &points, const std::vector< Eigen::Matrix< Scalar, Dim, Dim >, Alloc2 > &covs, float sigma, const ShaderSetting &shader_setting)
 Register or update a normal distribution set.
void update_thin_lines (const std::string &name, const float *vertices, const float *colors, int num_vertices, const unsigned int *indices, int num_indices, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
void update_thin_lines (const std::string &name, const float *vertices, const float *colors, int num_vertices, const unsigned int *indices, int num_indices, bool line_strip, const ShaderSetting &shader_setting)
template<typename Scalar, int Dim>
void update_thin_lines (const std::string &name, const Eigen::Matrix< Scalar, Dim, 1 > *points, int num_points, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename ScalarV, int DimV, typename ScalarC, int DimC>
void update_thin_lines (const std::string &name, const Eigen::Matrix< ScalarV, DimV, 1 > *points, const Eigen::Matrix< ScalarC, DimC, 1 > *colors, int num_points, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename ScalarV, int DimV, typename ScalarC, int DimC>
void update_thin_lines (const std::string &name, const Eigen::Matrix< ScalarV, DimV, 1 > *points, const Eigen::Matrix< ScalarC, DimC, 1 > *colors, int num_points, const unsigned int *indices, int num_indices, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename Alloc>
void update_thin_lines (const std::string &name, const std::vector< Point, Alloc > &points, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename Alloc>
void update_thin_lines (const std::string &name, const std::vector< Point, Alloc > &points, const std::vector< unsigned int > &indices, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename AllocP, typename Color, typename AllocC>
void update_thin_lines (const std::string &name, const std::vector< Point, AllocP > &points, const std::vector< Color, AllocC > &colors, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename AllocP, typename Color, typename AllocC>
void update_thin_lines (const std::string &name, const std::vector< Point, AllocP > &points, const std::vector< Color, AllocC > &colors, const std::vector< unsigned int > &indices, bool line_strip, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Scalar, int Dim>
void update_thin_lines (const std::string &name, const Eigen::Matrix< Scalar, Dim, 1 > *points, int num_points, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename ScalarV, int DimV, typename ScalarC, int DimC>
void update_thin_lines (const std::string &name, const Eigen::Matrix< ScalarV, DimV, 1 > *points, const Eigen::Matrix< ScalarC, DimC, 1 > *colors, int num_points, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename ScalarV, int DimV, typename ScalarC, int DimC>
void update_thin_lines (const std::string &name, const Eigen::Matrix< ScalarV, DimV, 1 > *points, const Eigen::Matrix< ScalarC, DimC, 1 > *colors, int num_points, const unsigned int *indices, int num_indices, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename Alloc>
void update_thin_lines (const std::string &name, const std::vector< Point, Alloc > &points, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename Alloc>
void update_thin_lines (const std::string &name, const std::vector< Point, Alloc > &points, const std::vector< unsigned int > &indices, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename AllocP, typename Color, typename AllocC>
void update_thin_lines (const std::string &name, const std::vector< Point, AllocP > &points, const std::vector< Color, AllocC > &colors, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
template<typename Point, typename AllocP, typename Color, typename AllocC>
void update_thin_lines (const std::string &name, const std::vector< Point, AllocP > &points, const std::vector< Color, AllocC > &colors, const std::vector< unsigned int > &indices, bool line_strip, float line_width, const ShaderSetting &shader_setting)
 Register or update a thin lines drawable.
void update_icosahedron (const std::string &name, const ShaderSetting &shader_setting)
 Register or update an icosahedron primitive.
void update_sphere (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a sphere primitive.
void update_cube (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a cube primitive.
void update_cone (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a cone primitive.
void update_frustum (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a frustum primitive.
void update_coord (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a coordinate axes primitive.
void update_wire_icosahedron (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a wireframe icosahedron primitive.
void update_wire_sphere (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a wireframe sphere primitive.
void update_wire_cube (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a wireframe cube primitive.
void update_wire_cone (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a wireframe cone primitive.
void update_wire_frustum (const std::string &name, const ShaderSetting &shader_setting)
 Register or update a wireframe frustum primitive.

Static Public Member Functions

static AsyncLightViewer * instance (const Eigen::Vector2i &size=Eigen::Vector2i(-1, -1), bool background=false, const std::string &title="screen")
 Create and run the viewer in a background thread.
static void destroy ()
 Destroy the viewer in the background thread.
static void wait ()
 Wait for the viewer to be closed.
static void wait_until_click ()
 Wait for a break button to be clicked.
static void toggle_wait ()
 Wait while a toggle checkbox is checked.
static bool running ()
 Check if the viewer is currently running.

Additional Inherited Members

Protected Attributes inherited from guik::AsyncLightViewerContext
LightViewerContext * context

Constructor & Destructor Documentation

◆ ~AsyncLightViewer()

virtual guik::AsyncLightViewer::~AsyncLightViewer ( )
virtual

Member Function Documentation

◆ async_sub_viewer()

AsyncLightViewerContext guik::AsyncLightViewer::async_sub_viewer ( const std::string & context_name,
const Eigen::Vector2i & canvas_size = Eigen::Vector2i(-1, -1) )

Create a async sub viewer context.

Note
This method causes synchronization with the visualization thread. Do not call this frequently.

◆ clear_images()

void guik::AsyncLightViewer::clear_images ( )

Clear all images.

◆ clear_plots()

void guik::AsyncLightViewer::clear_plots ( bool clear_settings = true)

Clear all plots.

Parameters
clear_settingsIf true, clear plot settings as well.

◆ destroy()

void guik::AsyncLightViewer::destroy ( )
static

Destroy the viewer in the background thread.

◆ fit_all_plots()

void guik::AsyncLightViewer::fit_all_plots ( )

Fit all plots to their data ranges.

◆ fit_plot()

void guik::AsyncLightViewer::fit_plot ( const std::string & plot_name)

Fit the plot view to the data range.

Parameters
plot_nameName of the plot.

◆ instance()

AsyncLightViewer * guik::AsyncLightViewer::instance ( const Eigen::Vector2i & size = Eigen::Vector2i(-1, -1),
bool background = false,
const std::string & title = "screen" )
static

Create and run the viewer in a background thread.

◆ invoke()

void guik::AsyncLightViewer::invoke ( const std::function< void()> & func)

Invoke a task in the visualization thread.

◆ invoke_after_rendering()

void guik::AsyncLightViewer::invoke_after_rendering ( const std::function< void()> & func)

Invoke a task after rendering in the visualization thread.

◆ invoke_once()

void guik::AsyncLightViewer::invoke_once ( const std::string & label,
const std::function< void()> & func )

Invoke a labeled task only once in the life time of the viewer.

◆ link_plot_axes()

void guik::AsyncLightViewer::link_plot_axes ( const std::string & plot_name,
int link_id,
int axes = -1 )

Link multiple axes of a plot to a link ID.

Parameters
plot_nameName of the plot.
link_idLink ID.
axesBitwise OR of axes to be linked (ImAxis_X1, ImAxis_X2, ImAxis_Y1, and/or ImAxis_Y2).

◆ link_plot_axis()

void guik::AsyncLightViewer::link_plot_axis ( const std::string & plot_name,
int link_id,
int axis )

Link an axis of a plot to a link ID.

Parameters
plot_nameName of the plot.
link_idLink ID.
axisAxis to be linked (ImAxis_X1, ImAxis_X2, ImAxis_Y1, or ImAxis_Y2).

◆ remove_async_sub_viewer()

void guik::AsyncLightViewer::remove_async_sub_viewer ( const std::string & context_name)

Remove an async sub viewer context.

Parameters
context_nameName of the context to be removed.

◆ remove_image()

void guik::AsyncLightViewer::remove_image ( const std::string & name)

Remove an image by name.

◆ remove_plot()

void guik::AsyncLightViewer::remove_plot ( const std::string & plot_name,
const std::string & label = "" )

Remove a plot by name.

Parameters
plot_nameName of the plot to be removed.
labelIf non-empty, remove only the plot with the specified label in the plot group.

◆ running()

bool guik::AsyncLightViewer::running ( )
static

Check if the viewer is currently running.

◆ set_line_style()

void guik::AsyncLightViewer::set_line_style ( const std::string & plot_name,
const std::string & label,
const Eigen::Vector4f & color = Eigen::Vector4f(0, 0, 0, -1),
float weight = -1 )

Set the line style for a plot.

Parameters
plot_nameName of the plot.
labelLabel.
colorLine color.
weightLine weight.

◆ set_plot_style()

void guik::AsyncLightViewer::set_plot_style ( const std::string & plot_name,
const std::string & label,
const PlotStyleConstPtr & style )

Set the style for a plot.

Parameters
plot_nameName of the plot.
labelLabel.
stylePlot style.

◆ set_scatter_style()

void guik::AsyncLightViewer::set_scatter_style ( const std::string & plot_name,
const std::string & label,
int marker = 0,
float size = -1,
const Eigen::Vector4f & fill = Eigen::Vector4f(0, 0, 0, -1),
float weight = -1,
const Eigen::Vector4f & outline = Eigen::Vector4f(0, 0, 0, -1) )

Set the scatter style for a plot.

Parameters
plot_nameName of the plot.
labelLabel.
markerMarker style.
sizeMarker size.
fillMarker fill color.
weightMarker outline weight.
outlineMarker outline color.

◆ setup_legend()

void guik::AsyncLightViewer::setup_legend ( const std::string & plot_name,
int loc,
int flags = 0 )

Setup the legend for a plot.

Parameters
plot_nameName of the plot.
locLocation of the legend.
flagsFlags for the legend.

◆ setup_plot()

void guik::AsyncLightViewer::setup_plot ( const std::string & plot_name,
int width,
int height,
int plot_flags = 0,
int x_flags = 0,
int y_flags = 0,
int order = -1 )

Setup a plot.

Parameters
plot_nameName of the plot.
widthWidth of the plot [pixels].
heightHeight of the plot [pixels].
plot_flagsFlags for the plot.
x_flagsFlags for the x-axis.
y_flagsFlags for the y-axis.
orderDisplay order of the plot. Plots with smaller order values are displayed first. If -1, the plot is added to the end of the display order.

◆ setup_plot_group_order()

void guik::AsyncLightViewer::setup_plot_group_order ( const std::string & group_name,
int order )

Setup the plot group order.

Parameters
group_nameName of the plot group.
orderDisplay order of the plot group. Plot groups with smaller order values are displayed first.

◆ toggle_wait()

void guik::AsyncLightViewer::toggle_wait ( )
static

Wait while a toggle checkbox is checked.

◆ update_image()

void guik::AsyncLightViewer::update_image ( const std::string & name,
int width,
int height,
const std::vector< unsigned char > & rgba_bytes,
double scale = -1.0,
int order = -1 )

Register or update an image.

Parameters
nameName of the image.
widthImage width.
heightImage height.
rgba_bytesImage data in RGBA format.
scaleScale factor for displaying the image. If negative, auto scale is used.
orderDisplay order. Images with smaller order values are displayed first. If -1, the image is added to the end of the display order.

◆ update_plot()

void guik::AsyncLightViewer::update_plot ( const std::string & plot_name,
const std::string & label,
const std::shared_ptr< const PlotData > & plot )

Update a plot with new data.

Parameters
plot_nameName of the plot.
labelLabel.
plotPlot data.

◆ update_plot_histogram() [1/4]

void guik::AsyncLightViewer::update_plot_histogram ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & xs,
const std::vector< double > & ys,
int x_bins = -2,
int y_bins = -2,
const Eigen::Vector2d & x_range = Eigen::Vector2d(0.0, 0.0),
const Eigen::Vector2d & y_range = Eigen::Vector2d(0.0, 0.0),
int histogram_flags = 0 )

Update a 2D histogram plot.

◆ update_plot_histogram() [2/4]

void guik::AsyncLightViewer::update_plot_histogram ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & xs,
int bins = -2,
const Eigen::Vector2d & range = Eigen::Vector2d(0.0, 0.0),
int histogram_flags = 0 )

Update a histogram plot.

Parameters
plot_nameName of the plot.
labelLabel.
xsData to be histogrammed.
binsNumber of bins.
rangeData range of the histogram.
histogram_flagsFlags for the histogram plot.

◆ update_plot_histogram() [3/4]

template<typename T>
void guik::AsyncLightViewer::update_plot_histogram ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & xs,
int bins = -2,
const Eigen::Vector2d & range = Eigen::Vector2d(0.0, 0.0),
int histogram_flags = 0 )

Update a histogram plot.

◆ update_plot_histogram() [4/4]

template<typename T1, typename T2>
void guik::AsyncLightViewer::update_plot_histogram ( const std::string & plot_name,
const std::string & label,
const std::vector< T1 > & xs,
const std::vector< T2 > & ys,
int x_bins = -2,
int y_bins = -2,
const Eigen::Vector2d & x_range = Eigen::Vector2d(0.0, 0.0),
const Eigen::Vector2d & y_range = Eigen::Vector2d(0.0, 0.0),
int histogram_flags = 0 )

Update a 2D histogram plot.

◆ update_plot_line() [1/7]

void guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & xs,
const std::vector< double > & ys,
int line_flags = 0,
size_t max_num_data = 2048 )

Update a line plot.

Parameters
plot_nameName of the plot.
labelLabel.
xsX data.
ysY data.
line_flagsFlags for the line plot.
max_num_dataMaximum number of data points to be displayed.

◆ update_plot_line() [2/7]

void guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & ys,
int line_flags = 0,
size_t max_num_data = 2048 )

Update a line plot.

Parameters
plot_nameName of the plot.
labelLabel.
ysY data.
line_flagsFlags for the line plot.
max_num_dataMaximum number of data points to be displayed.

◆ update_plot_line() [3/7]

template<typename T, int D, typename Alloc>
void guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > & data,
int line_flags = 0,
size_t max_num_data = 8192 * 12 )

Update a line plot.

◆ update_plot_line() [4/7]

template<typename T, typename Func>
auto guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & data,
const Func & transform,
int line_flags = 0,
size_t max_num_data = 8192 * 12 )->std::enable_if_t< std::is_arithmetic_v< decltype(transform(data[0]))>, void >
inline

Update a line plot.

◆ update_plot_line() [5/7]

template<typename T, typename Func>
auto guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & data,
const Func & transform,
int line_flags = 0,
size_t max_num_data = 8192 * 12 )->std::enable_if_t<!std::is_arithmetic_v< decltype(transform(data[0]))>, void >
inline

Update a line plot.

◆ update_plot_line() [6/7]

template<typename T>
auto guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & ys,
int line_flags = 0,
size_t max_num_data = 8192 * 12 )->std::enable_if_t< std::is_arithmetic_v< T >, void >

Update a line plot.

◆ update_plot_line() [7/7]

template<typename T1, typename T2>
void guik::AsyncLightViewer::update_plot_line ( const std::string & plot_name,
const std::string & label,
const std::vector< T1 > & xs,
const std::vector< T2 > & ys,
int line_flags = 0,
size_t max_num_data = 8192 * 12 )

Update a line plot.

◆ update_plot_scatter() [1/7]

void guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & xs,
const std::vector< double > & ys,
int scatter_flags = 0 )

Update a scatter plot.

Parameters
plot_nameName of the plot.
labelLabel.
xsX data.
ysY data.
scatter_flagsFlags for the scatter plot.

◆ update_plot_scatter() [2/7]

void guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & ys,
int scatter_flags = 0 )

Update a scatter plot.

Parameters
plot_nameName of the plot.
labelLabel.
ysY data.
scatter_flagsFlags for the scatter plot.

◆ update_plot_scatter() [3/7]

template<typename T, int D, typename Alloc>
void guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > & data,
int scatter_flags = 0 )

Update a scatter plot.

◆ update_plot_scatter() [4/7]

template<typename T, typename Func>
auto guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & data,
const Func & transform,
int scatter_flags = 0,
size_t max_num_data = 8192 * 12 )->std::enable_if_t< std::is_arithmetic_v< decltype(transform(data[0]))>, void >
inline

Update a scatter plot.

◆ update_plot_scatter() [5/7]

template<typename T, typename Func>
auto guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & data,
const Func & transform,
int scatter_flags = 0,
size_t max_num_data = 8192 * 12 )->std::enable_if_t<!std::is_arithmetic_v< decltype(transform(data[0]))>, void >
inline

Update a scatter plot.

◆ update_plot_scatter() [6/7]

template<typename T>
auto guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & ys,
int scatter_flags = 0 )->std::enable_if_t< std::is_arithmetic_v< T >, void >

Update a scatter plot.

◆ update_plot_scatter() [7/7]

template<typename T1, typename T2>
void guik::AsyncLightViewer::update_plot_scatter ( const std::string & plot_name,
const std::string & label,
const std::vector< T1 > & xs,
const std::vector< T2 > & ys,
int scatter_flags = 0 )

Update a scatter plot.

◆ update_plot_stairs() [1/4]

void guik::AsyncLightViewer::update_plot_stairs ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & xs,
const std::vector< double > & ys,
int stairs_flags = 0 )

Update a stairs plot.

Parameters
plot_nameName of the plot.
labelLabel.
xsX data.
ysY data.
stairs_flagsFlags for the stairs plot.

◆ update_plot_stairs() [2/4]

void guik::AsyncLightViewer::update_plot_stairs ( const std::string & plot_name,
const std::string & label,
const std::vector< double > & ys,
int stairs_flags = 0 )

Update a stairs plot.

Parameters
plot_nameName of the plot.
labelLabel.
ysY data.
stairs_flagsFlags for the stairs plot.

◆ update_plot_stairs() [3/4]

template<typename T>
void guik::AsyncLightViewer::update_plot_stairs ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & ys,
int stairs_flags = 0 )

Update a stairs plot.

◆ update_plot_stairs() [4/4]

template<typename T1, typename T2>
void guik::AsyncLightViewer::update_plot_stairs ( const std::string & plot_name,
const std::string & label,
const std::vector< T1 > & xs,
const std::vector< T2 > & ys,
int stairs_flags = 0 )

Update a stairs plot.

◆ wait()

void guik::AsyncLightViewer::wait ( )
static

Wait for the viewer to be closed.

◆ wait_until_click()

void guik::AsyncLightViewer::wait_until_click ( )
static

Wait for a break button to be clicked.


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