LuciadCPillar C# 2023.1.04
Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder Class Reference

Creates a pattern with a line segment shape that is parallel to the base line. More...

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

Public Member Functions

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern Build ()
 Build the parallel line pattern as configured. More...
 
void Dispose ()
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder FixedLength (double fixedLength)
 Set the length of the pattern in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder LineColor (System.Drawing.Color color)
 Sets the line color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder LineWidth (double lineWidth)
 Sets the line width. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder Offset (double offset)
 Sets the offset of the line, relative to the base line, in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder 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 that is parallel to the base line.

ComplexStrokePatternFactory::parallelLineBuilder()

2023.1

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

Member Function Documentation

◆ Build()

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder.Build ( )
inline

Build the parallel line pattern as configured.

the ComplexStrokePattern.

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

◆ Dispose()

void Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder.Dispose ( )
inline

◆ FixedLength()

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

◆ LineColor()

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

◆ LineWidth()

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

◆ Offset()

Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ParallelLinePatternBuilder.Offset ( double  offset)
inline

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

offset

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::ParallelLinePatternBuilder::offset.

◆ RelativeLength()

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