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

Creates a pattern with an arc, ellipse or circle shape. More...

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

Public Member Functions

Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder Angle (double angle)
 Specifies that only a part of the ellipse should be used, creating an arc. More...
 
Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern Build ()
 Build the arc pattern as configured. More...
 
void Dispose ()
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder FillColor (System.Drawing.Color color)
 Sets the fill color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder FixedLength (double fixedLength)
 Set the length of the pattern in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder LineColor (System.Drawing.Color color)
 Sets the line color. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder LineWidth (double lineWidth)
 Sets the line width. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder MinorRadius (double radius)
 The minor radius is the distance from the baseline to the top/bottom of the arc. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder Offset (double offset)
 Sets the offset of the arc, relative to the base line, in pixels. More...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder 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...
 
Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder StartAngle (Luciad.Cartesian.Angle startAngle)
 This determines at which point on the ellipse the arc begins. More...
 

Detailed Description

Creates a pattern with an arc, ellipse or circle shape.

ComplexStrokePatternFactory::arcBuilder()

2023.1

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

Member Function Documentation

◆ Angle()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder.Angle ( double  angle)
inline

Specifies that only a part of the ellipse should be used, creating an arc.

The part of the ellipse that will be drawn starts at startAngle and ends at startAngle + angle

angle

The angle of the arc, defaults to 360 degrees for a full ellipse.

this builder.

luciad::InvalidArgumentException

angle must be >=0.

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

◆ Build()

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

Build the arc pattern as configured.

the ComplexStrokePattern.

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

◆ Dispose()

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

◆ FillColor()

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

◆ FixedLength()

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

◆ LineColor()

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

◆ LineWidth()

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

◆ MinorRadius()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder.MinorRadius ( double  radius)
inline

The minor radius is the distance from the baseline to the top/bottom of the arc.

radius

The minor radius of the arc, in pixels. Defaults to 10.

this builder.

luciad::InvalidArgumentException

radius must be >0.

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

◆ Offset()

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

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

Defaults to 0.

offset

The offset of the arc.

this builder.

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

◆ RelativeLength()

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

◆ StartAngle()

Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.ArcPatternBuilder.StartAngle ( Luciad.Cartesian.Angle  startAngle)
inline

This determines at which point on the ellipse the arc begins.

A startAngle of 0 is on the baseline and the arc goes counter clockwise.

startAngle

The start angle of the arc, defaults to 0 degrees.

this builder.

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