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

Creates a pattern containing an icon. More...

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

Public Member Functions
Luciad.Layers.Styles.ComplexStrokes.ComplexStrokePattern	Build ()
	Build the icon pattern as configured. More...
void	Dispose ()
Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder	Icon (Luciad.Drawing.IIcon icon)
	Sets the icon to be displayed. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder	Offset (double offset)
	Sets the offset of the icon, relative to the base line, in pixels. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder	Opacity (double opacity)
	The opacity of the icon, determines how transparent an icon will be painted. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder	RotateUp (bool rotateUp)
	Indicates if the icon should be flipped when it is turned upside down. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder	Rotation (Luciad.Cartesian.Angle rotation)
	The rotation angle around the center of the icon's image, specified in degrees. More...
Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder	Scale (double scale)
	Sets the factor by which the icon will be scaled. More...

Detailed Description

Creates a pattern containing an icon.

The icon must be set by calling the icon method before calling build. All other methods are optional. ComplexStrokePatternFactory::iconBuilder()

2023.1

Warning

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

Member Function Documentation

Build()

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

inline

Build the icon pattern as configured.

the ComplexStrokePattern.

luciad::LogicException

when the icon has not been set.

Warning

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

Dispose()

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

inline

Icon()

Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder.Icon ( Luciad.Drawing.IIcon  icon )

inline

Sets the icon to be displayed.

May not be nullptr.

icon

the icon to be displayed.

this builder.

luciad::InvalidArgumentException

icon may not be nullptr.

Warning

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

Offset()

Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder.Offset ( double  offset )

inline

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

Defaults to 0.

offset

the offset of the icon.

this builder.

Warning

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

Opacity()

Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder.Opacity ( double  opacity )

inline

The opacity of the icon, determines how transparent an icon will be painted.

It needs to be specified between 0 and 1. 0 indicates that the icon is painted completely transparent and 1 indicates that the original opacity of the icon is used.

opacity

the icon's opacity in the [0,1] interval, defaults to 1.

this builder.

luciad::InvalidArgumentException

opacity must be in range [0,1].

Warning

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

RotateUp()

Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder.RotateUp ( bool  rotateUp )

inline

Indicates if the icon should be flipped when it is turned upside down.

Defaults to false.

rotateUp

Indicates if the icon should be flipped when it is turned upside down.

this builder.

Warning

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

Rotation()

Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder.Rotation ( Luciad.Cartesian.Angle  rotation )

inline

The rotation angle around the center of the icon's image, specified in degrees.

Rotations are applied in a clock-wise fashion relatively to the direction of the underlying line. When rotateUp is set to true, the flipping occurs on the already rotated icon. The default is 0, which implies the icon is not rotated.

rotation

the rotation, defaults to 0 degrees.

this builder.

Warning

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

Scale()

Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder Luciad.Layers.Styles.ComplexStrokes.Builders.IconPatternBuilder.Scale ( double  scale )

inline

Sets the factor by which the icon will be scaled.

Defaults to 1 (no scaling).

scale

the scale factor.

this builder.

luciad::InvalidArgumentException

scale must be >0.

Warning

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