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

Route render settings. More...

Inheritance diagram for gem::RouteRenderSettings:
Collaboration diagram for gem::RouteRenderSettings:

Public Types

using Options
 The render options.

Public Member Functions

 RouteRenderSettings (int options=RRS_ShowTraffic|RRS_ShowTurnArrows|RRS_ShowWaypoints|RRS_ShowHighlights, const Rgba &innerColor=Rgba::noColor(), const Rgba &outerColor=Rgba::noColor(), double innerSz=-1., double outerSz=0., const Rgba &traveledInnerColor=Rgba::noColor(), const Rgba &turnArrowInnerColor=Rgba::noColor(), const Rgba &turnArrowOuterColor=Rgba::noColor(), double turnArrowInnerSz=-1., double turnArrowOuterSz=0.)
 Constructor taking options and colors.
RouteRenderSettingssetFillColor (const Rgba &color)
 Sets the fill color for the route.
RouteRenderSettingssetTraveledInnerColor (const Rgba &color)
 Sets the color of the traveled part of the route.
RouteRenderSettingssetTurnArrowInnerColor (const Rgba &color)
 Sets the inner color of the turn arrows on the route.
RouteRenderSettingssetTurnArrowOuterColor (const Rgba &color)
 Sets the outer color of the turn arrows on the route.
RouteRenderSettingssetTurnArrowInnerSize (double sz)
 Sets the inner size of the turn arrows on the route.
RouteRenderSettingssetTurnArrowOuterSize (double sz)
 Sets the outer size of the turn arrows on the route.
RouteRenderSettingssetWaypointTextSize (double sz)
 Sets the text size for waypoints on the route.
RouteRenderSettingssetWaypointTextInnerColor (const Rgba &color)
 Sets the inner text color for waypoint labels on the route.
RouteRenderSettingssetWaypointTextOuterColor (const Rgba &color)
 Sets the outer text color for waypoint labels on the route.
RouteRenderSettingssetWaypointImageSize (double sz)
 Sets the image size for waypoints on the route.
RouteRenderSettingssetDirectionArrowInnerColor (const Rgba &color)
 Sets the route direction arrow inner color.
RouteRenderSettingssetDirectionArrowOuterColor (const Rgba &color)
 Sets the route direction arrow outer color.
RouteRenderSettingssetDirectionArrowSize (double sz)
 Sets the route direction arrow width.
RouteRenderSettingssetInnerGradientEndColor (const Rgba &color)
 Sets the route inner end color ( gradient fill ).
RouteRenderSettingssetTraveledInnerGradientEndColor (const Rgba &color)
 Sets the route inner end color for traveled part ( gradient fill ).
bool operator== (const RouteRenderSettings &s) const
 Checks for equality between two RouteRenderSettings instances.
bool operator!= (const RouteRenderSettings &s) const
 Checks for inequality between two RouteRenderSettings instances.
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 & setImageSize (const double &sz)
 set image 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 getDefaultFillColor ()
 Provides the default fill color for routes.
static Rgba getDefaultTraveledInnerColor ()
 Provides the default color for the traveled inner part of the route.
static Rgba getDefaultTurnArrowInnerColor ()
 Provides the default inner color for turn arrows on the route.
static Rgba getDefaultTurnArrowOuterColor ()
 Provides the default outer color for turn arrows on the route.
static double getDefaultTurnArrowInnerSize ()
 Provides the default inner size for turn arrows on the route.
static double getDefaultTurnArrowOuterSize ()
 Provides the default outer size for turn arrows on the route.
static double getDefaultWaypointTextSize ()
 Provides the default size for route waypoints text.
static Rgba getDefaultWaypointTextInnerColor ()
 Provides the default inner color for waypoint text on the route.
static Rgba getDefaultWaypointTextOuterColor ()
 Provides the default outer color for waypoint text on the route.
static double getDefaultWaypointImageSize ()
 Provides the default size for route waypoints image.
static Rgba getDefaultDirectionArrowInnerColor ()
 Provides the default inner color for direction arrows.
static Rgba getDefaultDirectionArrowOuterColor ()
 Provides the default outer color for direction arrows.
static Rgba getDefaultDirectionArrowSize ()
 Provides the default size for direction arrows.
static Rgba getDefaultInnerGradientEndColor ()
 Provides the default gradient inner end color.
static Rgba getDefaultTraveledInnerGradientEndColor ()
 Provides the default gradient inner end color for traveled part.
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

Rgba m_traveledInnerColor
 The traveled route part inner color.
Rgba m_turnArrowInnerColor
 The turn arrow inner color.
Rgba m_turnArrowOuterColor
 The turn arrow outer color.
double m_turnArrowInnerSz
 The turn arrow inner size ( mm ).
double m_turnArrowOuterSz
 The turn arrow outer size ( mm ).
Rgba m_fillColor
 The route fill color ( only for result type = RRT_Range ).
double m_waypointTextSz
 Waypoint names text size ( mm ). Default is 0, meaning waypoint names are not displayed.
Rgba m_waypointTextInnerColor
 Waypoints text inner color.
Rgba m_waypointTextOuterColor
 Waypoints text outer color.
double m_waypointImgSz
 Waypoint image size ( mm ). Default is 0, meaning map view style value is used.
Rgba m_dirArrowInnerColor
 Direction arrow inner color.
Rgba m_dirArrowOuterColor
 Direction arrow outer color.
double m_dirArrowSz
 Direction arrow width ( mm ).
Rgba m_innerGradientEndColor
 The route inner color end.
Rgba m_traveledInnerGradientEndColor
 The traveled route inner color end.
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.

Detailed Description

Route render settings.

Constructor & Destructor Documentation

◆ RouteRenderSettings()

gem::RouteRenderSettings::RouteRenderSettings ( int options = RRS_ShowTraffic | RRS_ShowTurnArrows | RRS_ShowWaypoints | RRS_ShowHighlights,
const Rgba & innerColor = Rgba::noColor(),
const Rgba & outerColor = Rgba::noColor(),
double innerSz = -1.,
double outerSz = 0.,
const Rgba & traveledInnerColor = Rgba::noColor(),
const Rgba & turnArrowInnerColor = Rgba::noColor(),
const Rgba & turnArrowOuterColor = Rgba::noColor(),
double turnArrowInnerSz = -1.,
double turnArrowOuterSz = 0. )
inline

Constructor taking options and colors.

Parameters
optionsThe options to be used for rendering the route.
innerColorThe color to be used for the inner part of the route.
outerColorThe color to be used for the outer part of the route.
innerSzThe size of the inner part of the route.
outerSzThe size of the outer part of the route.
traveledInnerColorThe color to be used for the inner part of the route that has been traveled.
turnArrowInnerColorThe color to be used for the inner part of the turn arrows.
turnArrowOuterColorThe color to be used for the outer part of the turn arrows.
turnArrowInnerSzThe size of the inner part of the turn arrows.
turnArrowOuterSzThe size of the outer part of the turn arrows.

Member Function Documentation

◆ getDefaultDirectionArrowInnerColor()

Rgba gem::RouteRenderSettings::getDefaultDirectionArrowInnerColor ( )
inlinestatic

Provides the default inner color for direction arrows.

Returns
The default RGBA color value with no color, used for the outer part of waypoint text.

◆ getDefaultDirectionArrowOuterColor()

Rgba gem::RouteRenderSettings::getDefaultDirectionArrowOuterColor ( )
inlinestatic

Provides the default outer color for direction arrows.

Returns
The default RGBA color value with no color, used for the outer part of waypoint text.

◆ getDefaultDirectionArrowSize()

Rgba gem::RouteRenderSettings::getDefaultDirectionArrowSize ( )
inlinestatic

Provides the default size for direction arrows.

Returns
The default value

◆ getDefaultFillColor()

Rgba gem::RouteRenderSettings::getDefaultFillColor ( )
inlinestatic

Provides the default fill color for routes.

Returns
The default RGBA color value with no color.

◆ getDefaultImageSize()

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

get default image size

Returns
The default image size

◆ getDefaultInnerColor()

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

Get default inner color.

Returns
The default inner color

◆ getDefaultInnerGradientEndColor()

Rgba gem::RouteRenderSettings::getDefaultInnerGradientEndColor ( )
inlinestatic

Provides the default gradient inner end color.

Returns
The default RGBA color value with no color meaning gradient fill is disabled

◆ getDefaultInnnerSize()

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

get default inner size

Returns
The default inner size

◆ getDefaultOuterColor()

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

get default outer color

Returns
The default outer color

◆ getDefaultOuterSize()

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

get default outer size

Returns
The default outer size

◆ getDefaultTextColor()

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

get default text color

Returns
The default text color

◆ getDefaultTextSize()

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

get default image size

Returns
The default image size

◆ getDefaultTraveledInnerColor()

Rgba gem::RouteRenderSettings::getDefaultTraveledInnerColor ( )
inlinestatic

Provides the default color for the traveled inner part of the route.

Returns
The default RGBA color value with no color.

◆ getDefaultTraveledInnerGradientEndColor()

Rgba gem::RouteRenderSettings::getDefaultTraveledInnerGradientEndColor ( )
inlinestatic

Provides the default gradient inner end color for traveled part.

Returns
The default RGBA color value with no color meaning gradient fill is disabled

◆ getDefaultTurnArrowInnerColor()

Rgba gem::RouteRenderSettings::getDefaultTurnArrowInnerColor ( )
inlinestatic

Provides the default inner color for turn arrows on the route.

Returns
The default RGBA color value with no color.

◆ getDefaultTurnArrowInnerSize()

double gem::RouteRenderSettings::getDefaultTurnArrowInnerSize ( )
inlinestatic

Provides the default inner size for turn arrows on the route.

Returns
The default size value, typically indicating no specific size set.

◆ getDefaultTurnArrowOuterColor()

Rgba gem::RouteRenderSettings::getDefaultTurnArrowOuterColor ( )
inlinestatic

Provides the default outer color for turn arrows on the route.

Returns
The default RGBA color value with no color.

◆ getDefaultTurnArrowOuterSize()

double gem::RouteRenderSettings::getDefaultTurnArrowOuterSize ( )
inlinestatic

Provides the default outer size for turn arrows on the route.

Returns
The default size value, typically zero, indicating no outer size.

◆ getDefaultWaypointImageSize()

double gem::RouteRenderSettings::getDefaultWaypointImageSize ( )
inlinestatic

Provides the default size for route waypoints image.

Returns
The default size value, typically zero, used for waypoint labels image.

◆ getDefaultWaypointTextInnerColor()

Rgba gem::RouteRenderSettings::getDefaultWaypointTextInnerColor ( )
inlinestatic

Provides the default inner color for waypoint text on the route.

Returns
The default RGBA color value with no color, used for the inner part of waypoint text.

◆ getDefaultWaypointTextOuterColor()

Rgba gem::RouteRenderSettings::getDefaultWaypointTextOuterColor ( )
inlinestatic

Provides the default outer color for waypoint text on the route.

Returns
The default RGBA color value with no color, used for the outer part of waypoint text.

◆ getDefaultWaypointTextSize()

double gem::RouteRenderSettings::getDefaultWaypointTextSize ( )
inlinestatic

Provides the default size for route waypoints text.

Returns
The default size value, typically zero, used for waypoint labels text.

◆ operator!=() [1/2]

bool gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, struct RouteRenderSettings >::operator!= ( const RenderSettings< int, int(RRS_ShowTraffic|RRS_ShowTurnArrows|RRS_ShowWaypoints|RRS_ShowHighlights), GEM_SETTING_COLOR(0, 0, 0, 0), GEM_SETTING_COLOR(0, 0, 0, 0), GEM_SETTING_SIZE(-1.), GEM_SETTING_SIZE(0.), struct RouteRenderSettings > & s) const
inlineinherited

Not equal operator.

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

◆ operator!=() [2/2]

bool gem::RouteRenderSettings::operator!= ( const RouteRenderSettings & s) const
inline

Checks for inequality between two RouteRenderSettings instances.

Parameters
sAnother instance of RouteRenderSettings to compare with.
Returns
True if any property does not match, false otherwise.

◆ operator==() [1/2]

bool gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, struct RouteRenderSettings >::operator== ( const RenderSettings< int, int(RRS_ShowTraffic|RRS_ShowTurnArrows|RRS_ShowWaypoints|RRS_ShowHighlights), GEM_SETTING_COLOR(0, 0, 0, 0), GEM_SETTING_COLOR(0, 0, 0, 0), GEM_SETTING_SIZE(-1.), GEM_SETTING_SIZE(0.), struct RouteRenderSettings > & s) const
inlineinherited

Equal operator.

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

◆ operator==() [2/2]

bool gem::RouteRenderSettings::operator== ( const RouteRenderSettings & s) const
inline

Checks for equality between two RouteRenderSettings instances.

Parameters
sAnother instance of RouteRenderSettings to compare with.
Returns
True if all properties match, false otherwise.

◆ resetOption()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, struct RouteRenderSettings >::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, struct RouteRenderSettings >::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, struct RouteRenderSettings >::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, struct RouteRenderSettings >::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, struct RouteRenderSettings >::setContourOuterSize ( const double & sz)
inlineinherited

set contour outer size

Parameters
szThe size
Returns
A reference to the object

◆ setDirectionArrowInnerColor()

RouteRenderSettings & gem::RouteRenderSettings::setDirectionArrowInnerColor ( const Rgba & color)
inline

Sets the route direction arrow inner color.

Parameters
colorThe new direction arrow inner color
Returns
Reference to the current RouteRenderSettings instance.

◆ setDirectionArrowOuterColor()

RouteRenderSettings & gem::RouteRenderSettings::setDirectionArrowOuterColor ( const Rgba & color)
inline

Sets the route direction arrow outer color.

Parameters
colorThe new direction arrow outer color
Returns
Reference to the current RouteRenderSettings instance.

◆ setDirectionArrowSize()

RouteRenderSettings & gem::RouteRenderSettings::setDirectionArrowSize ( double sz)
inline

Sets the route direction arrow width.

Parameters
szThe new direction arrow width ( mm )
Returns
Reference to the current RouteRenderSettings instance.

◆ setFillColor()

RouteRenderSettings & gem::RouteRenderSettings::setFillColor ( const Rgba & color)
inline

Sets the fill color for the route.

Parameters
colorThe new fill color to be used.
Returns
Reference to the current RouteRenderSettings instance.

◆ setImagePosition()

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

set image position

Parameters
posThe image position
Returns
A reference to the object

◆ setImageSize()

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

set image size

Parameters
szThe size
Returns
A reference to the object

◆ setInnerGradientEndColor()

RouteRenderSettings & gem::RouteRenderSettings::setInnerGradientEndColor ( const Rgba & color)
inline

Sets the route inner end color ( gradient fill ).

Parameters
colorThe route inner end color
Returns
Reference to the current RouteRenderSettings instance.

◆ setLineType()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, struct RouteRenderSettings >::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, struct RouteRenderSettings >::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, struct RouteRenderSettings >::setOptions ( Options options)
inlineinherited

Set the render options.

Parameters
optionsThe render options
Returns
A reference to the object

◆ setTextColor()

auto & gem::RenderSettings< int, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, struct RouteRenderSettings >::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, struct RouteRenderSettings >::setTextSize ( const double & sz)
inlineinherited

set text size

Parameters
szThe size
Returns
A reference to the object

◆ setTraveledInnerColor()

RouteRenderSettings & gem::RouteRenderSettings::setTraveledInnerColor ( const Rgba & color)
inline

Sets the color of the traveled part of the route.

Parameters
colorThe new color for the traveled part.
Returns
Reference to the current RouteRenderSettings instance.

◆ setTraveledInnerGradientEndColor()

RouteRenderSettings & gem::RouteRenderSettings::setTraveledInnerGradientEndColor ( const Rgba & color)
inline

Sets the route inner end color for traveled part ( gradient fill ).

Parameters
colorThe traveled route inner end color
Returns
Reference to the current RouteRenderSettings instance.

◆ setTurnArrowInnerColor()

RouteRenderSettings & gem::RouteRenderSettings::setTurnArrowInnerColor ( const Rgba & color)
inline

Sets the inner color of the turn arrows on the route.

Parameters
colorThe new inner color for the turn arrows.
Returns
Reference to the current RouteRenderSettings instance.

◆ setTurnArrowInnerSize()

RouteRenderSettings & gem::RouteRenderSettings::setTurnArrowInnerSize ( double sz)
inline

Sets the inner size of the turn arrows on the route.

Parameters
szThe new inner size for the turn arrows ( mm ).
Returns
Reference to the current RouteRenderSettings instance.

◆ setTurnArrowOuterColor()

RouteRenderSettings & gem::RouteRenderSettings::setTurnArrowOuterColor ( const Rgba & color)
inline

Sets the outer color of the turn arrows on the route.

Parameters
colorThe new outer color for the turn arrows.
Returns
Reference to the current RouteRenderSettings instance.

◆ setTurnArrowOuterSize()

RouteRenderSettings & gem::RouteRenderSettings::setTurnArrowOuterSize ( double sz)
inline

Sets the outer size of the turn arrows on the route.

Parameters
szThe new outer size for the turn arrows ( mm ).
Returns
Reference to the current RouteRenderSettings instance.

◆ setWaypointImageSize()

RouteRenderSettings & gem::RouteRenderSettings::setWaypointImageSize ( double sz)
inline

Sets the image size for waypoints on the route.

Parameters
szThe new image size for waypoint labels ( mm ).
Returns
Reference to the current RouteRenderSettings instance.

◆ setWaypointTextInnerColor()

RouteRenderSettings & gem::RouteRenderSettings::setWaypointTextInnerColor ( const Rgba & color)
inline

Sets the inner text color for waypoint labels on the route.

Parameters
colorThe new inner text color for waypoint labels.
Returns
Reference to the current RouteRenderSettings instance.

◆ setWaypointTextOuterColor()

RouteRenderSettings & gem::RouteRenderSettings::setWaypointTextOuterColor ( const Rgba & color)
inline

Sets the outer text color for waypoint labels on the route.

Parameters
colorThe new outer text color for waypoint labels.
Returns
Reference to the current RouteRenderSettings instance.

◆ setWaypointTextSize()

RouteRenderSettings & gem::RouteRenderSettings::setWaypointTextSize ( double sz)
inline

Sets the text size for waypoints on the route.

Parameters
szThe new text size for waypoint labels ( mm ).
Returns
Reference to the current RouteRenderSettings instance.

Member Data Documentation

◆ m_fillColor

Rgba gem::RouteRenderSettings::m_fillColor

The route fill color ( only for result type = RRT_Range ).

If not specified the Sdk will use the innerColor with a default alpha channel

◆ m_innerGradientEndColor

Rgba gem::RouteRenderSettings::m_innerGradientEndColor

The route inner color end.

Used for gradient rendering along the route, if valid ( !noColor() )

◆ m_traveledInnerGradientEndColor

Rgba gem::RouteRenderSettings::m_traveledInnerGradientEndColor

The traveled route inner color end.

Used for gradient rendering along the route, if valid ( !noColor() )