ViewportOptions.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/ViewportLayout.h>
#include <NDEVR/ApplicationOptions.h>
#include <NDEVR/TranslatedString.h>
#include <NDEVR/RGBColor.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    struct: ViewportOptions
 
    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
    *-----------------------------------------------------------------------------------------------**/
    struct NDEVR_DESIGN_API ViewportOptions
    {
        enum ViewportBackgroundMode
        {
              e_1_color
            , e_2_color
            , e_4_color
            , e_skybox
        };
        //The frames per second of a viewport. Increasing this will improve smoothness but raise rendering load
        static ApplicationOption<uint04> default_viewport_fps;
        //The default scale to be applied to lines and text in virtual space
        static ApplicationOption<fltp04> pixel_thickness;
        //The default camera background color for virtual views (applies for background mode 1 and 2 colors)
        static ApplicationOption<RGBColor> camera_background;
        //The default speed at which to draw 3D scenes
        static ApplicationOption<fltp08> default_render_engine_fps;
        //The default number of multisample passes used to smooth edges of 3D renders
        static ApplicationOption<uint04> default_multisample;
        //Whether or not to execute rendering operations on a thread other than main thread
        static ApplicationOption<bool> default_multithreaded_render;
        //Whether or not to, by default, show the Heading marks on a virtual viewport (perspective mode)
        static ApplicationOption<bool> default_show_heading_ruler_virtual;
        //Whether or not to, by default, when possible, show the Heading marks on a physical camera view
        static ApplicationOption<bool> default_show_heading_ruler_physical;
        //Whether or not to, by default, show the spacing marks on a virtual viewport (orthographic mode)
        static ApplicationOption<bool> default_show_x_spacing_ruler_virtual;
        //Whether or not to, by default, show the Inclination marks on a virtual viewport (perspective mode)
        static ApplicationOption<bool> default_show_inclination_ruler_virtual;
        //Whether or not to, by default, show the inclanation marks on a physical ccamera view
        static ApplicationOption<bool> default_show_inclination_ruler_physical;
        //Whether or not to, by default, show the spacing marks on a virtual viewport (orthographic mode)
        static ApplicationOption<bool> default_show_y_spacing_ruler_virtual;
        //Resets all Viewport Options to defaults
        static ApplicationOption<fltp04> scale_to_camera_reference_distance;
 
        static ApplicationOption<ViewportLayoutTheme> viewport_layout_theme;
 
        static ApplicationOption<bool> use_vulkan_fallback;
        static ApplicationOption<bool> use_vulkan_debug_layers;
 
        static ApplicationOption<Angle<fltp08>> default_perspective_view_height;
        static ApplicationOption<Angle<fltp08>> default_perspective_view_width;
        static ApplicationOption<fltp08> default_orthographic_view_height;
        static ApplicationOption<fltp08> default_orthographic_view_width;
        static void ResetOptionsToDefaults();
        //The category in user settings for all of the above options
        static TranslatedString options_label;
    };
    template class NDEVR_DESIGN_API StringStream<ViewportLayoutTheme>;
}