h2d::img Namespace Reference

Holds drawing related code, independent of back-end library. More...

Classes
struct	Color
	Color type , see DrawParams. More...
class	DrawParams
	Draw parameters, independent of back-end library. More...
class	Image
	Opaque data structure, will hold the image type, depending on back-end library. This type is the one used in all the drawing functions. More...
struct	SvgImage
	A svg image as a wrapper around a string, see manual, "Drawing things" section. More...

Enumerations
enum	PtStyle : uint8_t {   PtStyle::Plus, PtStyle::Times, PtStyle::Star, PtStyle::Diam,   PtStyle::Squ, PtStyle::Dot }
	Point drawing style, see DrawParams. More...

Functions
std::vector< img::Color >	genRandomColors (size_t nb, int minval=20, int maxval=250)
	Helper function, will generate a vector of nb random RGB colors. More...
const char *	getString (PtStyle t)
std::ostream &	operator<< (std::ostream &f, const Image< SvgImage > &im)
	Streaming operator (only defined for SVG) More...

Detailed Description

Holds drawing related code, independent of back-end library.

Enumeration Type Documentation

PtStyle

enum h2d::img::PtStyle : uint8_t

strong

Point drawing style, see DrawParams.

Demo: https://github.com/skramm/homog2d/blob/master/docs/homog2d_manual.md#drawing_params

Warning

Check nextPointStyle() in case of added values here!

Enumerator
Plus	+ symbol
Times	X symbol
Star	* symbol
Diam	diamond
Squ	square (new 20241101 !)
Dot	dot (circle)

                  : uint8_t
{
    Plus,   
    Times,  
    Star,   
    Diam,   
    Squ,    
    Dot     
};

Function Documentation

genRandomColors()

std::vector<img::Color> h2d::img::genRandomColors ( size_t  nb, int  minval = 20, int  maxval = 250  )

inline

Helper function, will generate a vector of nb random RGB colors.

• RGB values will be between minval and minval+coeff

{
    if( maxval<=minval )
        HOMOG2D_THROW_ERROR_1( "Illegal values for minval and maxval" );
    std::vector<img::Color> vcol( nb );
    std::srand( std::time(nullptr) );

    for( size_t i=0; i<nb; i++ )
    {
        auto colR = 1.0*std::rand() / RAND_MAX * (maxval-minval) + minval;
        auto colG = 1.0*std::rand() / RAND_MAX * (maxval-minval) + minval;
        auto colB = 1.0*std::rand() / RAND_MAX * (maxval-minval) + minval;
        vcol[i] = img::Color(colR,colG,colB);
    }
    return vcol;
}

Here is the caller graph for this function:

getString()

const char* h2d::img::getString ( PtStyle  t )

inline

{
    const char* s=0;
    switch( t )
    {
        case PtStyle::Plus:  s="Plus";  break;
        case PtStyle::Times: s="Times"; break;
        case PtStyle::Star:  s="Star";  break;
        case PtStyle::Diam:  s="Diam";  break;
        case PtStyle::Squ:   s="Square";break;
        case PtStyle::Dot:   s="Dot";   break; // WARNING: keep this as last one (assumed to be last one in some code)
        default: assert(0);
    }
    return s;
}

Here is the caller graph for this function:

operator<<()

std::ostream& h2d::img::operator<< ( std::ostream &  f, const Image< SvgImage > &  im  )

inline

Streaming operator (only defined for SVG)

{
    f << "<svg version=\"1.1\" width=\"" << im._width
        << "\" height=\"" << im._height
        << "\" style=\"background-color:white;\" xmlns=\"http://www.w3.org/2000/svg\">\n"
        << "<style>\n"
        << ".txt1 { font: bold 12px sans-serif; };\n"   // text style, you can change or add classes as required
        << "</style>\n";

    f << im._realImg._svgString.str();
    f << "</svg>\n";

    return f;
}