LuciadCPillar 2023.1.04
luciad::FillStyle::Builder Class Referencefinal

A builder class for creating fill styles. More...

#include <luciad/layers/styles/FillStyle.h>

Public Member Functions

 Builder (const Builder &other)
 
 ~Builder ()
 
FillStyle build () const
 Returns a newly created fill style, based on the properties set on this builder. More...
 
Buildercolor (Color color)
 Sets the fill color. More...
 
Buildericon (std::shared_ptr< IIcon > icon)
 Sets the icon to use as fill. More...
 
Builderimage (std::shared_ptr< Image > image)
 Sets the image to use as fill. More...
 

Detailed Description

A builder class for creating fill styles.

Constructor & Destructor Documentation

◆ Builder()

luciad::FillStyle::Builder::Builder ( const Builder other)

◆ ~Builder()

luciad::FillStyle::Builder::~Builder ( )

Member Function Documentation

◆ build()

FillStyle luciad::FillStyle::Builder::build ( ) const

Returns a newly created fill style, based on the properties set on this builder.

Returns
a newly created fill style.

◆ color()

Builder & luciad::FillStyle::Builder::color ( Color  color)

Sets the fill color.

By default, the color is transparent yellow.

Parameters
colorthe fill color
Returns
this builder.

◆ icon()

Builder & luciad::FillStyle::Builder::icon ( std::shared_ptr< IIcon icon)

Sets the icon to use as fill.

By default, no icon is used.

Parameters
iconthe icon to use as fill style
Returns
this builder.
Exceptions
luciad::NullArgumentExceptionwhen the icon is nullptr.
Since
2022.0

◆ image()

Builder & luciad::FillStyle::Builder::image ( std::shared_ptr< Image image)

Sets the image to use as fill.

By default, no image is used.

For the best performance, reuse the same Image instance when calling this function multiple times for different features.

Parameters
imagethe image to use as fill style
Returns
this builder.
Exceptions
luciad::NullArgumentExceptionwhen the image is nullptr.