configuration of rectangle renderer More...
#include <rectangle_renderer.h>
Public Member Functions | |
| rectangle_render_style () | |
| default constructor initializes members as specified in member comments | |
 Public Member Functions inherited from cgv::render::group_render_style | |
| group_render_style () | |
| set default values | |
Public Attributes | |
| bool | position_is_center |
| flag whether position attribute is the rectangle center; otherwise position is lower left corner (default: true) | |
| rgba | default_secondary_color |
| default value of secondary color which is ignored if set_secondary_color_array() is used to set per rectangle secondary colors (default: opaque 50% grey) | |
| rgba | default_border_color |
| default value for the border color attribute which is ignored when set_border_color_array() is used to set per rectangle border colors (default: opaque black) | |
| float | border_width_in_pixel |
| border width measured in pixels (default: 0) | |
| float | percentual_border_width |
border width measured relative to rectangle extent computed according to current border_mode (default: 0) | |
| RectangleBoderMode | border_mode |
| different modes of computing the width of the border (default: RBM_MIN) | |
| float | pixel_blend |
| number of pixels around the rectangle splat used for antialiasing (default: 0.0f) | |
| RectangleTextureMode | texture_mode |
| mode of using texture during rastrization (default: RTM_REPLACE) | |
| float | default_depth_offset |
| default depth offset added to depth value of fragment. (default: 0.0f) | |
| bool | blend_rectangles |
| if true the renderer enables blending in the enable method and recovers previous blending mode on disable (default: false) | |
| Public Attributes inherited from cgv::render::surface_render_style | |
| cgv::media::illum::surface_material::color_type | surface_color |
| default value for color when map color to material is used | |
| float | surface_opacity |
| default value for the surface opacity when map color to material is used | |
| CullingMode | culling_mode |
| culling mode for point splats, set to CM_OFF in constructor | |
| IlluminationMode | illumination_mode |
illumination mode defaults to IM_ONE_SIDED | |
| ColorMapping | map_color_to_material |
| material side[s] where color is to be mapped to the diffuse material component, defaults to MS_FRONT_AND_BACK | |
| cgv::media::illum::textured_surface_material | material |
| material of surface | |
| Public Attributes inherited from cgv::render::group_render_style | |
| bool | use_group_color |
| whether to use group colors indexed through group index, defaults to false | |
| bool | use_group_transformation |
| whether to use group translation and rotation indexed through group index, defaults to false | |
Detailed Description
configuration of rectangle renderer
Definition at line 51 of file rectangle_renderer.h.
Constructor & Destructor Documentation
◆ rectangle_render_style()
| cgv::render::rectangle_render_style::rectangle_render_style | ( | ) |
default constructor initializes members as specified in member comments
Definition at line 49 of file rectangle_renderer.cxx.
References blend_rectangles, border_mode, border_width_in_pixel, default_border_color, default_depth_offset, default_secondary_color, percentual_border_width, pixel_blend, position_is_center, and texture_mode.
Member Data Documentation
◆ blend_rectangles
| bool cgv::render::rectangle_render_style::blend_rectangles |
if true the renderer enables blending in the enable method and recovers previous blending mode on disable (default: false)
Definition at line 80 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::disable(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ border_mode
| RectangleBoderMode cgv::render::rectangle_render_style::border_mode |
different modes of computing the width of the border (default: RBM_MIN)
Definition at line 70 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ border_width_in_pixel
| float cgv::render::rectangle_render_style::border_width_in_pixel |
border width measured in pixels (default: 0)
Definition at line 66 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ default_border_color
| rgba cgv::render::rectangle_render_style::default_border_color |
default value for the border color attribute which is ignored when set_border_color_array() is used to set per rectangle border colors (default: opaque black)
Definition at line 64 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ default_depth_offset
| float cgv::render::rectangle_render_style::default_depth_offset |
default depth offset added to depth value of fragment. (default: 0.0f)
Depth values are in [0,1]. Minimal depth offsets can be estimated from 1/2^n where n is the number of bits in the depth buffer (typically 24 or 32).
Definition at line 78 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ default_secondary_color
| rgba cgv::render::rectangle_render_style::default_secondary_color |
default value of secondary color which is ignored if set_secondary_color_array() is used to set per rectangle secondary colors (default: opaque 50% grey)
Definition at line 62 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ percentual_border_width
| float cgv::render::rectangle_render_style::percentual_border_width |
border width measured relative to rectangle extent computed according to current border_mode (default: 0)
Definition at line 68 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ pixel_blend
| float cgv::render::rectangle_render_style::pixel_blend |
number of pixels around the rectangle splat used for antialiasing (default: 0.0f)
Definition at line 72 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
◆ position_is_center
|
mutable |
flag whether position attribute is the rectangle center; otherwise position is lower left corner (default: true)
This is the only member of style that can be set by rectangle_renderer. The following functions set this member to false:
- set_rectangle()
- set_rectangle_array()
- set_textured_rectangle_array() Thus it is important to set the render style of the renderer before you call any of these functions.
Definition at line 60 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), and rectangle_render_style().
◆ texture_mode
| RectangleTextureMode cgv::render::rectangle_render_style::texture_mode |
mode of using texture during rastrization (default: RTM_REPLACE)
Definition at line 74 of file rectangle_renderer.h.
Referenced by cgv::gui::rectangle_render_style_gui_creator::create(), cgv::render::rectangle_renderer::enable(), and rectangle_render_style().
The documentation for this struct was generated from the following files:
- libs/cgv_gl/rectangle_renderer.h
- libs/cgv_gl/rectangle_renderer.cxx
