Identiconpp Class Reference

Base class for identiconpp. More...

#include <identiconpp.hpp>

Public Types
enum	algorithm { algorithm::ltr_symmetric, algorithm::ltr_asymmetric, algorithm::sigil }
	List of identicon algorithms. More...

Public Member Functions
	Identiconpp (const uint8_t columns, const uint8_t rows, algorithm type=algorithm::ltr_symmetric, const string &background="ffffffff", const vector< string > &foreground={ "000000ff" }, const array< uint8_t, 2 > &padding={ 0, 0 })
	Initialises an instance of Identiconpp. More...
Magick::Image	generate (const string &digest, const uint16_t width=100)
	Generates identicon from digest. More...
const string	generate_base64 (const string &magick, const string &digest, const uint16_t width=100)
	Generates identicon from digest. More...

Friends
class	Testiconpp

Detailed Description

Base class for identiconpp.

Use this class for all your identicons. Exceptions will be thrown on error.

Examples:

example.cpp.

Member Enumeration Documentation

algorithm

enum Identiconpp::algorithm

strong

List of identicon algorithms.

Enumerator
ltr_symmetric	Generates symmetric (vertically mirrored) identicons.
ltr_asymmetric	Generates asymmetric identicons.
sigil	Generates the same results as sigil and pydenticon.

    {
        ltr_symmetric,
        ltr_asymmetric,
        sigil
    };

Constructor & Destructor Documentation

Identiconpp()

Identiconpp::Identiconpp ( const uint8_t  columns, const uint8_t  rows, algorithm  type = algorithm::ltr_symmetric, const string &  background = "ffffffff", const vector< string > &  foreground = { "000000ff" }, const array< uint8_t, 2 > &  padding = { 0, 0 }  )

explicit

Initialises an instance of Identiconpp.

The instance can be used for creating identicons with differing image formats and sizes. The colors must consist of exactly 8 digits.

Parameters

columns	Number of columns
rows	Number of rows
type	The algorithm to use
background	Background color, hexadecimal, rrggbbaa
foreground	vector of foreground colors
padding	Padding in pixels { left & right, top & down }

Since

before 0.5.0

: _rows(rows)
, _columns(columns)
, _type(type)
, _background(background)
, _foreground(foreground)
, _padding(padding)
{
    check_color(_background);

    for (const string &color : _foreground)
    {
        check_color(color);
    }

    if (_foreground.size() == 0)
    {
        throw std::invalid_argument
        (
            "You must specify at least 1 foreground color."
         );
    }
}

Member Function Documentation

generate()

Magick::Image Identiconpp::generate	(	const string &	digest,
		const uint16_t	width = 100
	)

Generates identicon from digest.

Parameters

digest	The pre-computed digest
width	The width of the image in pixels

Returns

The image as Magick::Image

Since

before 0.5.0

Examples:

example.cpp.

{
    ttdebug << "Using digest: " << digest << '\n';
    check_entropy(digest, _type);
    const std::int16_t imgwidth = width - _padding[0] * 2;
    const std::int16_t imgheight =
        std::round(static_cast<float>(imgwidth) / _columns * _rows);
    ttdebug << "width: " << std::to_string(imgwidth)
            <<  "+" <<  std::to_string(_padding[0] * 2)
            << ", height: " << std::to_string(imgheight)
            <<  "+" <<  std::to_string(_padding[1] * 2)
            << "\n";
    if (imgwidth <= 0 || imgheight <= 0)
    {
        throw std::invalid_argument("Width or height is zero or less.");
    }
    Magick::Image img;

    switch (_type)
    {
        case algorithm::ltr_symmetric:
        {
            img = generate_ltr_symmetric(digest);
            break;
        }
        case algorithm::ltr_asymmetric:
        {
            img = generate_ltr_asymmetric(digest);
            break;
        }
        case algorithm::sigil:
        {
            img = generate_sigil(digest);
            break;
        }
    }

    img.scale(Magick::Geometry(imgwidth, imgheight));
    // The CompositeOperator prevents the background color to be affected by the
    // frame color. See https://github.com/ImageMagick/ImageMagick/issues/647
    img.compose(Magick::CompositeOperator::CopyCompositeOp);
    img.matteColor(Magick::Color('#' + _background));
    img.frame(Magick::Geometry(_padding[0], _padding[1]));
    return img;
}

generate_base64()

const string Identiconpp::generate_base64	(	const string &	magick,
		const string &	digest,
		const uint16_t	width = 100
	)

Generates identicon from digest.

Parameters

magick	See http://imagemagick.org/script/formats.php
digest	The pre-computed digest
width	The width of the image in pixels

Returns

The image as base64-string

Since

0.5.0

{
    Magick::Image img = generate(digest, width);
    Magick::Blob blob;
    img.magick(magick);
    img.write(&blob);
    return blob.base64();
}

---

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

• src/identiconpp.hpp
• src/checks.cpp
• src/identiconpp.cpp
• src/ltr_asymmetric.cpp
• src/ltr_symmetric.cpp
• src/sigil.cpp