plot independent configuration parameters of one sub plot in a 2d or 3d plot More...
#include <plot_base.h>
Public Member Functions | |
| plot_base_config (const std::string &_name, unsigned dim) | |
| set default values | |
| virtual void | configure_chart (ChartType chart_type) |
| configure the sub plot to a specific chart type | |
| virtual void | set_colors (const rgb &base_color) |
| set all colors from reference color | |
| virtual void | set_color_indices (int idx) |
| virtual void | set_opacities (float _opa) |
| set all opacities from reference opacity | |
| virtual void | set_opacity_indices (int idx) |
| virtual void | set_sizes (float _size) |
| set all sizes from reference size | |
| virtual void | set_size_indices (int idx) |
| virtual | ~plot_base_config () |
| virtual constructor in order to allow to extend the configuration for derived classes | |
Public Attributes | |
| std::string | name |
| name of sub plot | |
| size_t | begin_sample |
| offset into samples defaults to 0, if larger than end_sample vector is split into two parts | |
| size_t | end_sample |
| defaults to -1 and effectively is always the end of the sample vector | |
| bool | show_plot |
| whether to show sub plot | |
| SubPlotInfluence | sub_plot_influence |
| store bit field to define which sub plots are influenced by reference values | |
| mapped_rgb | ref_color |
| reference color, when changed, all colors are adapted with set_colors() | |
| mapped_opacity | ref_opacity |
| reference opacity, when changed, all opcities are adapted with set_opacity() | |
| mapped_size | ref_size |
| reference size, when changed, all sizes are adapted with set_size() | |
| bool | show_points |
| whether to show data points | |
| mapped_size | point_size |
| point size in pixels | |
| mapped_rgba | point_color |
| point color | |
| mapped_size | point_halo_width |
| width of point halo in pixel | |
| mapped_rgba | point_halo_color |
| color of point halo | |
| bool | show_lines |
| whether to connect data points with lines | |
| mapped_size | line_width |
| line width | |
| mapped_rgba | line_color |
| line color | |
| mapped_size | line_halo_width |
| width of line halo in pixel | |
| mapped_rgba | line_halo_color |
| color of line halo | |
| bool | show_sticks |
| whether to show straight lines to the bottom of the plot, which are called sticks | |
| int | stick_coordinate_index |
| extended stick information | |
| float | stick_base_window |
| base window position of stick | |
| mapped_size | stick_width |
| line width of stick | |
| mapped_rgba | stick_color |
| color of the stick line | |
| bool | show_bars |
| whether to show bars | |
| int | bar_coordinate_index |
| extended bar information | |
| float | bar_base_window |
| mapped_size | bar_outline_width |
| line width of bar outlines | |
| mapped_size | bar_percentual_width |
| percentual width of bar computed assuming a uniform y-sampling distance | |
| mapped_rgba | bar_color |
| bar fill color | |
| mapped_rgba | bar_outline_color |
| bar outline color | |
Detailed Description
plot independent configuration parameters of one sub plot in a 2d or 3d plot
Definition at line 129 of file plot_base.h.
Constructor & Destructor Documentation
◆ plot_base_config()
| cgv::plot::plot_base_config::plot_base_config | ( | const std::string & | _name, |
| unsigned | dim | ||
| ) |
set default values
Definition at line 47 of file plot_base.cxx.
References bar_coordinate_index, bar_percentual_width, begin_sample, configure_chart(), end_sample, ref_color, ref_opacity, ref_size, set_colors(), set_opacities(), set_sizes(), show_plot, stick_base_window, stick_coordinate_index, and sub_plot_influence.
◆ ~plot_base_config()
|
virtual |
virtual constructor in order to allow to extend the configuration for derived classes
Definition at line 191 of file plot_base.cxx.
Member Function Documentation
◆ configure_chart()
|
virtual |
configure the sub plot to a specific chart type
Reimplemented in cgv::plot::plot2d_config.
Definition at line 68 of file plot_base.cxx.
References show_bars, show_points, and show_sticks.
Referenced by cgv::plot::plot2d_config::configure_chart(), and plot_base_config().
◆ set_color_indices()
|
virtual |
Definition at line 108 of file plot_base.cxx.
◆ set_colors()
|
virtual |
set all colors from reference color
Reimplemented in cgv::plot::plot3d_config.
Definition at line 84 of file plot_base.cxx.
References bar_color, bar_outline_color, line_color, line_halo_color, point_color, point_halo_color, ref_color, cgv::media::hls_color_interface< color< T, cm, am > >::S(), stick_color, and sub_plot_influence.
Referenced by plot_base_config(), cgv::plot::plot3d_config::set_colors(), and cgv::plot::plot_base::set_sub_plot_colors().
◆ set_opacities()
|
virtual |
set all opacities from reference opacity
Definition at line 156 of file plot_base.cxx.
References bar_color, bar_outline_color, line_color, line_halo_color, point_color, point_halo_color, ref_opacity, stick_color, and sub_plot_influence.
Referenced by plot_base_config().
◆ set_opacity_indices()
|
virtual |
Definition at line 174 of file plot_base.cxx.
◆ set_size_indices()
|
virtual |
Definition at line 141 of file plot_base.cxx.
◆ set_sizes()
|
virtual |
set all sizes from reference size
Definition at line 125 of file plot_base.cxx.
References bar_outline_width, line_halo_width, line_width, point_halo_width, point_size, ref_size, stick_width, and sub_plot_influence.
Referenced by plot_base_config().
Member Data Documentation
◆ bar_base_window
| float cgv::plot::plot_base_config::bar_base_window |
Definition at line 190 of file plot_base.h.
◆ bar_color
| mapped_rgba cgv::plot::plot_base_config::bar_color |
bar fill color
Definition at line 196 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_bar_config_gui(), set_colors(), and set_opacities().
◆ bar_coordinate_index
| int cgv::plot::plot_base_config::bar_coordinate_index |
extended bar information
Definition at line 188 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_bar_config_gui(), and plot_base_config().
◆ bar_outline_color
| mapped_rgba cgv::plot::plot_base_config::bar_outline_color |
bar outline color
Definition at line 198 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_bar_config_gui(), set_colors(), and set_opacities().
◆ bar_outline_width
| mapped_size cgv::plot::plot_base_config::bar_outline_width |
line width of bar outlines
Definition at line 192 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_bar_config_gui(), and set_sizes().
◆ bar_percentual_width
| mapped_size cgv::plot::plot_base_config::bar_percentual_width |
percentual width of bar computed assuming a uniform y-sampling distance
Definition at line 194 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_bar_config_gui(), and plot_base_config().
◆ begin_sample
| size_t cgv::plot::plot_base_config::begin_sample |
offset into samples defaults to 0, if larger than end_sample vector is split into two parts
Definition at line 135 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_base_config_gui(), and plot_base_config().
◆ end_sample
| size_t cgv::plot::plot_base_config::end_sample |
defaults to -1 and effectively is always the end of the sample vector
Definition at line 137 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_base_config_gui(), and plot_base_config().
◆ line_color
| mapped_rgba cgv::plot::plot_base_config::line_color |
line color
Definition at line 168 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_line_config_gui(), set_colors(), and set_opacities().
◆ line_halo_color
| mapped_rgba cgv::plot::plot_base_config::line_halo_color |
color of line halo
Definition at line 172 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_line_config_gui(), set_colors(), and set_opacities().
◆ line_halo_width
| mapped_size cgv::plot::plot_base_config::line_halo_width |
width of line halo in pixel
Definition at line 170 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_line_config_gui(), and set_sizes().
◆ line_width
| mapped_size cgv::plot::plot_base_config::line_width |
line width
Definition at line 166 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_line_config_gui(), and set_sizes().
◆ name
| std::string cgv::plot::plot_base_config::name |
name of sub plot
Definition at line 132 of file plot_base.h.
Referenced by cgv::plot::plot2d::add_sub_plot(), cgv::plot::plot3d::add_sub_plot(), cgv::plot::plot_base::create_base_config_gui(), and cgv::plot::plot_base::create_gui().
◆ point_color
| mapped_rgba cgv::plot::plot_base_config::point_color |
point color
Definition at line 157 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_point_config_gui(), set_colors(), and set_opacities().
◆ point_halo_color
| mapped_rgba cgv::plot::plot_base_config::point_halo_color |
color of point halo
Definition at line 161 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_point_config_gui(), set_colors(), and set_opacities().
◆ point_halo_width
| mapped_size cgv::plot::plot_base_config::point_halo_width |
width of point halo in pixel
Definition at line 159 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_point_config_gui(), and set_sizes().
◆ point_size
| mapped_size cgv::plot::plot_base_config::point_size |
point size in pixels
Definition at line 154 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_point_config_gui(), and set_sizes().
◆ ref_color
| mapped_rgb cgv::plot::plot_base_config::ref_color |
reference color, when changed, all colors are adapted with set_colors()
Definition at line 145 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_base_config_gui(), cgv::plot::plot_base::create_gui(), plot_base_config(), and set_colors().
◆ ref_opacity
| mapped_opacity cgv::plot::plot_base_config::ref_opacity |
reference opacity, when changed, all opcities are adapted with set_opacity()
Definition at line 147 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_base_config_gui(), plot_base_config(), and set_opacities().
◆ ref_size
| mapped_size cgv::plot::plot_base_config::ref_size |
reference size, when changed, all sizes are adapted with set_size()
Definition at line 149 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_base_config_gui(), plot_base_config(), and set_sizes().
◆ show_bars
| bool cgv::plot::plot_base_config::show_bars |
whether to show bars
Definition at line 186 of file plot_base.h.
Referenced by configure_chart(), cgv::plot::plot_base::create_config_gui(), and cgv::plot::plot3d_config::plot3d_config().
◆ show_lines
| bool cgv::plot::plot_base_config::show_lines |
whether to connect data points with lines
Definition at line 164 of file plot_base.h.
Referenced by cgv::plot::plot2d_config::configure_chart(), cgv::plot::plot_base::create_config_gui(), and cgv::plot::plot3d_config::plot3d_config().
◆ show_plot
| bool cgv::plot::plot_base_config::show_plot |
whether to show sub plot
Definition at line 140 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_config_gui(), cgv::plot::plot_base::create_gui(), and plot_base_config().
◆ show_points
| bool cgv::plot::plot_base_config::show_points |
whether to show data points
Definition at line 152 of file plot_base.h.
Referenced by configure_chart(), cgv::plot::plot_base::create_config_gui(), and cgv::plot::plot3d_config::plot3d_config().
◆ show_sticks
| bool cgv::plot::plot_base_config::show_sticks |
whether to show straight lines to the bottom of the plot, which are called sticks
Definition at line 175 of file plot_base.h.
Referenced by configure_chart(), and cgv::plot::plot_base::create_config_gui().
◆ stick_base_window
| float cgv::plot::plot_base_config::stick_base_window |
base window position of stick
Definition at line 179 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_stick_config_gui(), and plot_base_config().
◆ stick_color
| mapped_rgba cgv::plot::plot_base_config::stick_color |
color of the stick line
Definition at line 183 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_stick_config_gui(), set_colors(), and set_opacities().
◆ stick_coordinate_index
| int cgv::plot::plot_base_config::stick_coordinate_index |
extended stick information
Definition at line 177 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_stick_config_gui(), and plot_base_config().
◆ stick_width
| mapped_size cgv::plot::plot_base_config::stick_width |
line width of stick
Definition at line 181 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_stick_config_gui(), and set_sizes().
◆ sub_plot_influence
| SubPlotInfluence cgv::plot::plot_base_config::sub_plot_influence |
store bit field to define which sub plots are influenced by reference values
Definition at line 143 of file plot_base.h.
Referenced by cgv::plot::plot_base::create_base_config_gui(), plot_base_config(), set_colors(), set_opacities(), and set_sizes().
The documentation for this struct was generated from the following files:
- libs/plot/plot_base.h
- libs/plot/plot_base.cxx
