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

Creates a pattern with a line segment shape. More...

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

Public Member Functions
Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern	Build ()
	Build the line pattern as configured. More...
void	Dispose ()
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	FillColor (System.Drawing.Color color)
	Sets the fill color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	FixedLength (double fixedLength)
	Set the length of the pattern in pixels. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	LineColor (System.Drawing.Color color)
	Sets the line color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	LineWidth (double lineWidth)
	Sets the line width. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	Offset0 (double offset0)
	Sets the offset of the start point of the segment, relative to the base line, in pixels. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	Offset1 (double offset1)
	Sets the offset of the end point of the segment, relative to the base line, in pixels. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder	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 line segment shape.

ComplexStrokePatternFactory::lineBuilder()

2023.1

Warning

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

Member Function Documentation

Build()

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

inline

Build the line pattern as configured.

the ComplexStrokePattern.

Warning

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

Dispose()

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

inline

FillColor()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.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::LinePatternBuilder::fillColor.

FixedLength()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.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::LinePatternBuilder::fixedLength.

LineColor()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.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::LinePatternBuilder::lineColor.

LineWidth()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.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::LinePatternBuilder::lineWidth.

Offset0()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.Offset0 ( double  offset0 )

inline

Sets the offset of the start point of the segment, relative to the base line, in pixels.

offset0

the offset in pixels. Defaults to 0.

this builder.

Warning

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

Offset1()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.Offset1 ( double  offset1 )

inline

Sets the offset of the end point of the segment, relative to the base line, in pixels.

offset1

the offset in pixels. Defaults to 0.

this builder.

Warning

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

RelativeLength()

Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.LinePatternBuilder.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::LinePatternBuilder::relativeLength.