cgv
Loading...
Searching...
No Matches
cgv::render::line_render_style Struct Reference

style of a line More...

#include <line_renderer.h>

Inheritance diagram for cgv::render::line_render_style:
cgv::render::group_render_style cgv::render::render_style cgv::render::box_wire_render_style cgv::render::line_render_style_reflect cgv::render::normal_render_style cgv::render::box_wire_render_style_reflect cgv::render::normal_render_style_reflect

Public Attributes

vec3 default_normal = { 0.0f, 0.0f, 1.0f }
 default normal for case when "normal" attribute is not set
 
rgba default_color = { 1.0f }
 default color for case when "color" attribute is not set
 
float default_depth_offset = 0.0f
 default depth offset for case when "depth_offset" attribute is not set
 
float default_line_width = 1.0f
 default line width for case when "line_width" attribute is not set
 
bool blend_lines = false
 whether to enable blending while rendering (needed for smooth edges; true by default)
 
rgba halo_color = { 0.0f, 0.0f, 0.0f, 1.0f }
 halo color
 
float halo_width_in_pixel = 0.0f
 halo width in pixel
 
float percentual_halo_width = 0.0f
 halo width in percent of line width
 
bool screen_aligned = true
 whether to span line splat in screen aligned coordinate system
 
bool measure_line_width_in_pixel = true
 whether to measure line width in pixels - otherwise in eye space relative to reference_line_width
 
float reference_line_width = 0.001f
 reference line width multiplied to line width if measure_line_width_in_pixel is false
 
float blend_width_in_pixel = 0.0f
 blend with in pixels used for line smoothing
 
float halo_color_strength = 1.0f
 parameter in [0,1] to mix line color with halo color
 
- Public Attributes inherited from cgv::render::group_render_style
bool use_group_color = false
 whether to use group colors indexed through group index, defaults to false
 
bool use_group_transformation = false
 whether to use group translation and rotation indexed through group index, defaults to false
 

Detailed Description

style of a line

Definition at line 12 of file line_renderer.h.

Member Data Documentation

◆ blend_lines

bool cgv::render::line_render_style::blend_lines = false

whether to enable blending while rendering (needed for smooth edges; true by default)

Definition at line 26 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), cgv::render::line_renderer::disable(), and cgv::render::line_renderer::enable().

◆ blend_width_in_pixel

float cgv::render::line_render_style::blend_width_in_pixel = 0.0f

blend with in pixels used for line smoothing

Definition at line 46 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ default_color

rgba cgv::render::line_render_style::default_color = { 1.0f }

default color for case when "color" attribute is not set

Definition at line 19 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ default_depth_offset

float cgv::render::line_render_style::default_depth_offset = 0.0f

default depth offset for case when "depth_offset" attribute is not set

Definition at line 21 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ default_line_width

float cgv::render::line_render_style::default_line_width = 1.0f

default line width for case when "line_width" attribute is not set

Definition at line 23 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ default_normal

vec3 cgv::render::line_render_style::default_normal = { 0.0f, 0.0f, 1.0f }

default normal for case when "normal" attribute is not set

Definition at line 17 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ halo_color

rgba cgv::render::line_render_style::halo_color = { 0.0f, 0.0f, 0.0f, 1.0f }

◆ halo_color_strength

float cgv::render::line_render_style::halo_color_strength = 1.0f

parameter in [0,1] to mix line color with halo color

Definition at line 51 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ halo_width_in_pixel

float cgv::render::line_render_style::halo_width_in_pixel = 0.0f

halo width in pixel

Definition at line 33 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ measure_line_width_in_pixel

bool cgv::render::line_render_style::measure_line_width_in_pixel = true

whether to measure line width in pixels - otherwise in eye space relative to reference_line_width

Definition at line 42 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ percentual_halo_width

float cgv::render::line_render_style::percentual_halo_width = 0.0f

halo width in percent of line width

Definition at line 35 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ reference_line_width

float cgv::render::line_render_style::reference_line_width = 0.001f

reference line width multiplied to line width if measure_line_width_in_pixel is false

Definition at line 44 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().

◆ screen_aligned

bool cgv::render::line_render_style::screen_aligned = true

whether to span line splat in screen aligned coordinate system

Definition at line 37 of file line_renderer.h.

Referenced by cgv::gui::line_render_style_gui_creator::create(), and cgv::render::line_renderer::enable().


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