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

Creates a pattern with a polyline shape. More...

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

Public Member Functions
Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern	Build ()
	Build the polyline pattern as configured. More...
void	Dispose ()
Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder	LineColor (System.Drawing.Color color)
	Sets the line color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder	LineWidth (double lineWidth)
	Sets the line width. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder	Points (System.Collections.Generic.IList< Luciad.Cartesian.Coordinate > points)
	Sets the points of the polyline. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder	Relative (bool relative)
	Whether the x coordinates of the points need to be interpreted as pixel values or relative values. More...

Detailed Description

Creates a pattern with a polyline shape.

The polyline's points must be set by calling the points method before calling build. All other methods are optional. ComplexStrokePatternFactory::polylineBuilder()

2023.1

Warning

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

Member Function Documentation

Build()

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

inline

Build the polyline pattern as configured.

the ComplexStrokePattern.

luciad::LogicException

when the points have not been set.

Warning

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

Dispose()

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

inline

LineColor()

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

LineWidth()

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

Points()

Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder.Points ( System.Collections.Generic.IList< Luciad.Cartesian.Coordinate >  points )

inline

Sets the points of the polyline.

Depending on the option relative, the x coordinates are interpreted as pixel value, or as coordinates relative ([0, 1]) to the length of the entire line. the Y coordinates are always pixel values. The coordinates are defined locally, so for example to define a line of length 10, the following coordinates can be used: (0,0), (10,0). There must be at least 2 points.

points

the points that make up the polyline.

this builder.

luciad::InvalidArgumentException

when the amount of points is lower than 2.

Warning

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

Relative()

Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.PolylinePatternBuilder.Relative ( bool  relative )

inline

Whether the x coordinates of the points need to be interpreted as pixel values or relative values.

Defaults to false.

relative

whether the x coordinates need to be interpreted as relative values.

this builder.

Warning

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