cgv::plot::plot3d_config Struct Reference

extend common plot configuration with parameters specific to 2d plot More...

#include <plot3d.h>

Inheritance diagram for cgv::plot::plot3d_config:

Public Member Functions
void	set_colors (const rgb &base_color)
	add tube and surface color
	plot3d_config (const std::string &_name)
	construct with default values
Public Member Functions inherited from cgv::plot::plot_base_config
	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_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
bool	show_line_orientation
	whether to illustrate line orientation
mapped_size	bar_percentual_depth
	provide second dimension of bar extend
unsigned	samples_per_row
	if samples per row > 0, the samples are interpreted as regular grid
bool	show_surface
	whether to show faces
bool	wireframe
	whether to turn on wireframe
rgb	surface_color
	color of faces
PlotFaceIllumination	face_illumination
	how to illuminate the surface
Public Attributes inherited from cgv::plot::plot_base_config
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

extend common plot configuration with parameters specific to 2d plot

Definition at line 22 of file plot3d.h.

Constructor & Destructor Documentation

plot3d_config()

cgv::plot::plot3d_config::plot3d_config

(

const std::string &

_name

)

construct with default values

Definition at line 28 of file plot3d.cxx.

References bar_percentual_depth, face_illumination, samples_per_row, cgv::plot::plot_base_config::show_bars, show_line_orientation, cgv::plot::plot_base_config::show_lines, cgv::plot::plot_base_config::show_points, show_surface, surface_color, and wireframe.

Member Function Documentation

set_colors()

void cgv::plot::plot3d_config::set_colors ( const rgb &  base_color )

virtual

add tube and surface color

Reimplemented from cgv::plot::plot_base_config.

Definition at line 9 of file plot3d.cxx.

References cgv::plot::plot_base_config::set_colors(), and surface_color.

Member Data Documentation

bar_percentual_depth

mapped_size cgv::plot::plot3d_config::bar_percentual_depth

provide second dimension of bar extend

Definition at line 27 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_bar_config_gui(), and plot3d_config().

face_illumination

PlotFaceIllumination cgv::plot::plot3d_config::face_illumination

how to illuminate the surface

Definition at line 37 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_config_gui(), and plot3d_config().

samples_per_row

unsigned cgv::plot::plot3d_config::samples_per_row

if samples per row > 0, the samples are interpreted as regular grid

Definition at line 29 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_config_gui(), cgv::plot::plot3d::get_samples_per_row(), plot3d_config(), and cgv::plot::plot3d::set_samples_per_row().

show_line_orientation

bool cgv::plot::plot3d_config::show_line_orientation

whether to illustrate line orientation

Definition at line 25 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_line_config_gui(), and plot3d_config().

show_surface

bool cgv::plot::plot3d_config::show_surface

whether to show faces

Definition at line 31 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_config_gui(), and plot3d_config().

surface_color

rgb cgv::plot::plot3d_config::surface_color

color of faces

Definition at line 35 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_config_gui(), plot3d_config(), and set_colors().

wireframe

bool cgv::plot::plot3d_config::wireframe

whether to turn on wireframe

Definition at line 33 of file plot3d.h.

Referenced by cgv::plot::plot3d::create_config_gui(), and plot3d_config().

---

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

• libs/plot/plot3d.h
• libs/plot/plot3d.cxx