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

Light viewer. The main visualization class in Iridescence. More...

#include <light_viewer.hpp>

Inheritance diagram for guik::LightViewer:
Collaboration diagram for guik::LightViewer:

Classes

class  ViewerUI
class  InfoWindow

Public Member Functions

 LightViewer ()
 Constructor. Do not call directly. Use LightViewer::instance() instead.
virtual ~LightViewer ()
bool spin_until_click ()
 Spin the viewer until a mouse click event is received.
bool toggle_spin_once ()
 Spin the viewer until a toggle flag is set to true.
virtual void register_ui_callback (const std::string &name, const std::function< void()> &callback=0) override
 Register a UI callback function.
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.
virtual void clear () override
 Clear everything in the viewer (text, drawables, filters).
virtual void clear_text () override
 Clear the text buffer.
virtual void append_text (const std::string &text) override
 Append text to the text buffer. This method is thread-safe.
void set_max_text_buffer_size (int size)
 Set the maximum text buffer size.
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, const std::shared_ptr< glk::Texture > &image, double scale=-1.0, int order=-1)
 Register or update an image.
std::shared_ptr< LightViewerContext > sub_viewer (const std::string &context_name, const Eigen::Vector2i &canvas_size=Eigen::Vector2i(-1, -1))
 Create or get a sub viewer context.
void show_sub_viewers ()
 Show all sub viewer windows.
std::shared_ptr< LightViewerContext > find_sub_viewer (const std::string &context_name)
 Find a sub viewer context by name.
bool remove_sub_viewer (const std::string &context_name)
 Remove a sub viewer context by name.
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=8192 *12)
 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=8192 *12)
 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, int D, typename Alloc>
void update_plot_stairs (const std::string &plot_name, const std::string &label, const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > &data, int stairs_flags=0)
 Update a stairs plot.
template<typename T, typename Func>
void update_plot_stairs (const std::string &plot_name, const std::string &label, const std::vector< T > &data, const Func &transform, 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.
template<typename T, int D, typename Alloc>
void update_plot_histogram (const std::string &plot_name, const std::string &label, const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > &data, 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, typename Func>
void update_plot_histogram (const std::string &plot_name, const std::string &label, const std::vector< T > &data, const Func &transform, 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.
void show_viewer_ui ()
 Show the viewer UI.
void show_info_window ()
 Show the info window.
Public Member Functions inherited from guik::Application
 Application ()
virtual ~Application ()
bool ok () const
void enable_vsync ()
void disable_vsync ()
void enable_docking ()
void disable_docking ()
Eigen::Vector2i window_size () const
virtual void show_window ()
virtual void hide_window ()
virtual void maximize_window ()
virtual void fullscreen_window ()
virtual void resize (const Eigen::Vector2i &size)
void set_title (const std::string &title)
Eigen::Vector2i framebuffer_size () const
void spin ()
bool spin_once ()
void begin_ui ()
void begin_gl ()
bool end ()
void close ()
bool closed ()
Public Member Functions inherited from guik::LightViewerContext
 LightViewerContext (const std::string &context_name)
virtual ~LightViewerContext ()
void draw_ui ()
void draw_gl ()
bool init_canvas (const Eigen::Vector2i &size)
void set_size (const Eigen::Vector2i &size)
void set_clear_color (const Eigen::Vector4f &color)
void set_pos (const Eigen::Vector2i &pos, ImGuiCond cond=ImGuiCond_FirstUseEver, ImGuiWindowFlags=0)
void show ()
void hide ()
void remove_ui_callback (const std::string &name)
 Remove a UI callback function.
guik::ShaderSetting & shader_setting ()
 Global shader setting.
const guik::ShaderSetting & shader_setting () const
 Global shader setting.
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 set_screen_effect (const std::shared_ptr< glk::ScreenEffect > &effect)
 Set screen effect.
const std::shared_ptr< glk::ScreenEffect > & get_screen_effect () const
 Get screen effect.
void set_bg_texture (const std::shared_ptr< glk::Texture > &bg_texture)
 Set background texture.
void set_rainbow_range (const Eigen::Vector2f &minmax_z)
 Set range of color mapping for RAINBOW mode.
void set_rainbow_axis (const Eigen::Vector3f &axis)
 Set axis of color mapping for RAINBOW mode.
void set_colormap_range (const Eigen::Vector2f &minmax)
 Set range of color mapping for VERTEX_COLORMAP mode.
void set_point_shape (float point_size=1.0f, bool metric=true, bool circle=true)
 Set point shape properties.
void enable_normal_buffer ()
 Enable normal buffer.
void enable_info_buffer ()
 Enable info buffer.
void enable_decimal_rendering ()
 Enable partial rendering (This method will be deprecated).
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 the range of normal.z for backface culling. Fragments with normal.z outside the range will be culled when backface culling is enabled.
bool normal_buffer_enabled () const
 Whether normal buffer is enabled.
bool info_buffer_enabled () const
 Whether info buffer is enabled.
bool partial_rendering_enabled () const
 Whether partial rendering is enabled.
bool backface_culling_enabled () const
 Whether backface culling is enabled.
const glk::Texture & color_buffer () const
 Color buffer.
const glk::Texture & depth_buffer () const
 Depth buffer.
const glk::Texture & normal_buffer () const
 Normal buffer.
const glk::Texture & info_buffer () const
 Info buffer.
const glk::Texture & dynamic_flag_buffer () const
 Dynamic flag buffer.
void clear_drawables ()
 Clear all drawables.
void clear_drawables (const std::function< bool(const std::string &)> &fn)
 Clear drawables that satisfy the given condition.
std::unordered_map< std::string, std::pair< ShaderSetting::Ptr, glk::Drawable::ConstPtr > > & get_drawables ()
 Get all drawables.
std::pair< ShaderSetting::Ptr, glk::Drawable::ConstPtr > find_drawable (const std::string &name)
 Find a drawable by name.
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 update_drawable (const std::string &name, const glk::Drawable::ConstPtr &drawable, const ShaderSetting &shader_setting=ShaderSetting())
 Update a drawable.
void clear_drawable_filters ()
 Clear all drawable filters.
void register_drawable_filter (const std::string &filter_name, const std::function< bool(const std::string &)> &filter=0)
 Register a drawable filter.
void remove_drawable_filter (const std::string &filter_name)
 Remove a drawable filter.
void clear_partial_rendering ()
 Clear partial rendering buffer.
const std::shared_ptr< CameraControl > & get_camera_control () const
 Get camera control (model matrix control).
const std::shared_ptr< ProjectionControl > & get_projection_control () const
 Get projection control (projection matrix control).
void set_camera_control (const std::shared_ptr< CameraControl > &camera_control)
 Set camera control (model matrix control).
void set_projection_control (const std::shared_ptr< ProjectionControl > &projection_control)
 Set projection control (projection matrix control).
bool save_camera_settings (const std::string &path) const
 Save camera settings to a file.
bool load_camera_settings (const std::string &path)
 Load camera settings from a file.
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.
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.
template<typename Vector>
void lookat (const Vector &pt)
 Make the camera look at a point.
std::shared_ptr< OrbitCameraControlXY > 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.
std::shared_ptr< OrbitCameraControlXZ > 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.
std::shared_ptr< TopDownCameraControl > use_topdown_camera_control (double distance=80.0, double theta=0.0)
 Use top-down camera control useful for 2D SLAM.
std::shared_ptr< ArcBallCameraControl > use_arcball_camera_control (double distance=80.0, double theta=0.0, double phi=-60.0f *M_PI/180.0f)
 Use arcball camera control.
std::shared_ptr< FPSCameraControl > use_fps_camera_control (double fovy_deg=60.0)
 Use FPS game-like camera control.
std::shared_ptr< SensorViewCameraControl > 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 sensor-view camera control that follows a given sensor pose.
std::shared_ptr< BasicProjectionControl > use_perspective_projection_control (float fovy_deg=30.0f, float near_=1.0f, float far_=1000.0f)
 Use perspective projection control.
std::shared_ptr< BasicProjectionControl > use_orthographic_projection_control (float width=10.0f, float near_=1.0f, float far_=1000.0f)
 Use orthographic projection control.
guik::GLCanvas & get_canvas ()
 Get underlying GLCanvas.
Eigen::Vector2i canvas_tl () const
Eigen::Vector2i canvas_br () const
 Get bottom right corner of the canvas rectangle.
Eigen::Vector2i canvas_size () const
 Get canvas size.
Eigen::Matrix4f view_matrix () const
 Get view matrix.
Eigen::Matrix4f projection_matrix () const
 Get projection matrix.
Eigen::Vector4i pick_info (const Eigen::Vector2i &p, int window=2) const
 Pick info from the info buffer.
float pick_depth (const Eigen::Vector2i &p, int window=2) const
 Pick depth from the depth buffer.
Eigen::Vector3f unproject (const Eigen::Vector2i &p, float depth) const
 Unproject a pixel to a 3D point.
std::optional< Eigen::Vector3f > pick_point (int button=0, int window=2, Eigen::Vector4i *info=nullptr) const
 Pick a 3D point from the depth buffer.
std::vector< unsigned char > read_color_buffer () const
 Read color buffer values.
std::vector< float > read_depth_buffer (bool real_scale=true)
 Read depth buffer values.
bool save_color_buffer (const std::string &filename)
 Save color buffer to an image file (PNG).
bool save_depth_buffer (const std::string &filename, bool real_scale=true)
 Save depth buffer to a file (PNG).
AsyncLightViewerContext async ()
 Get an asynchronous light viewer context.
std::shared_ptr< glk::PointCloudBuffer > 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>
std::shared_ptr< glk::PointCloudBuffer > 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>
std::shared_ptr< glk::PointCloudBuffer > 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.
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.
std::shared_ptr< glk::ThinLines > 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.
std::shared_ptr< glk::ThinLines > 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)
 Register or update a thin lines drawable.
template<typename Scalar, int Dim>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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>
std::shared_ptr< glk::ThinLines > 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 LightViewer * instance (const Eigen::Vector2i &size=Eigen::Vector2i(-1, -1), bool background=false, const std::string &title="screen")
 Get the singleton instance of LightViewer. The viewer insatnce is created upon the first call.
static void destroy ()
 Destroy the singleton instance of LightViewer.
static bool running ()
 Check if the LightViewer instance is running.

Additional Inherited Members

Protected Attributes inherited from guik::Application
GLFWwindow * window
Protected Attributes inherited from guik::LightViewerContext
std::string context_name
 Viewer context name.
Eigen::Vector2i canvas_rect_min
 Top-left corner of the canvas rectangle.
Eigen::Vector2i canvas_rect_max
 Bottom-right corner of the canvas rectangle.
std::unique_ptr< guik::GLCanvas > canvas
 GL canvas.
guik::ShaderSetting global_shader_setting
 Global shader setting.
bool show_window
bool draw_xy_grid
bool decimal_rendering
Eigen::Matrix4f last_projection_view_matrix
std::unordered_map< std::string, std::function< bool(const std::string &)> > drawable_filters
std::unordered_map< std::string, std::pair< ShaderSetting::Ptr, glk::Drawable::ConstPtr > > drawables
std::mutex sub_texts_mutex
std::deque< std::string > sub_texts
std::vector< std::pair< std::string, std::function< void()> > > sub_ui_callbacks

Detailed Description

Light viewer. The main visualization class in Iridescence.

Constructor & Destructor Documentation

◆ LightViewer()

guik::LightViewer::LightViewer ( )

Constructor. Do not call directly. Use LightViewer::instance() instead.

◆ ~LightViewer()

virtual guik::LightViewer::~LightViewer ( )
virtual

Member Function Documentation

◆ append_text()

virtual void guik::LightViewer::append_text ( const std::string & text)
overridevirtual

Append text to the text buffer. This method is thread-safe.

Reimplemented from guik::LightViewerContext.

◆ clear()

virtual void guik::LightViewer::clear ( )
overridevirtual

Clear everything in the viewer (text, drawables, filters).

Reimplemented from guik::LightViewerContext.

◆ clear_images()

void guik::LightViewer::clear_images ( )

Clear all images.

◆ clear_plots()

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

Clear all plots.

Parameters
clear_settingsIf true, clear plot settings as well.

◆ clear_text()

virtual void guik::LightViewer::clear_text ( )
overridevirtual

Clear the text buffer.

Reimplemented from guik::LightViewerContext.

◆ destroy()

void guik::LightViewer::destroy ( )
static

Destroy the singleton instance of LightViewer.

◆ find_sub_viewer()

std::shared_ptr< LightViewerContext > guik::LightViewer::find_sub_viewer ( const std::string & context_name)

Find a sub viewer context by name.

◆ fit_all_plots()

void guik::LightViewer::fit_all_plots ( )

Fit all plots to their data ranges.

◆ fit_plot()

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

Fit the plot view to the data range.

Parameters
plot_nameName of the plot.

◆ instance()

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

Get the singleton instance of LightViewer. The viewer insatnce is created upon the first call.

Parameters
sizeInitial canvas size. If (-1, -1), use default size.
backgroundIf true, the viewer window is created in the background (invisible).
titleWindow title.
Returns
Pointer to the LightViewer instance.

◆ invoke()

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

Invoke a task in the visualization thread.

◆ invoke_after_rendering()

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

Invoke a task after rendering in the visualization thread.

◆ invoke_once()

void guik::LightViewer::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::LightViewer::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::LightViewer::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).

◆ register_ui_callback()

virtual void guik::LightViewer::register_ui_callback ( const std::string & name,
const std::function< void()> & callback = 0 )
overridevirtual

Register a UI callback function.

Parameters
nameName of the callback.
callbackCallback function. If nullptr, unregister the callback.

Reimplemented from guik::LightViewerContext.

◆ remove_image()

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

Remove an image by name.

◆ remove_plot()

void guik::LightViewer::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.

◆ remove_sub_viewer()

bool guik::LightViewer::remove_sub_viewer ( const std::string & context_name)

Remove a sub viewer context by name.

◆ running()

bool guik::LightViewer::running ( )
static

Check if the LightViewer instance is running.

◆ set_line_style()

void guik::LightViewer::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_max_text_buffer_size()

void guik::LightViewer::set_max_text_buffer_size ( int size)

Set the maximum text buffer size.

Parameters
sizeMaximum number of lines in the text buffer.

◆ set_plot_style()

void guik::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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.

◆ show_info_window()

void guik::LightViewer::show_info_window ( )

Show the info window.

◆ show_sub_viewers()

void guik::LightViewer::show_sub_viewers ( )

Show all sub viewer windows.

◆ show_viewer_ui()

void guik::LightViewer::show_viewer_ui ( )

Show the viewer UI.

◆ spin_until_click()

bool guik::LightViewer::spin_until_click ( )

Spin the viewer until a mouse click event is received.

◆ sub_viewer()

std::shared_ptr< LightViewerContext > guik::LightViewer::sub_viewer ( const std::string & context_name,
const Eigen::Vector2i & canvas_size = Eigen::Vector2i(-1, -1) )

Create or get a sub viewer context.

Parameters
context_nameName of the sub viewer context.
canvas_sizeCanvas size of the sub viewer. If (-1, -1), use the default size.
Returns
Sub viewer context.

◆ toggle_spin_once()

bool guik::LightViewer::toggle_spin_once ( )

Spin the viewer until a toggle flag is set to true.

◆ update_image()

void guik::LightViewer::update_image ( const std::string & name,
const std::shared_ptr< glk::Texture > & image,
double scale = -1.0,
int order = -1 )

Register or update an image.

Parameters
nameName of the image.
imageImage texture.
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::LightViewer::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/6]

void guik::LightViewer::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/6]

void guik::LightViewer::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/6]

template<typename T, int D, typename Alloc>
void guik::LightViewer::update_plot_histogram ( const std::string & plot_name,
const std::string & label,
const std::vector< Eigen::Matrix< T, D, 1 >, Alloc > & data,
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() [4/6]

template<typename T, typename Func>
void guik::LightViewer::update_plot_histogram ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & data,
const Func & transform,
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() [5/6]

template<typename T>
void guik::LightViewer::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() [6/6]

template<typename T1, typename T2>
void guik::LightViewer::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::LightViewer::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 = 8192 *12 )

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::LightViewer::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 = 8192 *12 )

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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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::LightViewer::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/6]

void guik::LightViewer::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/6]

void guik::LightViewer::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/6]

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

Update a stairs plot.

◆ update_plot_stairs() [4/6]

template<typename T, typename Func>
void guik::LightViewer::update_plot_stairs ( const std::string & plot_name,
const std::string & label,
const std::vector< T > & data,
const Func & transform,
int stairs_flags = 0 )

Update a stairs plot.

◆ update_plot_stairs() [5/6]

template<typename T>
void guik::LightViewer::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() [6/6]

template<typename T1, typename T2>
void guik::LightViewer::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.


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