Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::MarkerCollectionRenderSettings Struct Reference

Marker collection render settings. More...

Inheritance diagram for gem::MarkerCollectionRenderSettings:
Collaboration diagram for gem::MarkerCollectionRenderSettings:

Public Types

using Options
 The render options.

Public Member Functions

 MarkerCollectionRenderSettings (const Image &img=Image(kDefValue), int pointsGroupingZLevel=kDefValue, const Image &lowGImg=Image(kDefValue), int lowGCount=50, const Image &medGImg=Image(kDefValue), int medGCount=300, const Image &highGImg=Image(kDefValue))
 Constructor for MarkerCollectionRenderSettings.
 MarkerCollectionRenderSettings (const MarkerRenderSettings &settings)
 Copy constructor for MarkerCollectionRenderSettings.
 MarkerCollectionRenderSettings (MarkerRenderSettings &&settings)
 Move constructor for MarkerCollectionRenderSettings.
MarkerCollectionRenderSettingssetLowDensityGroupImage (const Image &img)
 Sets the image for rendering low density points groups.
MarkerCollectionRenderSettingssetMediumDensityGroupImage (const Image &img)
 Sets the image for rendering medium density points groups.
MarkerCollectionRenderSettingssetHighDensityGroupImage (const Image &img)
 Sets the image for rendering high density points groups.
MarkerCollectionRenderSettingssetGroupingLevel (int level)
 Sets the zoom level for points grouping.
MarkerCollectionRenderSettingssetLowGroupMaxCount (int count)
 Sets the maximum count for low density points groups.
MarkerCollectionRenderSettingssetMediumGroupMaxCount (int count)
 Sets the maximum count for medium density points groups.
MarkerCollectionRenderSettingssetBuildGroupConfig (bool v)
 Sets the flag for building points group configuration.
MarkerCollectionRenderSettingssetGroupLabelTextColor (const Rgba &color)
 Sets the text color for group labels.
MarkerCollectionRenderSettingssetMarkerLabelExtractor (std::function< String(const MarkerRef &)> fnct)
 Sets the marker label extractor function.
MarkerCollectionRenderSettingssetGroupLabelTextSize (const double &sz)
 Sets the text size for group labels.
MarkerCollectionRenderSettingssetImage (const Image &img)
 Sets the image for rendering the markers.
MarkerCollectionRenderSettingssetPolylineInnerColor (const Rgba &color)
 Sets the inner color for polylines.
MarkerCollectionRenderSettingssetPolylineType (const ELineType &type)
 Sets the line type for polylines.
MarkerCollectionRenderSettingssetPolylineOuterColor (const Rgba &color)
 Sets the outer color for polylines.
MarkerCollectionRenderSettingssetPolygonFillColor (const Rgba &color)
 Sets the fill color for polygons.
MarkerCollectionRenderSettingssetPolylineInnerSize (const double &sz)
 Sets the inner size for polylines.
MarkerCollectionRenderSettingssetPolylineOuterSize (const double &sz)
 Sets the outer size for polylines.
MarkerCollectionRenderSettingssetLabelingMode (int mode)
 Sets the labeling mode for markers.
MarkerCollectionRenderSettingssetLabelTextColor (const Rgba &color)
 Sets the text color for labels.
MarkerCollectionRenderSettingssetLabelTextSize (const double &sz)
 Sets the text size for labels.
MarkerCollectionRenderSettingssetImageSize (const double &sz)
 Sets the image size.
MarkerCollectionRenderSettingssetCustomMarkerSettings (std::function< const MarkerRenderSettings *(const MarkerRef &)> fnct)
 Sets the custom marker settings function.
MarkerCollectionRenderSettingssetPolylineTexture (const Image &img)
 Sets the texture for polylines.
MarkerCollectionRenderSettingssetPolygonTexture (const Image &img)
 Sets the texture for polygons.
MarkerCollectionRenderSettingssetPolylineDirectionArrows (bool enable)
 Sets polyline direction arrows.
MarkerCollectionRenderSettingssetPolylineDirectionArrowsInnerColor (const Rgba &color)
 Sets the polyline direction arrows inner color.
MarkerCollectionRenderSettingssetPolylineDirectionArrowsOuterColor (const Rgba &color)
 Sets the polyline direction arrows outer color.
MarkerCollectionRenderSettingssetVisibilityMinZoomLevel (int zoom)
 Sets the visibility min zoom level.
MarkerCollectionRenderSettingssetVisibilityMaxZoomLevel (int zoom)
 Sets the visibility max zoom level.
auto & setOptions (Options options)
 Set the render options.
auto & setOption (Options option)
 Set the render options.
auto & resetOption (Options option)
 Reset the render options.
auto & setContourInnerColor (const Rgba &color)
 set contour inner color
auto & setContourOuterColor (const Rgba &color)
 set contour outer color
auto & setContourInnerSize (const double &sz)
 set contour inner size
auto & setContourOuterSize (const double &sz)
 set contour outer size
auto & setTextSize (const double &sz)
 set text size
auto & setTextColor (const Rgba &color)
 set text color
auto & setLineType (ELineType type)
 set line type
auto & setImagePosition (EImagePosition pos)
 set image position
bool operator== (const RenderSettings &s) const
 Equal operator.
bool operator!= (const RenderSettings &s) const
 Not equal operator.

Static Public Member Functions

static Rgba getDefaultInnerColor ()
 Get default inner color.
static Rgba getDefaultOuterColor ()
 get default outer color
static double getDefaultInnnerSize ()
 get default inner size
static double getDefaultOuterSize ()
 get default outer size
static double getDefaultTextSize ()
 get default image size
static Rgba getDefaultTextColor ()
 get default text color
static double getDefaultImageSize ()
 get default image size

Public Attributes

int pointsGroupingZoomLevel
 The zoom level at which points grouping is enabled.
Image lowDensityPointsGroupImage
 The image for rendering low density points groups.
int lowDensityPointsGroupMaxCount
 The maximum number of items in a low density points group.
Image mediumDensityPointsGroupImage
 The image for rendering medium density points groups.
int mediumDensityPointsGroupMaxCount
 The maximum number of items in a medium density points group.
Image highDensityPointsGroupImage
 The image for rendering high density points groups.
Rgba labelGroupTextColor
 The text color for group labels.
double labelGroupTextSize
 The text size for group labels in mm.
std::function< String(const MarkerRef &)> markerLabelExtractor
 The function used for extracting custom labels from marker data.
std::function< const MarkerRenderSettings *(const MarkerRef &)> customMarkerSettings
 The function used for getting custom render settings for each marker.
bool buildPointsGroupConfig
 Flag indicating whether to build points group configuration.
Image polylineTexture
 The texture for polylines.
Image polygonTexture
 The texture for polygons.
bool polylineDirArrow
 Enable polyline direction arrow.
Rgba polylineDirArrowInnerColor
 Polyline direction arrow inner color ( default not specified ).
Rgba polylineDirArrowOuterColor
 Polyline direction arrow outer color ( default not specified ).
int minVisibilityZoomLevel
 Visibility min zoom level.
int maxVisibilityZoomLevel
 Visibility max zoom level.
Image image
 Regular image for displaying points.
Rgba polygonFillColor
 Polygon fill color ( default not specified ).
Options m_options
 options
Options labelingMode
 options for labeling
union { 
   Options   m_options 
 options
   Options   labelingMode 
 options for labeling
}; 
 The render options.
Rgba m_innerColor
 inner color RGBA
Rgba polylineInnerColor
 Polyline inner color RGBA.
union { 
   Rgba   m_innerColor 
 inner color RGBA
   Rgba   polylineInnerColor 
 Polyline inner color RGBA.
}; 
 The polyline inner color.
Rgba m_outerColor
 outer color RGBA
Rgba polylineOuterColor
 Polyline outer color RGBA.
union { 
   Rgba   m_outerColor 
 outer color RGBA
   Rgba   polylineOuterColor 
 Polyline outer color RGBA.
}; 
 The polyline outer color.
double m_innerSz
 inner size in mm
double polylineInnerSize
 Polyline inner size in mm.
union { 
   double   m_innerSz 
 inner size in mm
   double   polylineInnerSize 
 Polyline inner size in mm.
}; 
 The polyline inner size in mm.
double m_outerSz
 outer size in mm
double polylineOuterSize
 Polyline outer size in mm.
union { 
   double   m_outerSz 
 outer size in mm
   double   polylineOuterSize 
 Polyline outer size in mm.
}; 
 The polyline outer ( border ) size in mm.
double m_imgSz
 image size in mm
double imageSize
 image size in mm
union { 
   double   m_imgSz 
 image size in mm
   double   imageSize 
 image size in mm
}; 
 The image size in mm ( default: value from current style ).
double m_textSz
 text size in mm
double labelTextSize
 label text size in mm
union { 
   double   m_textSz 
 text size in mm
   double   labelTextSize 
 label text size in mm
}; 
 The text size in mm ( default: value from current style ).
Rgba m_textColor
 text color RGBA
Rgba labelTextColor
 label color RGBA
union { 
   Rgba   m_textColor 
 text color RGBA
   Rgba   labelTextColor 
 label color RGBA
}; 
 The text color ( default: value from current style ).
ELineType m_lineType
 line type
ELineType polylineType
 Polyline type.
union { 
   ELineType   m_lineType 
 line type
   ELineType   polylineType 
 Polyline type.
}; 
 The line type.
EImagePosition m_imgPos
 image position
EImagePosition imagePosition
 image position
union { 
   EImagePosition   m_imgPos 
 image position
   EImagePosition   imagePosition 
 image position
}; 
 The image position.

Static Public Attributes

static constexpr const int kDefValue = 0x7FFFFFFF
 Default value of various members. Members assigned with this value will be changed internally to something more appropriate.

Detailed Description

Marker collection render settings.

Represents the settings for rendering a collection of markers.

Constructor & Destructor Documentation

◆ MarkerCollectionRenderSettings() [1/3]

gem::MarkerCollectionRenderSettings::MarkerCollectionRenderSettings ( const Image & img = Image(kDefValue),
int pointsGroupingZLevel = kDefValue,
const Image & lowGImg = Image(kDefValue),
int lowGCount = 50,
const Image & medGImg = Image(kDefValue),
int medGCount = 300,
const Image & highGImg = Image(kDefValue) )
inline

Constructor for MarkerCollectionRenderSettings.

Parameters
imgThe image to be used for rendering the markers. Default value is kDefValue.
pointsGroupingZLevelThe zoom level at which points grouping is enabled. Default value is kDefValue.
lowGImgThe image to be used for rendering low density points groups. Default value is kDefValue.
lowGCountThe maximum number of items in a low density points group. Default value is 50.
medGImgThe image to be used for rendering medium density points groups. Default value is kDefValue.
medGCountThe maximum number of items in a medium density points group. Default value is 300.
highGImgThe image to be used for rendering high density points groups. Default value is kDefValue.

◆ MarkerCollectionRenderSettings() [2/3]

gem::MarkerCollectionRenderSettings::MarkerCollectionRenderSettings ( const MarkerRenderSettings & settings)
inline

Copy constructor for MarkerCollectionRenderSettings.

Parameters
settingsThe MarkerRenderSettings object to be copied.

◆ MarkerCollectionRenderSettings() [3/3]

gem::MarkerCollectionRenderSettings::MarkerCollectionRenderSettings ( MarkerRenderSettings && settings)
inline

Move constructor for MarkerCollectionRenderSettings.

Parameters
settingsThe MarkerRenderSettings object to be moved.

Member Function Documentation

◆ getDefaultImageSize()

double gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultImageSize ( )
inlinestaticinherited

get default image size

Returns
The default image size

◆ getDefaultInnerColor()

Rgba gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultInnerColor ( )
inlinestaticinherited

Get default inner color.

Returns
The default inner color

◆ getDefaultInnnerSize()

double gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultInnnerSize ( )
inlinestaticinherited

get default inner size

Returns
The default inner size

◆ getDefaultOuterColor()

Rgba gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultOuterColor ( )
inlinestaticinherited

get default outer color

Returns
The default outer color

◆ getDefaultOuterSize()

double gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultOuterSize ( )
inlinestaticinherited

get default outer size

Returns
The default outer size

◆ getDefaultTextColor()

Rgba gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultTextColor ( )
inlinestaticinherited

get default text color

Returns
The default text color

◆ getDefaultTextSize()

double gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::getDefaultTextSize ( )
inlinestaticinherited

get default image size

Returns
The default image size

◆ operator!=()

bool gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::operator!= ( const RenderSettings< int, 0, 0, 0, GEM_SETTING_SIZE(1.5), GEM_SETTING_SIZE(0)> & s) const
inlineinherited

Not equal operator.

Parameters
sThe settings to compare
Returns
True if the settings are not equal

◆ operator==()

bool gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::operator== ( const RenderSettings< int, 0, 0, 0, GEM_SETTING_SIZE(1.5), GEM_SETTING_SIZE(0)> & s) const
inlineinherited

Equal operator.

Parameters
sThe settings to compare
Returns
True if the settings are equal

◆ resetOption()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::resetOption ( Options option)
inlineinherited

Reset the render options.

Parameters
optionThe render options
Returns
A reference to the object

◆ setBuildGroupConfig()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setBuildGroupConfig ( bool v)
inline

Sets the flag for building points group configuration.

Parameters
vThe flag indicating whether to build points group configuration.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setContourInnerColor()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setContourInnerColor ( const Rgba & color)
inlineinherited

set contour inner color

Parameters
colorThe color
Returns
A reference to the object

◆ setContourInnerSize()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setContourInnerSize ( const double & sz)
inlineinherited

set contour inner size

Parameters
szThe size
Returns
A reference to the object

◆ setContourOuterColor()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setContourOuterColor ( const Rgba & color)
inlineinherited

set contour outer color

Parameters
colorThe color
Returns
A reference to the object

◆ setContourOuterSize()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setContourOuterSize ( const double & sz)
inlineinherited

set contour outer size

Parameters
szThe size
Returns
A reference to the object

◆ setCustomMarkerSettings()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setCustomMarkerSettings ( std::function< const MarkerRenderSettings *(const MarkerRef &)> fnct)
inline

Sets the custom marker settings function.

Parameters
fnctThe function to be used for getting custom render settings for each marker.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setGroupingLevel()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setGroupingLevel ( int level)
inline

Sets the zoom level for points grouping.

Parameters
levelThe zoom level at which points grouping is enabled.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setGroupLabelTextColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setGroupLabelTextColor ( const Rgba & color)
inline

Sets the text color for group labels.

Parameters
colorThe color to be used for group labels.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setGroupLabelTextSize()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setGroupLabelTextSize ( const double & sz)
inline

Sets the text size for group labels.

Parameters
szThe text size to be used for group labels.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setHighDensityGroupImage()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setHighDensityGroupImage ( const Image & img)
inline

Sets the image for rendering high density points groups.

Parameters
imgThe image to be used for rendering high density points groups.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setImage()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setImage ( const Image & img)
inline

Sets the image for rendering the markers.

Parameters
imgThe image to be used for rendering the markers.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setImagePosition()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setImagePosition ( EImagePosition pos)
inlineinherited

set image position

Parameters
posThe image position
Returns
A reference to the object

◆ setImageSize()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setImageSize ( const double & sz)
inline

Sets the image size.

Parameters
szThe size to be used for the image.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setLabelingMode()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setLabelingMode ( int mode)
inline

Sets the labeling mode for markers.

Parameters
modeThe labeling mode to be used for markers, a bitset of EMarkerLabelingMode values
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setLabelTextColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setLabelTextColor ( const Rgba & color)
inline

Sets the text color for labels.

Parameters
colorThe color to be used for labels.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setLabelTextSize()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setLabelTextSize ( const double & sz)
inline

Sets the text size for labels.

Parameters
szThe text size to be used for labels.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setLineType()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setLineType ( ELineType type)
inlineinherited

set line type

Parameters
typeThe line type
Returns
A reference to the object

◆ setLowDensityGroupImage()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setLowDensityGroupImage ( const Image & img)
inline

Sets the image for rendering low density points groups.

Parameters
imgThe image to be used for rendering low density points groups.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setLowGroupMaxCount()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setLowGroupMaxCount ( int count)
inline

Sets the maximum count for low density points groups.

Parameters
countThe maximum number of items in a low density points group.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setMarkerLabelExtractor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setMarkerLabelExtractor ( std::function< String(const MarkerRef &)> fnct)
inline

Sets the marker label extractor function.

Parameters
fnctThe function to be used for extracting custom labels from marker data.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setMediumDensityGroupImage()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setMediumDensityGroupImage ( const Image & img)
inline

Sets the image for rendering medium density points groups.

Parameters
imgThe image to be used for rendering medium density points groups.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setMediumGroupMaxCount()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setMediumGroupMaxCount ( int count)
inline

Sets the maximum count for medium density points groups.

Parameters
countThe maximum number of items in a medium density points group.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setOption()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setOption ( Options option)
inlineinherited

Set the render options.

Parameters
optionThe render option
Returns
A reference to the object

◆ setOptions()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setOptions ( Options options)
inlineinherited

Set the render options.

Parameters
optionsThe render options
Returns
A reference to the object

◆ setPolygonFillColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolygonFillColor ( const Rgba & color)
inline

Sets the fill color for polygons.

Parameters
colorThe color to be used for filling polygons.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolygonTexture()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolygonTexture ( const Image & img)
inline

Sets the texture for polygons.

Parameters
imgThe image to be used as the texture for polygons.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineDirectionArrows()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineDirectionArrows ( bool enable)
inline

Sets polyline direction arrows.

Parameters
enableActivate / deactivate the direction arrows
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineDirectionArrowsInnerColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineDirectionArrowsInnerColor ( const Rgba & color)
inline

Sets the polyline direction arrows inner color.

Parameters
colorThe color
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineDirectionArrowsOuterColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineDirectionArrowsOuterColor ( const Rgba & color)
inline

Sets the polyline direction arrows outer color.

Parameters
colorThe color
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineInnerColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineInnerColor ( const Rgba & color)
inline

Sets the inner color for polylines.

Parameters
colorThe color to be used for the inner part of polylines.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineInnerSize()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineInnerSize ( const double & sz)
inline

Sets the inner size for polylines.

Parameters
szThe size to be used for the inner part of polylines.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineOuterColor()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineOuterColor ( const Rgba & color)
inline

Sets the outer color for polylines.

Parameters
colorThe color to be used for the outer part of polylines.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineOuterSize()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineOuterSize ( const double & sz)
inline

Sets the outer size for polylines.

Parameters
szThe size to be used for the outer part of polylines.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineTexture()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineTexture ( const Image & img)
inline

Sets the texture for polylines.

Parameters
imgThe image to be used as the texture for polylines.
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setPolylineType()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setPolylineType ( const ELineType & type)
inline

Sets the line type for polylines.

Parameters
typeThe line type
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setTextColor()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setTextColor ( const Rgba & color)
inlineinherited

set text color

Parameters
colorThe color
Returns
A reference to the object

◆ setTextSize()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, void >::setTextSize ( const double & sz)
inlineinherited

set text size

Parameters
szThe size
Returns
A reference to the object

◆ setVisibilityMaxZoomLevel()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setVisibilityMaxZoomLevel ( int zoom)
inline

Sets the visibility max zoom level.

Parameters
zoomThe zoom level. IN_MAX - always visible, 0 - always hidden
Returns
A reference to the updated MarkerCollectionRenderSettings object.

◆ setVisibilityMinZoomLevel()

MarkerCollectionRenderSettings & gem::MarkerCollectionRenderSettings::setVisibilityMinZoomLevel ( int zoom)
inline

Sets the visibility min zoom level.

Parameters
zoomThe zoom level. 0 - always visible, INT_MAX - always hidden
Returns
A reference to the updated MarkerCollectionRenderSettings object.

Member Data Documentation

◆ buildPointsGroupConfig

bool gem::MarkerCollectionRenderSettings::buildPointsGroupConfig

Flag indicating whether to build points group configuration.

Default value is false.

If enabled, the user can access the marker -> points group relation, i.e. identify the points group head marker for every marker in the collection.

◆ customMarkerSettings

std::function<const MarkerRenderSettings *(const MarkerRef &)> gem::MarkerCollectionRenderSettings::customMarkerSettings

The function used for getting custom render settings for each marker.

If defined, the marker collection will call this function to get a custom render setting for each marker.

Typical usage is to keep the custom render settings in a map<marker id, MarkerRenderSettings>.

◆ image

Image gem::MarkerRenderSettings::image
inherited

Regular image for displaying points.

If not provided, the marker is considered to be rendered externally through the IViewListener::onMarkerRender notification

Only MT_Point type marker collections support external marker rendering

For MT_Polyline & MT_Polygon providing a default Image will disable the geometry points rendering

◆ labelGroupTextColor

Rgba gem::MarkerCollectionRenderSettings::labelGroupTextColor

The text color for group labels.

Default value is obtained from the current style.

◆ labelGroupTextSize

double gem::MarkerCollectionRenderSettings::labelGroupTextSize

The text size for group labels in mm.

Default value is current map view style based

◆ lowDensityPointsGroupMaxCount

int gem::MarkerCollectionRenderSettings::lowDensityPointsGroupMaxCount

The maximum number of items in a low density points group.

If the group items are less than or equal to this value, the lowDensityPointsGroupImage is used for displaying the group.

◆ markerLabelExtractor

std::function<String(const MarkerRef &)> gem::MarkerCollectionRenderSettings::markerLabelExtractor

The function used for extracting custom labels from marker data.

If defined, the marker collection will call this function to extract a custom label from marker data.

◆ maxVisibilityZoomLevel

int gem::MarkerCollectionRenderSettings::maxVisibilityZoomLevel

Visibility max zoom level.

Default value is current map view style based

◆ mediumDensityPointsGroupMaxCount

int gem::MarkerCollectionRenderSettings::mediumDensityPointsGroupMaxCount

The maximum number of items in a medium density points group.

If the group items are less than or equal to this value, the mediumDensityPointsGroupImage is used for displaying the group.

◆ minVisibilityZoomLevel

int gem::MarkerCollectionRenderSettings::minVisibilityZoomLevel

Visibility min zoom level.

Default value is current map view style based

◆ pointsGroupingZoomLevel

int gem::MarkerCollectionRenderSettings::pointsGroupingZoomLevel

The zoom level at which points grouping is enabled.

If equal to 0, grouping is disabled.

If equal to UINT_MAX, grouping is always enabled.

◆ polygonTexture

Image gem::MarkerCollectionRenderSettings::polygonTexture

The texture for polygons.

Default value is none.

The polygon texture will be blended with the polygonFillColor value. User must set polygonFillColor to Rgba::white() in order to preserve original texture colors.

◆ polylineDirArrow

bool gem::MarkerCollectionRenderSettings::polylineDirArrow

Enable polyline direction arrow.

Default value is false.

◆ polylineDirArrowInnerColor

Rgba gem::MarkerCollectionRenderSettings::polylineDirArrowInnerColor

Polyline direction arrow inner color ( default not specified ).

Default value is none.

◆ polylineDirArrowOuterColor

Rgba gem::MarkerCollectionRenderSettings::polylineDirArrowOuterColor

Polyline direction arrow outer color ( default not specified ).

Default value is none.

◆ polylineTexture

Image gem::MarkerCollectionRenderSettings::polylineTexture

The texture for polylines.

Default value is none.

The polyline texture will be blended with the polylineInnerColor value. User must set polylineInnerColor to Rgba::white() in order to preserve original texture colors.

The polyline texture will will override the polylineType selection.