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

Creates a pattern with a triangle shape. More...

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

Public Member Functions

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern Build ()
 Build the triangle pattern as configured. More...
 
void Dispose ()
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder FillColor (System.Drawing.Color color)
 Sets the fill color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder LineColor (System.Drawing.Color color)
 Sets the line color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder LineWidth (double lineWidth)
 Sets the line width. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder P0 (Luciad.Cartesian.Coordinate coordinate)
 The 2D coordinate of the first point of the triangle. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder P1 (Luciad.Cartesian.Coordinate coordinate)
 The 2D coordinate of the second point of the triangle. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder P2 (Luciad.Cartesian.Coordinate coordinate)
 The 2D coordinate of the third point of the triangle. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder Relative (bool relative)
 Sets whether the x coordinates of the points need to be interpreted as pixel values or as values in range [0,1] relative to the line. More...
 

Detailed Description

Creates a pattern with a triangle shape.

ComplexStrokePatternFactory::triangleBuilder()

2023.1

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

Member Function Documentation

◆ Build()

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

Build the triangle 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::TrianglePatternBuilder::build.

◆ Dispose()

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

◆ FillColor()

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

◆ LineColor()

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

◆ LineWidth()

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

◆ P0()

Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder.P0 ( Luciad.Cartesian.Coordinate  coordinate)
inline

The 2D coordinate of the first point of the triangle.

These coordinates are pixel values. If relative is set to true the x-coordinate is a length relative to the line (a value in [0,1]) but the y-coordinate remains a pixel value. This parameter is mandatory. If it is not set, build throws an exception.

coordinate

a 2D coordinate.

this builder.

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

◆ P1()

Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder.P1 ( Luciad.Cartesian.Coordinate  coordinate)
inline

The 2D coordinate of the second point of the triangle.

These coordinates are pixel values. If relative is set to true the x-coordinate is a length relative to the line (a value in [0,1]) but the y-coordinate remains a pixel value. This parameter is mandatory. If it is not set, build throws an exception.

coordinate

a 2D coordinate.

this builder.

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

◆ P2()

Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder.P2 ( Luciad.Cartesian.Coordinate  coordinate)
inline

The 2D coordinate of the third point of the triangle.

These coordinates are pixel values. If relative is set to true the x-coordinate is a length relative to the line (a value in [0,1]) but the y-coordinate remains a pixel value. This parameter is mandatory. If it is not set, build throws an exception.

coordinate

a 2D coordinate.

this builder.

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

◆ Relative()

Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.TrianglePatternBuilder.Relative ( bool  relative)
inline

Sets whether the x coordinates of the points need to be interpreted as pixel values or as values in range [0,1] relative to the line.

Defaults to false.

relative

whether the coordinates are relative or not.

this builder.

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