geometrize::ImageRunner Class Reference

The ImageRunner class is a helper class for creating a set of primitives from a source image. More...

#include <imagerunner.h>

Classes
class	ImageRunnerImpl

Public Member Functions
	ImageRunner (const geometrize::Bitmap &targetBitmap)
	ImageRunner Creates an new image runner with the given target bitmap. Uses the average color of the target as the starting image. More...
	ImageRunner (const geometrize::Bitmap &targetBitmap, const geometrize::Bitmap &initialBitmap)
	ImageRunner Creates an image runner with the given target bitmap, starting from the given initial bitmap. The target bitmap and initial bitmap must be the same size (width and height). More...
	~ImageRunner ()
ImageRunner &	operator= (const ImageRunner &)=delete
	ImageRunner (const ImageRunner &)=delete
std::vector< geometrize::ShapeResult >	step (const geometrize::ImageRunnerOptions &options, std::function< std::shared_ptr< geometrize::Shape >()> shapeCreator=nullptr, geometrize::core::EnergyFunction energyFunction=nullptr, geometrize::ShapeAcceptancePreconditionFunction addShapePrecondition=nullptr)
	step Updates the internal model once. More...
geometrize::Bitmap &	getCurrent ()
	getCurrent Gets the current bitmap with the primitives drawn on it. More...
geometrize::Bitmap &	getTarget ()
	getTarget Gets the target bitmap. More...
const geometrize::Bitmap &	getCurrent () const
	getCurrent Gets the current bitmap with the primitives drawn on it, const-edition. More...
const geometrize::Bitmap &	getTarget () const
	getTarget Gets the target bitmap, const-edition. More...
geometrize::Model &	getModel ()
	getModel Gets the underlying model. More...

Private Attributes
std::unique_ptr< ImageRunner::ImageRunnerImpl >	d

Detailed Description

The ImageRunner class is a helper class for creating a set of primitives from a source image.

Author

Sam Twidale (https://samcodes.co.uk/)

Constructor & Destructor Documentation

ImageRunner() [1/3]

geometrize::ImageRunner::ImageRunner

(

const geometrize::Bitmap &

targetBitmap

)

ImageRunner Creates an new image runner with the given target bitmap. Uses the average color of the target as the starting image.

Parameters

targetBitmap

The target bitmap to replicate with shapes.

                                                             :
    d{std::unique_ptr<ImageRunner::ImageRunnerImpl>(new ImageRunner::ImageRunnerImpl(targetBitmap))}
{}

ImageRunner() [2/3]

geometrize::ImageRunner::ImageRunner	(	const geometrize::Bitmap &	targetBitmap,
		const geometrize::Bitmap &	initialBitmap
	)

ImageRunner Creates an image runner with the given target bitmap, starting from the given initial bitmap. The target bitmap and initial bitmap must be the same size (width and height).

Parameters

targetBitmap	The target bitmap to replicate with shapes.
initialBitmap	The starting bitmap.

                                                                                                     :
    d{std::unique_ptr<ImageRunner::ImageRunnerImpl>(new ImageRunner::ImageRunnerImpl(targetBitmap, initialBitmap))}
{}

~ImageRunner()

geometrize::ImageRunner::~ImageRunner

(

)

{}

ImageRunner() [3/3]

geometrize::ImageRunner::ImageRunner ( const ImageRunner &  )

delete

Member Function Documentation

getCurrent() [1/2]

geometrize::Bitmap & geometrize::ImageRunner::getCurrent

(

)

getCurrent Gets the current bitmap with the primitives drawn on it.

Returns

The current bitmap.

{
    return d->getCurrent();
}

getCurrent() [2/2]

const geometrize::Bitmap & geometrize::ImageRunner::getCurrent

(

)

const

getCurrent Gets the current bitmap with the primitives drawn on it, const-edition.

Returns

The current bitmap.

{
    return d->getCurrent();
}

getModel()

geometrize::Model & geometrize::ImageRunner::getModel

(

)

getModel Gets the underlying model.

Returns

The model.

{
    return d->getModel();
}

getTarget() [1/2]

geometrize::Bitmap & geometrize::ImageRunner::getTarget

(

)

getTarget Gets the target bitmap.

Returns

The target bitmap.

{
    return d->getTarget();
}

getTarget() [2/2]

const geometrize::Bitmap & geometrize::ImageRunner::getTarget

(

)

const

getTarget Gets the target bitmap, const-edition.

Returns

The target bitmap.

{
    return d->getTarget();
}

operator=()

ImageRunner & geometrize::ImageRunner::operator= ( const ImageRunner &  )

delete

step()

std::vector< geometrize::ShapeResult > geometrize::ImageRunner::step	(	const geometrize::ImageRunnerOptions &	options,
		std::function< std::shared_ptr< geometrize::Shape >()>	shapeCreator = nullptr,
		geometrize::core::EnergyFunction	energyFunction = nullptr,
		geometrize::ShapeAcceptancePreconditionFunction	addShapePrecondition = nullptr
	)

step Updates the internal model once.

Parameters

options	Various configurable settings for doing the step e.g. the shape types to consider.
shapeCreator	An optional function for creating and mutating shapes
energyFunction	An optional function to calculate the energy (if unspecified a default implementation is used).
addShapePrecondition	An optional function to determine whether to accept a shape (if unspecified a default implementation is used).

Returns

A vector containing data about the shapes just added to the internal model.

{
    return d->step(options, shapeCreator, energyFunction, addShapePrecondition);
}

Member Data Documentation

d

std::unique_ptr<ImageRunner::ImageRunnerImpl> geometrize::ImageRunner::d

private

---

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

• /home/appveyor/projects/geometrize-lib-docs/geometrize-lib/geometrize/geometrize/runner/imagerunner.h
• /home/appveyor/projects/geometrize-lib-docs/geometrize-lib/geometrize/geometrize/runner/imagerunner.cpp