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

Creates a pattern with an arrow shape. More...

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

Public Member Functions

Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern Build ()
 Build the arrow pattern as configured. More...
 
void Dispose ()
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder FillColor (System.Drawing.Color color)
 Sets the fill color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Forward (bool forward)
 If true, the arrow is oriented towards the end of the line. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Height (double height)
 The height of the arrow, in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder LineColor (System.Drawing.Color color)
 Sets the line color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder LineWidth (double lineWidth)
 Sets the line width. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Offset (double offset)
 The offset of the arrow, relative to the base line, in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Size (double size)
 The size (~length) of the arrow, in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Type (Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePatternArrowType type)
 Sets the arrow's type. More...
 

Detailed Description

Creates a pattern with an arrow shape.

ComplexStrokePatternFactory::arrowBuilder()

2023.1

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

Member Function Documentation

◆ Build()

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

Build the arrow pattern as configured.

the ComplexStrokePattern.

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

◆ Dispose()

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

◆ FillColor()

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

Sets the fill color.

color

the arrow's fill color, defaults to white.

this builder.

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

◆ Forward()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder.Forward ( bool  forward)
inline

If true, the arrow is oriented towards the end of the line.

Defaults to true.

forward

whether the arrow is oriented towards the end of the line.

this builder.

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

◆ Height()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder.Height ( double  height)
inline

The height of the arrow, in pixels.

Must be strictly greater than 0. If it is not set, the arrow uses a default height, depending on the arrow type.

height

the height of the arrow.

this builder.

luciad::InvalidArgumentException

height must be >0.

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

◆ LineColor()

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

Sets the line color.

color

the arrow's line color, defaults to black.

this builder.

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

◆ LineWidth()

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

◆ Offset()

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

The offset of the arrow, relative to the base line, in pixels.

Defaults to 0.

offset

the offset of the arrow.

this builder.

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

◆ Size()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder.Size ( double  size)
inline

The size (~length) of the arrow, in pixels.

Defaults to 5.

size

the size of the arrow.

this builder.

luciad::InvalidArgumentException

size must be >0.

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

◆ Type()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArrowPatternBuilder.Type ( Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePatternArrowType  type)
inline

Sets the arrow's type.

Defaults to ArrowType.RegularFilled.

type

the arrow's type.

this builder.

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