LuciadCPillar 2023.1.04
luciad::MgrsGridSetting Class Reference

MGRS grid setting. More...

#include <luciad/layers/grids/mgrs/MgrsGrid.h>

Classes

class  Builder
 Builder for a MGRS grid setting. More...
 

Public Member Functions

 MgrsGridSetting (const MgrsGridSetting &other)
 
 MgrsGridSetting (MgrsGridSetting &&other) noexcept
 
 ~MgrsGridSetting ()
 
double getLabelEdgeOffset () const
 Returns the label edge offset. More...
 
std::optional< std::string > getLabelFormat () const
 Returns the label format. More...
 
double getLabelGridOffset () const
 Returns the label grid offset. More...
 
GridLabelOrientation getLabelOrientation () const
 Returns the label orientation. More...
 
GridLabelPosition getLabelPosition () const
 Returns the label position. More...
 
TextStyle getLabelStyle () const
 Returns the label style. More...
 
MgrsLevel getLevel () const
 Returns the MGRS level. More...
 
GridLineLabelPosition getLineLabelPosition () const
 Returns the line label position. More...
 
LineStyle getLineStyle () const
 Returns the line style. More...
 
MapScale getMaxScale () const
 Returns the max scale (most zoomed in) for which this setting applies. More...
 
MapScale getMinScale () const
 Returns the min scale (most zoomed out) for which this setting applies. More...
 
std::optional< MgrsTypegetType () const
 Returns the MGRS type. More...
 
bool operator!= (const MgrsGridSetting &other) const
 
MgrsGridSettingoperator= (const MgrsGridSetting &other) noexcept
 
MgrsGridSettingoperator= (MgrsGridSetting &&other) noexcept
 
bool operator== (const MgrsGridSetting &other) const
 

Static Public Member Functions

static Builder newBuilder ()
 Creates a new builder with the default values. More...
 

Detailed Description

MGRS grid setting.

It defines the style to use for a combination of

  • MGRS level
  • MGRS type (optional)
  • map scale range
Since
2023.1

Constructor & Destructor Documentation

◆ MgrsGridSetting() [1/2]

luciad::MgrsGridSetting::MgrsGridSetting ( const MgrsGridSetting other)

◆ MgrsGridSetting() [2/2]

luciad::MgrsGridSetting::MgrsGridSetting ( MgrsGridSetting &&  other)
noexcept

◆ ~MgrsGridSetting()

luciad::MgrsGridSetting::~MgrsGridSetting ( )

Member Function Documentation

◆ getLabelEdgeOffset()

double luciad::MgrsGridSetting::getLabelEdgeOffset ( ) const

Returns the label edge offset.

Returns
the label edge offset.

◆ getLabelFormat()

std::optional< std::string > luciad::MgrsGridSetting::getLabelFormat ( ) const

Returns the label format.

Returns
the label format.

◆ getLabelGridOffset()

double luciad::MgrsGridSetting::getLabelGridOffset ( ) const

Returns the label grid offset.

Returns
the label grid offset.

◆ getLabelOrientation()

GridLabelOrientation luciad::MgrsGridSetting::getLabelOrientation ( ) const

Returns the label orientation.

Returns
the label orientation.

◆ getLabelPosition()

GridLabelPosition luciad::MgrsGridSetting::getLabelPosition ( ) const

Returns the label position.

Returns
the label position.

◆ getLabelStyle()

TextStyle luciad::MgrsGridSetting::getLabelStyle ( ) const

Returns the label style.

Returns
the label style.

◆ getLevel()

MgrsLevel luciad::MgrsGridSetting::getLevel ( ) const

Returns the MGRS level.

Returns
the MGRS level.

◆ getLineLabelPosition()

GridLineLabelPosition luciad::MgrsGridSetting::getLineLabelPosition ( ) const

Returns the line label position.

Returns
the line label position.

◆ getLineStyle()

LineStyle luciad::MgrsGridSetting::getLineStyle ( ) const

Returns the line style.

Returns
the line style.

◆ getMaxScale()

MapScale luciad::MgrsGridSetting::getMaxScale ( ) const

Returns the max scale (most zoomed in) for which this setting applies.

Returns
the max scale (most zoomed in) for which this setting applies.

◆ getMinScale()

MapScale luciad::MgrsGridSetting::getMinScale ( ) const

Returns the min scale (most zoomed out) for which this setting applies.

Returns
the min scale (most zoomed out) for which this setting applies.

◆ getType()

std::optional< MgrsType > luciad::MgrsGridSetting::getType ( ) const

Returns the MGRS type.

Returns
the MGRS type.

◆ newBuilder()

static Builder luciad::MgrsGridSetting::newBuilder ( )
static

Creates a new builder with the default values.

Returns
the new builder.

◆ operator!=()

bool luciad::MgrsGridSetting::operator!= ( const MgrsGridSetting other) const

◆ operator=() [1/2]

MgrsGridSetting & luciad::MgrsGridSetting::operator= ( const MgrsGridSetting other)
noexcept

◆ operator=() [2/2]

MgrsGridSetting & luciad::MgrsGridSetting::operator= ( MgrsGridSetting &&  other)
noexcept

◆ operator==()

bool luciad::MgrsGridSetting::operator== ( const MgrsGridSetting other) const