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

Marker render settings. More...

Inheritance diagram for gem::MarkerRenderSettings:
Collaboration diagram for gem::MarkerRenderSettings:

Public Types

using Options
 The render options.

Public Member Functions

 MarkerRenderSettings (const Image &img=Image(kDefValue))
 Default constructor.
MarkerRenderSettingssetImage (const Image &img)
 Set image.
MarkerRenderSettingssetPolylineInnerColor (const Rgba &color)
 Set polyline inner color.
MarkerRenderSettingssetPolylineOuterColor (const Rgba &color)
 Set polyline outer color.
MarkerRenderSettingssetPolylineType (const ELineType &type)
 Set polyline line type.
MarkerRenderSettingssetPolygonFillColor (const Rgba &color)
 Set polygon fill color.
MarkerRenderSettingssetPolylineInnerSize (const double &sz)
 Set polyline inner size.
MarkerRenderSettingssetPolylineOuterSize (const double &sz)
 Set polyline outer size.
MarkerRenderSettingssetLabelingMode (int mode)
 Set labeling mode.
MarkerRenderSettingssetLabelTextColor (const Rgba &color)
 Set label text color.
MarkerRenderSettingssetLabelTextSize (const double &sz)
 Set label text size.
MarkerRenderSettingssetImageSize (const double &sz)
 Set image size.
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

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 render settings.

Constructor & Destructor Documentation

◆ MarkerRenderSettings()

gem::MarkerRenderSettings::MarkerRenderSettings ( const Image & img = ImagekDefValue ))
inline

Default constructor.

Parameters
imgRegular image for displaying points

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

◆ 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

◆ setImage()

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

Set image.

Parameters
imgImage
Returns
MarkerRenderSettings reference

◆ 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()

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

Set image size.

Parameters
szSize
Returns
MarkerRenderSettings reference

◆ setLabelingMode()

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

Set labeling mode.

Parameters
modeMode
Returns
MarkerRenderSettings reference

◆ setLabelTextColor()

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

Set label text color.

Parameters
colorColor
Returns
MarkerRenderSettings reference

◆ setLabelTextSize()

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

Set label text size.

Parameters
szSize
Returns
MarkerRenderSettings reference

◆ 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

◆ 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()

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

Set polygon fill color.

Parameters
colorColor
Returns
MarkerRenderSettings reference

◆ setPolylineInnerColor()

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

Set polyline inner color.

Parameters
colorColor
Returns
MarkerRenderSettings reference

◆ setPolylineInnerSize()

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

Set polyline inner size.

Parameters
szSize
Returns
MarkerRenderSettings reference

◆ setPolylineOuterColor()

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

Set polyline outer color.

Parameters
colorColor
Returns
MarkerRenderSettings reference

◆ setPolylineOuterSize()

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

Set polyline outer size.

Parameters
szSize
Returns
MarkerRenderSettings reference

◆ setPolylineType()

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

Set polyline line type.

Parameters
typeLine type
Returns
MarkerRenderSettings reference

◆ 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

Member Data Documentation

◆ image

Image gem::MarkerRenderSettings::image

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