NDEVR
API Documentation

Stores ApplicationOptions related to coordinates. More...

Collaboration diagram for CoordinateOptions:
[legend]

Static Public Member Functions

static Angle< fltp08ActiveDeclinationAngle ()
 Returns the active magnetic declination angle.
static void ResetOptionsToDefaults ()
 Resets all coordinate options to their default values.
static bool UsesProjection ()
 Checks whether coordinate projection is currently in use.

Static Public Attributes

static ApplicationOption< bool > allow_gnss_readings
 Whether GNSS (GPS) readings are permitted.
static Resource< UUIDcurrent_projection
 The currently active coordinate projection identifier.
static ApplicationOption< Angle< fltp08 > > default_magnetic_declination
 The default magnetic declination angle offset used on reset.
static ApplicationOption< UUIDdefault_projection
 The default coordinate projection identifier.
static ApplicationOption< Angle< fltp08 > > magnetic_declination
 The current magnetic declination angle offset.
static ApplicationOption< Stringnavigation_marker_model
 The file path or name of the 3D model used for the navigation marker.
static TranslatedString options_label
 The display label for the coordinate options category.
static ApplicationOption< bool > use_projection
 Whether coordinate projection is enabled.
static ApplicationOption< bool > warn_if_gnss_out_of_projection_bounds
 Whether to warn the user when GNSS readings fall outside the active projection bounds.

Detailed Description

Stores ApplicationOptions related to coordinates.


Definition at line 11 of file CoordinateOptions.h.

Member Function Documentation

◆ ActiveDeclinationAngle()

Angle< fltp08 > CoordinateOptions::ActiveDeclinationAngle ( )
static

Returns the active magnetic declination angle.

Returns
The current declination angle to apply to compass headings.

◆ UsesProjection()

bool CoordinateOptions::UsesProjection ( )
static

Checks whether coordinate projection is currently in use.

Returns
True if projection is enabled and a valid projection is set.

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