Generic render settings. More...

Collaboration diagram for gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >:

[legend]

Public Types
using	Options = TOptions
	The render options.

Public Member Functions
	RenderSettings (Options options=DefOptions, const Rgba &innerColor=DefInnerColor, const Rgba &outerColor=DefOuterColor, const double &innerSz=DefInnerSz/100., const double &outerSz=DefOuterSz/100.)
	Constructor taking options and colors.
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	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
union {
Options m_options
	options
Options labelingMode
	options for labeling
};
	The render options.
union {
Rgba m_innerColor
	inner color RGBA
Rgba polylineInnerColor
	Polyline inner color RGBA.
};
	The polyline inner color.
union {
Rgba m_outerColor
	outer color RGBA
Rgba polylineOuterColor
	Polyline outer color RGBA.
};
	The polyline outer color.
union {
double m_innerSz
	inner size in mm
double polylineInnerSize
	Polyline inner size in mm.
};
	The polyline inner 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.
union {
double m_imgSz
	image size in mm
double imageSize
	image size in mm
};
	The image size in mm ( default: value from current style ).
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 ).
union {
Rgba m_textColor
	text color RGBA
Rgba labelTextColor
	label color RGBA
};
	The text color ( default: value from current style ).
union {
ELineType m_lineType
	line type
ELineType polylineType
	Polyline type.
};
	The line type.
union {
EImagePosition m_imgPos
	image position
EImagePosition imagePosition
	image position
};
	The image position.

Detailed Description

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>
struct gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >

Generic render settings.

Constructor & Destructor Documentation

◆ RenderSettings()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::RenderSettings	(	Options	options = DefOptions,
		const Rgba &	innerColor = DefInnerColor,
		const Rgba &	outerColor = DefOuterColor,
		const double &	innerSz = DefInnerSz / 100.,
		const double &	outerSz = DefOuterSz / 100. )

inline

Constructor taking options and colors.

Parameters

options	The render options
innerColor	The inner color
outerColor	The outer color
innerSz	The inner size
outerSz	The outer size

Member Function Documentation

◆ getDefaultImageSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

double gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultImageSize ( )

inlinestatic

get default image size

Returns: The default image size

◆ getDefaultInnerColor()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

Rgba gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultInnerColor ( )

inlinestatic

Get default inner color.

Returns: The default inner color

◆ getDefaultInnnerSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

double gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultInnnerSize ( )

inlinestatic

get default inner size

Returns: The default inner size

◆ getDefaultOuterColor()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

Rgba gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultOuterColor ( )

inlinestatic

get default outer color

Returns: The default outer color

◆ getDefaultOuterSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

double gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultOuterSize ( )

inlinestatic

get default outer size

Returns: The default outer size

◆ getDefaultTextColor()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

Rgba gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultTextColor ( )

inlinestatic

get default text color

Returns: The default text color

◆ getDefaultTextSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

double gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::getDefaultTextSize ( )

inlinestatic

get default image size

Returns: The default image size

◆ operator!=()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

bool gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::operator!= ( const RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass > & s ) const

inline

Not equal operator.

Parameters

s	The settings to compare

Returns: True if the settings are not equal

◆ operator==()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

bool gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::operator== ( const RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass > & s ) const

inline

Equal operator.

Parameters

s	The settings to compare

Returns: True if the settings are equal

◆ resetOption()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::resetOption ( Options option )

inline

Reset the render options.

Parameters

option The render options

Returns: A reference to the object

◆ setContourInnerColor()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setContourInnerColor ( const Rgba & color )

inline

set contour inner color

Parameters

color The color

Returns: A reference to the object

◆ setContourInnerSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setContourInnerSize ( const double & sz )

inline

set contour inner size

Parameters

sz The size

Returns: A reference to the object

◆ setContourOuterColor()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setContourOuterColor ( const Rgba & color )

inline

set contour outer color

Parameters

color The color

Returns: A reference to the object

◆ setContourOuterSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setContourOuterSize ( const double & sz )

inline

set contour outer size

Parameters

sz The size

Returns: A reference to the object

◆ setImagePosition()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setImagePosition ( EImagePosition pos )

inline

set image position

Parameters

pos	The image position

Returns: A reference to the object

◆ setImageSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setImageSize ( const double & sz )

inline

set image size

Parameters

sz The size

Returns: A reference to the object

◆ setLineType()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setLineType ( ELineType type )

inline

set line type

Parameters

type	The line type

Returns: A reference to the object

◆ setOption()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setOption ( Options option )

inline

Set the render options.

Parameters

option The render option

Returns: A reference to the object

◆ setOptions()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setOptions ( Options options )

inline

Set the render options.

Parameters

options The render options

Returns: A reference to the object

◆ setTextColor()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setTextColor ( const Rgba & color )

inline

set text color

Parameters

color The color

Returns: A reference to the object

◆ setTextSize()

template<typename TOptions, TOptions DefOptions, int DefInnerColor, int DefOuterColor, int DefInnerSz, int DefOuterSz, typename TSubclass = void>

auto & gem::RenderSettings< TOptions, DefOptions, DefInnerColor, DefOuterColor, DefInnerSz, DefOuterSz, TSubclass >::setTextSize ( const double & sz )

inline

set text size

Parameters

sz The size

Returns: A reference to the object

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RenderSettings()

Member Function Documentation

◆ getDefaultImageSize()

◆ getDefaultInnerColor()

◆ getDefaultInnnerSize()

◆ getDefaultOuterColor()

◆ getDefaultOuterSize()

◆ getDefaultTextColor()

◆ getDefaultTextSize()

◆ operator!=()

◆ operator==()

◆ resetOption()

◆ setContourInnerColor()

◆ setContourInnerSize()

◆ setContourOuterColor()

◆ setContourOuterSize()

◆ setImagePosition()

◆ setImageSize()

◆ setLineType()

◆ setOption()

◆ setOptions()

◆ setTextColor()

◆ setTextSize()