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

Creates a pattern with a wave shape. More...

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

Public Member Functions
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	Amplitude (double amplitude)
	The amplitude or height of the wave. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	Angle (double angle)
	The angle of the wave pattern in degrees. More...
Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern	Build ()
	Build the wave pattern as configured. More...
void	Dispose ()
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	FillColor (System.Drawing.Color color)
	Sets the fill color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	FixedLength (double fixedLength)
	Set the length of the pattern in pixels. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	LineColor (System.Drawing.Color color)
	Sets the line color. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	LineWidth (double lineWidth)
	Sets the line width. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder	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.WavePatternBuilder	StartAngle (Luciad.Cartesian.Angle startAngle)
	This determines at which point on the sine function the wave begins. More...

Detailed Description

Creates a pattern with a wave shape.

ComplexStrokePatternFactory::waveBuilder()

2023.1

Warning

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

Member Function Documentation

Amplitude()

Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder.Amplitude ( double  amplitude )

inline

The amplitude or height of the wave.

amplitude

The amplitude of the wave. This is a value in pixels, relative to the base line. Defaults to 10.

this builder.

luciad::InvalidArgumentException

amplitude must be >0.

Warning

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

Angle()

Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.WavePatternBuilder.Angle ( double  angle )

inline

The angle of the wave pattern in degrees.

When values greater than 360 degrees are used the pattern keeps going, e.g. an angle of 720 will result in two complete waves.

angle

The angle of the wave, defaults to 360 degrees.

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::WavePatternBuilder::angle.

Build()

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

inline

Build the wave pattern as configured.

the ComplexStrokePattern.

Warning

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

Dispose()

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

inline

FillColor()

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

FixedLength()

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

LineColor()

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

LineWidth()

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

RelativeLength()

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

StartAngle()

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

inline

This determines at which point on the sine function the wave begins.

0 is on the baseline, 90 is above the baseline at the max amplitude. A startAngle of 180 will result in a wave that starts on the baseline, but first goes to the right of the baseline instead of to the left.

startAngle

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

this builder.

Warning

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