NDEVR
API Documentation
StationOptions

Stores ApplicationOptions related to user preferences for Stations. More...

Collaboration diagram for StationOptions:
[legend]

Static Public Member Functions

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

Static Public Attributes

static ApplicationOption< bool > allow_relative_positions
 Whether relative positioning is enabled for stations.
static ApplicationOption< bool > allow_station_orientation
 Whether the user can set the orientation of a station.
static ApplicationOption< bool > allow_station_scene_reference
 Whether a station can reference a scene for its coordinate frame.
static ApplicationOption< Vertex< 3, fltp08 > > custom_prism_offset
 The user-defined 3D prism offset vector applied when enable_custom_prism_offset is true.
static ApplicationOption< bool > enable_custom_prism_offset
 Whether to allow the user to specify a custom prism offset.
static ApplicationOption< bool > enable_planned_hole_control
 Whether planned hole control UI is shown for the station.
static TranslatedString options_label
 The display label for the station options category.
static ApplicationOption< TranslatedStringstation_auto_name_format
 The format string used for automatically generating station names (e.g., "[station_label]-[station_number]").
static ApplicationOption< bool > station_circular
 Whether the station is displayed with a circular geometry.
static ApplicationOption< TranslatedStringstation_label
 The user-facing term for a station (e.g., "Station", "Collar").
static ApplicationOption< bool > station_line_of_sight
 Whether line-of-sight checking is used for the station.
static ApplicationOption< fltp08station_max_radius
 The maximum allowed radius for the station (default 5.0).
static ApplicationOption< fltp08station_min_radius
 The minimum allowed radius for the station (default 1.0).
static ApplicationOption< Vertex< 3, fltp08 > > station_offset
 The default 3D positional offset applied to stations.
static ApplicationOption< bool > station_show_axes
 Whether coordinate axes are displayed at the station.
static ApplicationOption< bool > station_show_axes_text
 Whether axis labels are rendered as text at the station.
static ApplicationOption< bool > station_show_distance_lines
 Whether distance lines are drawn from the station.
static ApplicationOption< bool > station_show_distance_text
 Whether distance values are rendered as text labels.
static ApplicationOption< bool > station_show_title
 Whether the station title is displayed.

Detailed Description

Stores ApplicationOptions related to user preferences for Stations.


Provides static application-level settings that control station display, labeling, positioning, and measurement behavior. All options are persisted through the ApplicationOptions system and can be restored to defaults via ResetOptionsToDefaults().

Definition at line 16 of file StationOptions.h.

Member Function Documentation

◆ ResetOptionsToDefaults()

void StationOptions::ResetOptionsToDefaults ( )
static

Resets all station options to their default values.

Restores every option under the station options category to its compiled default, resets the station font to the application default, and saves font settings.


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