Inheritance diagram for Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder:

Public Member Functions
	Builder (Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder other)

Luciad.Layers.Grids.Mgrs.MgrsGrid	Build ()
	Returns the MGRS grid. More...

void	Dispose ()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	LabelEdgeOffset (double labelEdgeOffset)
	This specifies the offset of the label, away from the edges of the view, in device independent pixels. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	LabelGridOffset (double labelGridOffset)
	This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	LabelOrientation (Luciad.Layers.Grids.Labels.GridLabelOrientation labelOrientation)
	This specifies the label orientation with respect to the line. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	LabelPosition (Luciad.Layers.Grids.Labels.GridLabelPosition labelPosition)
	This specifies the label position with respect to the view. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	LineLabelPosition (Luciad.Layers.Grids.Labels.GridLineLabelPosition lineLabelPosition)
	This specifies the label position (with respect to the line) to use for the line labels of the current MGRS type/level/interval combination. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	PrimaryLabelStyle (Luciad.Text.TextStyle labelStyle)
	Indicates the primary label style to use for the MGRS grid. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	PrimaryLineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Indicates the primary line style to use for the MGRS grid. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	ScaleMultiplier (double scaleMultiplier)
	Indicates the scale multiplier to use for the MGRS grid scale ranges. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	SecondaryLabelStyle (Luciad.Text.TextStyle labelStyle)
	Indicates the secondary label style to use for the MGRS grid. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	SecondaryLineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Indicates the secondary line style to use for the MGRS grid. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	TertiaryLabelStyle (Luciad.Text.TextStyle labelStyle)
	Indicates the tertiary label style to use for the MGRS grid. More...

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder	TertiaryLineStyle (Luciad.Layers.Styles.LineStyle lineStyle)
	Indicates the tertiary line style to use for the MGRS grid. More...

Detailed Description

Builder for a MGRS grid.

Creates a MGRS grid with predefined scale ranges and default (customizable) styling. The default styling is expressed in terms of 3 styles: primary, secondary and tertiary. At a given scale range, the most applicable MGRS grid level is styled with the primary style. Higher MGRS levels are styled with secondary and tertiary styles. For example, when zoomed in really far, 1m MGRS squares are styled with the primary style, 10m squares are styled with the secondary style and 100m squares are styled with the tertiary style. 2023.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder.

Constructor & Destructor Documentation

◆ Builder()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.Builder ( Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder other )

inline

Member Function Documentation

◆ Build()

Luciad.Layers.Grids.Mgrs.MgrsGrid Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.Build ( )

inline

Returns the MGRS grid.

luciad::MgrsGrid for information on the constraints for a MGRS grid.

the MGRS grid.

luciad::LogicException

when the settings are invalid.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::build.

◆ Dispose()

void Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.Dispose ( )

inline

◆ LabelEdgeOffset()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.LabelEdgeOffset ( double labelEdgeOffset )

inline

This specifies the offset of the label, away from the edges of the view, in device independent pixels.

This is applied to all style settings in the grid. This is optional. Defaults to 6.

labelEdgeOffset

the edge offset value. Must be >= 0.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

luciad::MgrsGridSetting::Builder::labelEdgeOffset

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::labelEdgeOffset.

◆ LabelGridOffset()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.LabelGridOffset ( double labelGridOffset )

inline

This specifies the offset of the label, in device independent pixels, away from the grid line to which it is attached.

This is applied to all style settings in the grid. This is optional. Defaults to 3.

labelGridOffset

the grid offset value. Must be >= 0.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

luciad::MgrsGridSetting::Builder::labelGridOffset

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::labelGridOffset.

◆ LabelOrientation()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.LabelOrientation ( Luciad.Layers.Grids.Labels.GridLabelOrientation labelOrientation )

inline

This specifies the label orientation with respect to the line.

This is applied to all style settings in the grid. This is optional. Defaults to AlongLine.

labelOrientation

the label orientation.

this builder.

luciad::MgrsGridSetting::Builder::labelOrientation

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::labelOrientation.

◆ LabelPosition()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.LabelPosition ( Luciad.Layers.Grids.Labels.GridLabelPosition labelPosition )

inline

This specifies the label position with respect to the view.

They can for example be placed at the left or at the right edge of the view. For example, when a label is placed at the east or south side of a line, it is placed at the left or lower edge of the view when using a rectangular projection like Mercator. This is applied to all style settings in the grid. This is optional. Defaults to WestAndSouth.

labelPosition

the label position.

this builder.

luciad::MgrsGridSetting::Builder::labelPosition

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::labelPosition.

◆ LineLabelPosition()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.LineLabelPosition ( Luciad.Layers.Grids.Labels.GridLineLabelPosition lineLabelPosition )

inline

This specifies the label position (with respect to the line) to use for the line labels of the current MGRS type/level/interval combination.

They can for example be placed at the left or at the right of the line. This is applied to all style settings in the grid. This is optional. Defaults to AboveOrLeft.

lineLabelPosition

the line label position.

this builder.

luciad::MgrsGridSetting::Builder::lineLabelPosition

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::lineLabelPosition.

◆ PrimaryLabelStyle()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.PrimaryLabelStyle ( Luciad.Text.TextStyle labelStyle )

inline

Indicates the primary label style to use for the MGRS grid.

labelStyle

the label style.

this builder.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::primaryLabelStyle.

◆ PrimaryLineStyle()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.PrimaryLineStyle ( Luciad.Layers.Styles.LineStyle lineStyle )

inline

Indicates the primary line style to use for the MGRS grid.

lineStyle

the line style.

this builder.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::primaryLineStyle.

◆ ScaleMultiplier()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.ScaleMultiplier ( double scaleMultiplier )

inline

Indicates the scale multiplier to use for the MGRS grid scale ranges.

The value must be within the range [0.1, 10.0]. A value larger than 1 makes the grid lines appear later when zooming in. This results in a coarser grid. A value below 1 makes the grid lines appear sooner when zooming in. This results in a finer grid.

scaleMultiplier

the scale multiplier.

this builder.

luciad::InvalidArgumentException

when an invalid value is passed.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::scaleMultiplier.

◆ SecondaryLabelStyle()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.SecondaryLabelStyle ( Luciad.Text.TextStyle labelStyle )

inline

Indicates the secondary label style to use for the MGRS grid.

labelStyle

the label style.

this builder.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::secondaryLabelStyle.

◆ SecondaryLineStyle()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.SecondaryLineStyle ( Luciad.Layers.Styles.LineStyle lineStyle )

inline

Indicates the secondary line style to use for the MGRS grid.

lineStyle

the line style.

this builder.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::secondaryLineStyle.

◆ TertiaryLabelStyle()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.TertiaryLabelStyle ( Luciad.Text.TextStyle labelStyle )

inline

Indicates the tertiary label style to use for the MGRS grid.

labelStyle

the label style.

this builder.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::tertiaryLabelStyle.

◆ TertiaryLineStyle()

Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder Luciad.Layers.Grids.Mgrs.MgrsGrid.Builder.TertiaryLineStyle ( Luciad.Layers.Styles.LineStyle lineStyle )

inline

Indicates the tertiary line style to use for the MGRS grid.

lineStyle

the line style.

this builder.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsGrid::Builder::tertiaryLineStyle.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ Build()

◆ Dispose()

◆ LabelEdgeOffset()

◆ LabelGridOffset()

◆ LabelOrientation()

◆ LabelPosition()

◆ LineLabelPosition()

◆ PrimaryLabelStyle()

◆ PrimaryLineStyle()

◆ ScaleMultiplier()

◆ SecondaryLabelStyle()

◆ SecondaryLineStyle()

◆ TertiaryLabelStyle()

◆ TertiaryLineStyle()