Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Class Reference

Creates a pattern with a rectangle shape. More...

Inheritance diagram for Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder:

Public Member Functions
Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern	Build ()
	Build the rectangle pattern as configured. More...
void	Dispose ()
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	FillColor (System.Drawing.Color color)
	Sets the fill color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	FixedLength (double fixedLength)
	Set the length of the pattern in pixels. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	LineColor (System.Drawing.Color color)
	Sets the line color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	LineWidth (double lineWidth)
	Sets the line width. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	MaxHeight (double maxHeight)
	Sets the maximum height of the rectangle, in pixels, relative to the base line. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	MinHeight (double minHeight)
	Sets the minimum height of the rectangle, in pixels, relative to the base line. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder	RelativeLength (double relativeLength)
	Set the length of the pattern relative to the length of the entire line, as a value between 0 and 1. More...

Detailed Description

Creates a pattern with a rectangle shape.

ComplexStrokePatternFactory::rectangleBuilder()

2023.1

Warning

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

Member Function Documentation

Build()

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.Build ( )

inline

Build the rectangle pattern as configured.

the ComplexStrokePattern.

Warning

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

Dispose()

void Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.Dispose ( )

inline

FillColor()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.FillColor ( System.Drawing.Color  color )

inline

Sets the fill color.

color

the fill color, by default there is no fill.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::fillColor.

FixedLength()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.FixedLength ( double  fixedLength )

inline

Set the length of the pattern in pixels.

The length cannot be both fixed and relative, if both methods are used, only the last one affects the result. If no length is set, a 10 pixel fixed length will be used as default.

fixedLength

the length in pixels.

this builder.

luciad::InvalidArgumentException

fixedLength must be >=0.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::fixedLength.

LineColor()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.LineColor ( System.Drawing.Color  color )

inline

Sets the line color.

color

the line's color, defaults to black.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::lineColor.

LineWidth()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.LineWidth ( double  lineWidth )

inline

Sets the line width.

lineWidth

the line's width, defaults to 1.

this builder.

luciad::InvalidArgumentException

lineWidth must be >0.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::lineWidth.

MaxHeight()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.MaxHeight ( double  maxHeight )

inline

Sets the maximum height of the rectangle, in pixels, relative to the base line.

This is typically a positive value.

maxHeight

the maximum height, defaults to 5.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::maxHeight.

MinHeight()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.MinHeight ( double  minHeight )

inline

Sets the minimum height of the rectangle, in pixels, relative to the base line.

This is typically a negative value.

minHeight

the minimum height, defaults to -5.

this builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::minHeight.

RelativeLength()

Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.RectanglePatternBuilder.RelativeLength ( double  relativeLength )

inline

Set the length of the pattern relative to the length of the entire line, as a value between 0 and 1.

The length cannot be both fixed and relative, if both methods are used, only the last one affects the result. If no length is set, a 10 pixel fixed length will be used as default.

relativeLength

a value in [0,1].

this builder.

luciad::InvalidArgumentException

relativeLength must be in range [0,1].

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::RectanglePatternBuilder::relativeLength.