API Documentation
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
ViewportOptions Struct Reference

Stores the options, added to the user settings, that control Viewport and camera options in the application. All options retained across application restart. More...

#include <ViewportOptions.h>

Collaboration diagram for ViewportOptions:
[legend]

Public Types

enum  ViewportBackgroundMode { e_1_color , e_2_color , e_4_color , e_skybox }
 

Static Public Member Functions

static void ResetOptionsToDefaults ()
 

Static Public Attributes

static ApplicationOption< RGBColor > camera_background
 
static ApplicationOption< uint04 > default_multisample
 
static ApplicationOption< bool > default_multithreaded_render
 
static ApplicationOption< fltp08 > default_orthographic_view_height
 
static ApplicationOption< fltp08 > default_orthographic_view_width
 
static ApplicationOption< Angle< fltp08 > > default_perspective_view_height
 
static ApplicationOption< Angle< fltp08 > > default_perspective_view_width
 
static ApplicationOption< fltp08 > default_render_engine_fps
 
static ApplicationOption< bool > default_show_heading_ruler_physical
 
static ApplicationOption< bool > default_show_heading_ruler_virtual
 
static ApplicationOption< bool > default_show_inclination_ruler_physical
 
static ApplicationOption< bool > default_show_inclination_ruler_virtual
 
static ApplicationOption< bool > default_show_x_spacing_ruler_virtual
 
static ApplicationOption< bool > default_show_y_spacing_ruler_virtual
 
static ApplicationOption< uint04 > default_viewport_fps
 
static TranslatedString options_label
 
static ApplicationOption< fltp04 > pixel_thickness
 
static ApplicationOption< fltp04 > scale_to_camera_reference_distance
 
static ApplicationOption< bool > use_vulkan_debug_layers
 
static ApplicationOption< bool > use_vulkan_fallback
 
static ApplicationOption< ViewportLayoutTheme > viewport_layout_theme
 

Detailed Description

Stores the options, added to the user settings, that control Viewport and camera options in the application. All options retained across application restart.

Author: Tyler Parke

Date: 2023-01-16

Member Enumeration Documentation

◆ ViewportBackgroundMode

enum ViewportBackgroundMode
Enumerator
e_1_color 
e_2_color 
e_4_color 
e_skybox 

Member Function Documentation

◆ ResetOptionsToDefaults()

static void ResetOptionsToDefaults ( )
static

Member Data Documentation

◆ camera_background

ApplicationOption<RGBColor> camera_background
static

◆ default_multisample

ApplicationOption<uint04> default_multisample
static

◆ default_multithreaded_render

ApplicationOption<bool> default_multithreaded_render
static

◆ default_orthographic_view_height

ApplicationOption<fltp08> default_orthographic_view_height
static

◆ default_orthographic_view_width

ApplicationOption<fltp08> default_orthographic_view_width
static

◆ default_perspective_view_height

ApplicationOption<Angle<fltp08> > default_perspective_view_height
static

◆ default_perspective_view_width

ApplicationOption<Angle<fltp08> > default_perspective_view_width
static

◆ default_render_engine_fps

ApplicationOption<fltp08> default_render_engine_fps
static

◆ default_show_heading_ruler_physical

ApplicationOption<bool> default_show_heading_ruler_physical
static

◆ default_show_heading_ruler_virtual

ApplicationOption<bool> default_show_heading_ruler_virtual
static

◆ default_show_inclination_ruler_physical

ApplicationOption<bool> default_show_inclination_ruler_physical
static

◆ default_show_inclination_ruler_virtual

ApplicationOption<bool> default_show_inclination_ruler_virtual
static

◆ default_show_x_spacing_ruler_virtual

ApplicationOption<bool> default_show_x_spacing_ruler_virtual
static

◆ default_show_y_spacing_ruler_virtual

ApplicationOption<bool> default_show_y_spacing_ruler_virtual
static

◆ default_viewport_fps

ApplicationOption<uint04> default_viewport_fps
static

◆ options_label

TranslatedString options_label
static

◆ pixel_thickness

ApplicationOption<fltp04> pixel_thickness
static

◆ scale_to_camera_reference_distance

ApplicationOption<fltp04> scale_to_camera_reference_distance
static

◆ use_vulkan_debug_layers

ApplicationOption<bool> use_vulkan_debug_layers
static

◆ use_vulkan_fallback

ApplicationOption<bool> use_vulkan_fallback
static

◆ viewport_layout_theme

ApplicationOption<ViewportLayoutTheme> viewport_layout_theme
static
The documentation for this struct was generated from the following file: