API/StationOptions_8h_source.html

#pragma once

#include "DLLInfo.h"

#include <NDEVR/ApplicationOptions.h>

#include <NDEVR/TranslatedString.h>

#include <NDEVR/Vertex.h>

namespace NDEVR

{


    struct NDEVR_DESIGN_API StationOptions

    {

        static TranslatedString options_label;

        static ApplicationOption<TranslatedString> station_auto_name_format;

        static ApplicationOption<TranslatedString> station_label;

        static ApplicationOption<bool> enable_custom_prism_offset;

        static ApplicationOption<bool> station_circular;

        static ApplicationOption<bool> enable_planned_hole_control;

        static ApplicationOption<bool> station_show_distance_lines;

        static ApplicationOption<bool> station_show_axes;

        static ApplicationOption<bool> station_show_distance_text;

        static ApplicationOption<bool> station_show_axes_text;

        static ApplicationOption<bool> station_show_title;

        static ApplicationOption<bool> allow_station_orientation;

        static ApplicationOption<bool> allow_relative_positions;

        static ApplicationOption<bool> allow_station_scene_reference;

        static ApplicationOption<bool> station_line_of_sight;

        static ApplicationOption<Vertex<3, fltp08>> custom_prism_offset;

        static ApplicationOption<Vertex<3, fltp08>> station_offset;

        static ApplicationOption<fltp08> station_min_radius;

        static ApplicationOption<fltp08> station_max_radius;


        static void ResetOptionsToDefaults();

    };


}

ApplicationOption
The default object to store data of any type that should persist through sessions of the application.
Definition ApplicationOptions.h:171

TranslatedString
Any text displayed to the user should be defined as a TranslatedString which allows the program to lo...
Definition TranslatedString.h:16

NDEVR
The primary namespace for the NDEVR SDK.
Definition ArialTileFetcherModule.h:35

StationOptions
Stores ApplicationOptions related to user preferences for Stations.
Definition StationOptions.h:17

StationOptions::enable_custom_prism_offset
static ApplicationOption< bool > enable_custom_prism_offset
Whether to allow the user to specify a custom prism offset.
Definition StationOptions.h:21

StationOptions::custom_prism_offset
static ApplicationOption< Vertex< 3, fltp08 > > custom_prism_offset
The user-defined 3D prism offset vector applied when enable_custom_prism_offset is true.
Definition StationOptions.h:33

StationOptions::station_auto_name_format
static ApplicationOption< TranslatedString > station_auto_name_format
The format string used for automatically generating station names (e.g., "[station_label]-[station_nu...
Definition StationOptions.h:19

StationOptions::station_show_distance_text
static ApplicationOption< bool > station_show_distance_text
Whether distance values are rendered as text labels.
Definition StationOptions.h:26

StationOptions::ResetOptionsToDefaults
static void ResetOptionsToDefaults()
Resets all station options to their default values.

StationOptions::allow_station_scene_reference
static ApplicationOption< bool > allow_station_scene_reference
Whether a station can reference a scene for its coordinate frame.
Definition StationOptions.h:31

StationOptions::station_line_of_sight
static ApplicationOption< bool > station_line_of_sight
Whether line-of-sight checking is used for the station.
Definition StationOptions.h:32

StationOptions::station_show_distance_lines
static ApplicationOption< bool > station_show_distance_lines
Whether distance lines are drawn from the station.
Definition StationOptions.h:24

StationOptions::station_circular
static ApplicationOption< bool > station_circular
Whether the station is displayed with a circular geometry.
Definition StationOptions.h:22

StationOptions::station_label
static ApplicationOption< TranslatedString > station_label
The user-facing term for a station (e.g., "Station", "Collar").
Definition StationOptions.h:20

StationOptions::station_show_title
static ApplicationOption< bool > station_show_title
Whether the station title is displayed.
Definition StationOptions.h:28

StationOptions::station_show_axes
static ApplicationOption< bool > station_show_axes
Whether coordinate axes are displayed at the station.
Definition StationOptions.h:25

StationOptions::options_label
static TranslatedString options_label
The display label for the station options category.
Definition StationOptions.h:18

StationOptions::allow_relative_positions
static ApplicationOption< bool > allow_relative_positions
Whether relative positioning is enabled for stations.
Definition StationOptions.h:30

StationOptions::station_max_radius
static ApplicationOption< fltp08 > station_max_radius
The maximum allowed radius for the station (default 5.0).
Definition StationOptions.h:36

StationOptions::enable_planned_hole_control
static ApplicationOption< bool > enable_planned_hole_control
Whether planned hole control UI is shown for the station.
Definition StationOptions.h:23

StationOptions::allow_station_orientation
static ApplicationOption< bool > allow_station_orientation
Whether the user can set the orientation of a station.
Definition StationOptions.h:29

StationOptions::station_offset
static ApplicationOption< Vertex< 3, fltp08 > > station_offset
The default 3D positional offset applied to stations.
Definition StationOptions.h:34

StationOptions::station_min_radius
static ApplicationOption< fltp08 > station_min_radius
The minimum allowed radius for the station (default 1.0).
Definition StationOptions.h:35

StationOptions::station_show_axes_text
static ApplicationOption< bool > station_show_axes_text
Whether axis labels are rendered as text at the station.
Definition StationOptions.h:27