NDEVR
API Documentation
CoordinateBoundsSelectorabstract

A dedicated dialog for allowing the user to select bounds for a northing and easting. More...

Inheritance diagram for CoordinateBoundsSelector:
[legend]
Collaboration diagram for CoordinateBoundsSelector:
[legend]

Public Member Functions

void canceledSignal ()
 Emitted when the user cancels the bounds selection.
virtual Bounds< 2, fltp08 > currentBounds () const =0
 Returns the current bounds as WGS84 decimal degree values.
virtual Bounds< 2, Angle< fltp08 > > currentBoundsAngle () const =0
 Returns the current bounds as WGS84 angle values.
void finishedSignal ()
 Emitted when the user finishes selecting bounds.
virtual void setCurrentBounds (const Bounds< 2, Angle< fltp08 > > &wgs84_bounds)=0
 Sets the current bounds in WGS84 coordinates as angles.
virtual void setCurrentBounds (const Bounds< 2, fltp08 > &wgs84_bounds)=0
 Sets the current bounds in WGS84 coordinates as decimal degrees.

Static Public Member Functions

static bool CanCreateCoordinateSelector ()
 Returns whether a coordinate selector creator has been registered.
static CoordinateBoundsSelector * CreateCoordinateSelector (QWidget *parent=nullptr)
 Creates a new CoordinateBoundsSelector using the registered creator.
static void RegisterCreator (std::function< CoordinateBoundsSelector *(QWidget *parent)> creator)
 Registers a factory function for creating CoordinateBoundsSelector instances.

Static Protected Attributes

static std::function< CoordinateBoundsSelector *(QWidget *parent)> s_create_coordinate_selector
 Factory function for creating selector instances.

Detailed Description

A dedicated dialog for allowing the user to select bounds for a northing and easting.

Allows registration of a dedicated dialog for selecting coordinates.

Definition at line 14 of file CoordinateBoundsSelector.h.

Member Function Documentation

◆ CanCreateCoordinateSelector()

bool CoordinateBoundsSelector::CanCreateCoordinateSelector ( )
static

Returns whether a coordinate selector creator has been registered.

Returns
True if a creator is available.

◆ CreateCoordinateSelector()

CoordinateBoundsSelector * CoordinateBoundsSelector::CreateCoordinateSelector ( QWidget * parent = nullptr)
static

Creates a new CoordinateBoundsSelector using the registered creator.

Parameters
[in]parentThe optional parent widget.
Returns
A new CoordinateBoundsSelector instance, or nullptr if no creator is registered.

◆ currentBounds()

virtual Bounds< 2, fltp08 > CoordinateBoundsSelector::currentBounds ( ) const
pure virtual

Returns the current bounds as WGS84 decimal degree values.

Returns
The selected bounds in decimal degrees.

Implemented in CoordinateSelector.

◆ currentBoundsAngle()

virtual Bounds< 2, Angle< fltp08 > > CoordinateBoundsSelector::currentBoundsAngle ( ) const
pure virtual

Returns the current bounds as WGS84 angle values.

Returns
The selected bounds as angles.

Implemented in CoordinateSelector.

◆ RegisterCreator()

void CoordinateBoundsSelector::RegisterCreator ( std::function< CoordinateBoundsSelector *(QWidget *parent)> creator)
static

Registers a factory function for creating CoordinateBoundsSelector instances.

Parameters
[in]creatorThe factory function that creates a selector given a parent widget.

◆ setCurrentBounds() [1/2]

virtual void CoordinateBoundsSelector::setCurrentBounds ( const Bounds< 2, Angle< fltp08 > > & wgs84_bounds)
pure virtual

Sets the current bounds in WGS84 coordinates as angles.

Parameters
[in]wgs84_boundsThe bounds in WGS84 angle coordinates.

Implemented in CoordinateSelector.

◆ setCurrentBounds() [2/2]

virtual void CoordinateBoundsSelector::setCurrentBounds ( const Bounds< 2, fltp08 > & wgs84_bounds)
pure virtual

Sets the current bounds in WGS84 coordinates as decimal degrees.

Parameters
[in]wgs84_boundsThe bounds in WGS84 decimal degree coordinates.

Implemented in CoordinateSelector.

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