h2d::img::DrawParams Class Reference

Draw parameters, independent of back-end library. More...

#include <homog2d.hpp>

Collaboration diagram for h2d::img::DrawParams:

Public Member Functions
Color	color () const
cv::Scalar	cvColor () const
	DrawParams ()
DrawParams &	selectPoint ()
DrawParams &	setAttrString (std::string attr)
	Add some specific SVG attributes (ignored for Opencv renderings) More...
DrawParams &	setColor (uint8_t r, uint8_t g, uint8_t b)
DrawParams &	setColor (Color col)
void	setDefault ()
DrawParams &	setFontSize (int value)
	Set font size for drawText() More...
DrawParams &	setPointSize (uint8_t ps)
DrawParams &	setPointStyle (PtStyle ps)
DrawParams &	setThickness (uint8_t t)
DrawParams &	showAngles (bool b=true)
	Set or unset the drawing of angles of polylines. More...
DrawParams &	showIndex (bool b=true)
	Set or unset the drawing of points (useful only for Segment_ and Polyline_) More...
DrawParams &	showPoints (bool b=true)
	Set or unset the drawing of points (useful only for Segment_ and Polyline_) More...

Static Public Member Functions
static void	resetDefault ()

Public Attributes
Dp_values	_dpValues

Friends
template<typename T , typename U >
class	h2d::base::LPBase
template<typename T , typename U >
class	h2d::base::PolylineBase
template<typename T , typename U >
class	h2d::base::SegVec
template<typename T >
class	h2d::Circle_
template<typename T >
class	h2d::Ellipse_
template<typename T >
class	h2d::FRect_
std::ostream &	operator<< (std::ostream &f, const DrawParams &dp)

Detailed Description

Draw parameters, independent of back-end library.

Constructor & Destructor Documentation

DrawParams()

h2d::img::DrawParams::DrawParams ( )

inline

    {
        _dpValues = p_getDefault();
    }

Member Function Documentation

color()

Color h2d::img::DrawParams::color ( ) const

inline

    {
        return _dpValues._color;
    }

Here is the caller graph for this function:

cvColor()

cv::Scalar h2d::img::DrawParams::cvColor ( ) const

inline

    {
        return cv::Scalar( _dpValues._color.b, _dpValues._color.g, _dpValues._color.r );
    }

Here is the caller graph for this function:

resetDefault()

static void h2d::img::DrawParams::resetDefault ( )

inlinestatic

    {
        p_getDefault() = Dp_values();
    }

selectPoint()

DrawParams& h2d::img::DrawParams::selectPoint ( )

inline

    {
        _dpValues._enhancePoint = true;
        return *this;
    }

Here is the caller graph for this function:

setAttrString()

DrawParams& h2d::img::DrawParams::setAttrString ( std::string  attr )

inline

Add some specific SVG attributes (ignored for Opencv renderings)

See also

getAttrString()

    {
        _dpValues._attrString = attr;
        return *this;
    }

setColor() [1/2]

DrawParams& h2d::img::DrawParams::setColor ( uint8_t  r, uint8_t  g, uint8_t  b  )

inline

    {
        _dpValues._color = Color{r,g,b};
        return *this;
    }

Here is the caller graph for this function:

setColor() [2/2]

DrawParams& h2d::img::DrawParams::setColor ( Color  col )

inline

    {
        _dpValues._color = col;
        return *this;
    }

setDefault()

void h2d::img::DrawParams::setDefault ( )

inline

    {
        p_getDefault() = this->_dpValues;
    }

setFontSize()

DrawParams& h2d::img::DrawParams::setFontSize ( int  value )

inline

Set font size for drawText()

    {
        assert( value > 1 );
        _dpValues._fontSize = value;
        return *this;
    }

setPointSize()

DrawParams& h2d::img::DrawParams::setPointSize ( uint8_t  ps )

inline

    {
        if( ps%2 == 0 )
            HOMOG2D_THROW_ERROR_1( "odd number required" );
        _dpValues._pointSize = ps;
        _dpValues._ptDelta = ps;
        return *this;
    }

Here is the caller graph for this function:

setPointStyle()

DrawParams& h2d::img::DrawParams::setPointStyle ( PtStyle  ps )

inline

    {
        if( (int)ps > (int)PtStyle::Dot )
            throw std::runtime_error( "Error: invalid value for point style");
        _dpValues._ptStyle = ps;
        return *this;
    }

Here is the caller graph for this function:

setThickness()

DrawParams& h2d::img::DrawParams::setThickness ( uint8_t  t )

inline

    {
        _dpValues._lineThickness = t;
        return *this;
    }

Here is the caller graph for this function:

showAngles()

DrawParams& h2d::img::DrawParams::showAngles ( bool  b = true )

inline

Set or unset the drawing of angles of polylines.

    {
        _dpValues._showAngles = b;
        return *this;
    }

showIndex()

DrawParams& h2d::img::DrawParams::showIndex ( bool  b = true )

inline

Set or unset the drawing of points (useful only for Segment_ and Polyline_)

    {
        _dpValues._showIndex = b;
        return *this;
    }

Here is the caller graph for this function:

showPoints()

DrawParams& h2d::img::DrawParams::showPoints ( bool  b = true )

inline

Set or unset the drawing of points (useful only for Segment_ and Polyline_)

    {
        _dpValues._showPoints = b;
        return *this;
    }

Here is the caller graph for this function:

Friends And Related Function Documentation

h2d::base::LPBase

template<typename T , typename U >

friend class h2d::base::LPBase

friend

h2d::base::PolylineBase

template<typename T , typename U >

friend class h2d::base::PolylineBase

friend

h2d::base::SegVec

template<typename T , typename U >

friend class h2d::base::SegVec

friend

h2d::Circle_

template<typename T >

friend class h2d::Circle_

friend

h2d::Ellipse_

template<typename T >

friend class h2d::Ellipse_

friend

h2d::FRect_

template<typename T >

friend class h2d::FRect_

friend

operator<<

std::ostream& operator<< ( std::ostream &  f, const DrawParams &  dp  )

friend

    {
        f << "-" << dp._dpValues._color
            << "\n-line width=" << dp._dpValues._lineThickness
            << "\n-pointSize=" << dp._dpValues._pointSize
            << "\n-showPoints=" << dp._dpValues._showPoints
            << "\n-fontSize=" << dp._dpValues._fontSize
            << '\n';
        return f;
    }

Member Data Documentation

_dpValues

Dp_values h2d::img::DrawParams::_dpValues

---

The documentation for this class was generated from the following file:

• homog2d.hpp