Builder for the luciad::MilitarySymbolStyle class. More...

Inheritance diagram for Luciad.Symbology.Military.MilitarySymbolStyle.Builder:

Public Member Functions
	Builder (Luciad.Symbology.Military.MilitarySymbolStyle.Builder other)

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	AffiliationColor (Luciad.Symbology.Military.MilitarySymbol.Affiliation affiliation, System.Drawing.Color affiliationColor)
	Sets the color for the given affiliation. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	AffiliationColorEnabled (bool affiliationColorEnabled)
	Sets the affiliation color mode. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	AlternateFillColor (System.Drawing.Color alternateFillColor)
	Sets the alternate color to fill the part of the frame that is not covered by the fill percentage. More...

Luciad.Symbology.Military.MilitarySymbolStyle	Build ()
	Creates a new MilitarySymbolStyle with the properties set on this builder. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	Color (System.Drawing.Color unaffiliatedColor)
	Sets the color to be used if affiliation colors have been disabled (see affiliationColorEnabled) or if the symbol has no affiliation by default. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	CornerSmoothness (double smoothness)
	Sets the smoothness (or rounding) factor for polygon corners. More...

void	Dispose ()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	FillEnabled (bool fillEnabled)
	Sets whether an icon symbol should be painted filled. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	FillPercentage (double fillPercentage)
	Sets the percentage ([0.0, 1.0]) of an icon symbol's frame that is painted with the regular fill color, as determined by its affiliation (see affiliationColor). More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	FrameEnabled (bool frameEnabled)
	Sets whether the frame of an icon symbol should be painted. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	IconEnabled (bool iconEnabled)
	Sets whether the internal icon in the frame of an icon symbol should be painted. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	IconSize (uint size)
	Sets the size of icon symbols in pixels. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	ModifiersEnabled (bool modifiersEnabled)
	Sets whether modifiers should be enabled. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	OverrideColor (System.Drawing.Color color)
	Sets the color to be used for the icon symbol. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	StrokeScaleFactor (double strokeScaleFactor)
	Sets the factor by which line widths should be scaled. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	SurroundingRectangleColor (System.Drawing.Color color)
	Sets the color of the rectangle that is painted around icon symbols. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	SurroundingRectangleEnabled (bool enabled)
	Sets whether icon symbols should be painted with a surrounding rectangle. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	SurroundingRectangleWidth (uint width)
	Sets the line width in pixels of the rectangle that is painted around icon symbols. More...

Luciad.Symbology.Military.MilitarySymbolStyle.Builder	TextStyle (Luciad.Text.TextStyle textStyle)
	Sets the new text style to be used for all texts part of the symbol. More...

Detailed Description

Builder for the luciad::MilitarySymbolStyle class.

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

Constructor & Destructor Documentation

◆ Builder()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder.Builder ( Luciad.Symbology.Military.MilitarySymbolStyle.Builder other )

inline

Member Function Documentation

◆ AffiliationColor()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.AffiliationColor	(	Luciad.Symbology.Military.MilitarySymbol.Affiliation	affiliation,
		System.Drawing.Color	affiliationColor
	)

inline

Sets the color for the given affiliation.

These colors are used as fill color for framed icon symbols. For unframed icon symbols and line symbols, affiliation colors are only used when the affiliation color mode has been enabled (see affiliationColorEnabled).

affiliation

The affiliation for which a color is set.

affiliationColor

The color to be used for the given affiliation.

this builder.

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

◆ AffiliationColorEnabled()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.AffiliationColorEnabled ( bool affiliationColorEnabled )

inline

Sets the affiliation color mode.

When this mode is enabled, the color for unframed icon symbols, line symbols and off-set lines of icon symbols are automatically be adapted to the affiliation of a symbol. The default value is false.

affiliationColorEnabled

The affiliation color mode.

this builder.

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

◆ AlternateFillColor()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.AlternateFillColor ( System.Drawing.Color alternateFillColor )

inline

Sets the alternate color to fill the part of the frame that is not covered by the fill percentage.

The default value is transparent (i.e. no fill).

alternateFillColor

the color to fill the part of the frame that is not covered by the fill percentage.

this builder.

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

◆ Build()

Luciad.Symbology.Military.MilitarySymbolStyle Luciad.Symbology.Military.MilitarySymbolStyle.Builder.Build ( )

inline

Creates a new MilitarySymbolStyle with the properties set on this builder.

a new MilitarySymbolStyle with the properties set on this builder.

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

◆ Color()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.Color ( System.Drawing.Color unaffiliatedColor )

inline

Sets the color to be used if affiliation colors have been disabled (see affiliationColorEnabled) or if the symbol has no affiliation by default.

The default value is black.

unaffiliatedColor

The color.

this builder.

2020.1

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

◆ CornerSmoothness()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.CornerSmoothness ( double smoothness )

inline

Sets the smoothness (or rounding) factor for polygon corners.

This factor must be a value inside the interval [0.0, 1.0]. By default, the smoothness is set to 0.5.

smoothness

the smoothness (or rounding) factor for polygon corners.

this builder.

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

◆ Dispose()

void Luciad.Symbology.Military.MilitarySymbolStyle.Builder.Dispose ( )

inline

◆ FillEnabled()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.FillEnabled ( bool fillEnabled )

inline

Sets whether an icon symbol should be painted filled.

The default value is true.

fillEnabled

whether an icon symbol should be painted filled.

this builder.

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

◆ FillPercentage()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.FillPercentage ( double fillPercentage )

inline

Sets the percentage ([0.0, 1.0]) of an icon symbol's frame that is painted with the regular fill color, as determined by its affiliation (see affiliationColor).

The filled part begins at the bottom of the icon frame, up to the vertical position that corresponds with the given fill percentage. In other words, a fill percentage of 0.5 results in an icon symbol of which only the bottom half is filled with the regular fill color. The remaining (top) part of the icon is filled with the alternate fill color. The default value is 1.0f.

fillPercentage

the fill percentage to fill the frame of icon symbols.

this builder.

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

◆ FrameEnabled()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.FrameEnabled ( bool frameEnabled )

inline

Sets whether the frame of an icon symbol should be painted.

The default value is true.

frameEnabled

whether the frame of an icon symbol should be painted.

this builder.

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

◆ IconEnabled()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.IconEnabled ( bool iconEnabled )

inline

Sets whether the internal icon in the frame of an icon symbol should be painted.

The default value is true.

iconEnabled

whether the internal icon in the frame of an icon symbol should be painted.

this builder.

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

◆ IconSize()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.IconSize ( uint size )

inline

Sets the size of icon symbols in pixels.

This value must be > 0. The default value is 64.

size

the size of icon symbols in pixels.

this builder.

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

◆ ModifiersEnabled()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.ModifiersEnabled ( bool modifiersEnabled )

inline

Sets whether modifiers should be enabled.

The default value is true.

modifiersEnabled

whether modifiers should be enabled.

this builder.

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

◆ OverrideColor()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.OverrideColor ( System.Drawing.Color color )

inline

Sets the color to be used for the icon symbol.

This overrides the affiliation and/or pattern colors in icons and tactical shapes. If this method is not invoked, there's no override color.

color

The color to be used for the icon symbol.

this builder.

2022.0

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

◆ StrokeScaleFactor()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.StrokeScaleFactor ( double strokeScaleFactor )

inline

Sets the factor by which line widths should be scaled.

This setting can be used to increase or decrease the width of stroked lines in icons and tactical graphics. It also affects decoration sizes in tactical graphics. The default value is 1.

strokeScaleFactor

the factor by which line widths should be scaled.

this builder.

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

◆ SurroundingRectangleColor()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.SurroundingRectangleColor ( System.Drawing.Color color )

inline

Sets the color of the rectangle that is painted around icon symbols.

color

the color of the rectangle that is painted around icon symbols.

this builder.

surroundingRectangleEnabled

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

◆ SurroundingRectangleEnabled()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.SurroundingRectangleEnabled ( bool enabled )

inline

Sets whether icon symbols should be painted with a surrounding rectangle.

The default value is false.

enabled

whether icon symbols should be painted with a surrounding rectangle.

this builder.

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

◆ SurroundingRectangleWidth()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.SurroundingRectangleWidth ( uint width )

inline

Sets the line width in pixels of the rectangle that is painted around icon symbols.

This value must be larger than 0. The default value is 1. A pixel is defined as 1/96th of 1 inch (https://www.w3.org/TR/css-values-4/#absolute-lengths).

width

the line width in pixels of the rectangle that is painted around icon symbols.

this builder.

surroundingRectangleEnabled

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

◆ TextStyle()

Luciad.Symbology.Military.MilitarySymbolStyle.Builder Luciad.Symbology.Military.MilitarySymbolStyle.Builder.TextStyle ( Luciad.Text.TextStyle textStyle )

inline

Sets the new text style to be used for all texts part of the symbol.

Ideally, the font size for the text style should be less than 1/5th of the icon size. By default, the icon size is 64 and the font size is 12. You can use luciad::MilitarySymbolStyle::getDefaultTextStyle to get a correctly sized TextStyle.

textStyle

new text style to be used for all texts part of the symbol.

this builder.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ AffiliationColor()

◆ AffiliationColorEnabled()

◆ AlternateFillColor()

◆ Build()

◆ Color()

◆ CornerSmoothness()

◆ Dispose()

◆ FillEnabled()

◆ FillPercentage()

◆ FrameEnabled()

◆ IconEnabled()

◆ IconSize()

◆ ModifiersEnabled()

◆ OverrideColor()

◆ StrokeScaleFactor()

◆ SurroundingRectangleColor()

◆ SurroundingRectangleEnabled()

◆ SurroundingRectangleWidth()

◆ TextStyle()