geometrize::preferences::ImageTaskPreferences Class Reference

The ImageTaskPreferences class models the preferences associated with an image task. More...

#include <imagetaskpreferences.h>

Classes
class	ImageTaskPreferencesImpl

Public Member Functions
	ImageTaskPreferences ()
	ImageTaskPreferences (const std::string &filePath)
ImageTaskPreferences &	operator= (const ImageTaskPreferences &other)
	ImageTaskPreferences (const ImageTaskPreferences &other)
virtual	~ImageTaskPreferences ()
bool	load (const std::string &filePath)
	load Loads the image task preferences from a file. More...
bool	save (const std::string &filePath)
	save Saves the image task preferences to a file. More...
geometrize::ImageRunnerOptions	getImageRunnerOptions () const
	getImageRunnerOptions Gets a copy of the image runner options. More...
void	enableShapeTypes (geometrize::ShapeTypes shapes)
void	disableShapeTypes (geometrize::ShapeTypes shapes)
void	setShapeTypes (geometrize::ShapeTypes shapes)
void	setShapeAlpha (std::uint8_t alpha)
void	setCandidateShapeCount (std::uint32_t shapeCount)
void	setMaxShapeMutations (std::uint32_t maxMutations)
void	setSeed (std::uint32_t seed)
void	setMaxThreads (std::uint32_t maxThreads)
void	setShapeBounds (const geometrize::ImageRunnerShapeBoundsOptions &shapeBounds)
void	setShapeBounds (double xMinPercent, double yMinPercent, double xMaxPercent, double yMaxPercent)
void	setShapeBoundsXMinPercent (double xMinPercent)
void	setShapeBoundsYMinPercent (double yMinPercent)
void	setShapeBoundsXMaxPercent (double xMaxPercent)
void	setShapeBoundsYMaxPercent (double yMaxPercent)
void	setShapeBoundsEnabled (bool shapeBoundsEnabled)
bool	isScriptModeEnabled () const
void	setScriptModeEnabled (bool enabled)
void	setScript (const std::string &scriptName, const std::string &code)
void	setScripts (const std::map< std::string, std::string > &scripts)
std::map< std::string, std::string >	getScripts () const

Private Attributes
std::shared_ptr< ImageTaskPreferencesImpl >	d

Detailed Description

The ImageTaskPreferences class models the preferences associated with an image task.

Constructor & Destructor Documentation

ImageTaskPreferences() [1/3]

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences

(

)

                                           : d{std::make_shared<ImageTaskPreferences::ImageTaskPreferencesImpl>()}
{
}

ImageTaskPreferences() [2/3]

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences

(

const std::string &

filePath

)

                                                                    : d{std::make_shared<ImageTaskPreferences::ImageTaskPreferencesImpl>(filePath)}
{
}

ImageTaskPreferences() [3/3]

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences

(

const ImageTaskPreferences &

other

)

                                                                            : d{other.d}
{
}

~ImageTaskPreferences()

geometrize::preferences::ImageTaskPreferences::~ImageTaskPreferences ( )

virtual

{
}

Member Function Documentation

disableShapeTypes()

void geometrize::preferences::ImageTaskPreferences::disableShapeTypes

(

geometrize::ShapeTypes

shapes

)

{
    d->disableShapeTypes(shapes);
}

Here is the caller graph for this function:

enableShapeTypes()

void geometrize::preferences::ImageTaskPreferences::enableShapeTypes

(

geometrize::ShapeTypes

shapes

)

{
    d->enableShapeTypes(shapes);
}

Here is the caller graph for this function:

getImageRunnerOptions()

geometrize::ImageRunnerOptions geometrize::preferences::ImageTaskPreferences::getImageRunnerOptions

(

)

const

getImageRunnerOptions Gets a copy of the image runner options.

Returns

The image runner options.

{
    return d->getImageRunnerOptions();
}

Here is the caller graph for this function:

getScripts()

std::map< std::string, std::string > geometrize::preferences::ImageTaskPreferences::getScripts

(

)

const

{
    return d->getScripts();
}

Here is the caller graph for this function:

isScriptModeEnabled()

bool geometrize::preferences::ImageTaskPreferences::isScriptModeEnabled

(

)

const

{
    return d->isScriptModeEnabled();
}

Here is the caller graph for this function:

load()

bool geometrize::preferences::ImageTaskPreferences::load

(

const std::string &

filePath

)

load Loads the image task preferences from a file.

Parameters

filePath	The path to the image task preferences file.
return	True if the image task preferences were loaded successfully, else false.

{
    return d->load(filePath);
}

Here is the caller graph for this function:

operator=()

ImageTaskPreferences & geometrize::preferences::ImageTaskPreferences::operator=

(

const ImageTaskPreferences &

other

)

{
    d = other.d;
    return *this;
}

save()

bool geometrize::preferences::ImageTaskPreferences::save

(

const std::string &

filePath

)

save Saves the image task preferences to a file.

Parameters

filePath	The path to the image task preferences file.
return	True if the image task preferences were saved successfully, else false.

{
    return d->save(filePath);
}

Here is the caller graph for this function:

setCandidateShapeCount()

void geometrize::preferences::ImageTaskPreferences::setCandidateShapeCount

(

std::uint32_t

shapeCount

)

{
    d->setCandidateShapeCount(shapeCount);
}

Here is the caller graph for this function:

setMaxShapeMutations()

void geometrize::preferences::ImageTaskPreferences::setMaxShapeMutations

(

std::uint32_t

maxMutations

)

{
    d->setMaxShapeMutations(maxMutations);
}

Here is the caller graph for this function:

setMaxThreads()

void geometrize::preferences::ImageTaskPreferences::setMaxThreads

(

std::uint32_t

maxThreads

)

{
    d->setMaxThreads(maxThreads);
}

Here is the caller graph for this function:

setScript()

void geometrize::preferences::ImageTaskPreferences::setScript	(	const std::string &	scriptName,
		const std::string &	code
	)

{
    d->setScript(scriptName, code);
}

setScriptModeEnabled()

void geometrize::preferences::ImageTaskPreferences::setScriptModeEnabled

(

bool

enabled

)

{
    d->setScriptModeEnabled(enabled);
}

setScripts()

void geometrize::preferences::ImageTaskPreferences::setScripts

(

const std::map< std::string, std::string > &

scripts

)

{
    d->setScripts(scripts);
}

setSeed()

void geometrize::preferences::ImageTaskPreferences::setSeed

(

std::uint32_t

seed

)

{
    d->setSeed(seed);
}

Here is the caller graph for this function:

setShapeAlpha()

void geometrize::preferences::ImageTaskPreferences::setShapeAlpha

(

std::uint8_t

alpha

)

{
    d->setShapeAlpha(alpha);
}

Here is the caller graph for this function:

setShapeBounds() [1/2]

void geometrize::preferences::ImageTaskPreferences::setShapeBounds

(

const geometrize::ImageRunnerShapeBoundsOptions &

shapeBounds

)

{
    d->setShapeBounds(shapeBounds);
}

setShapeBounds() [2/2]

void geometrize::preferences::ImageTaskPreferences::setShapeBounds	(	double	xMinPercent,
		double	yMinPercent,
		double	xMaxPercent,
		double	yMaxPercent
	)

{
    d->setShapeBounds(xMinPercent, yMinPercent, xMaxPercent, yMaxPercent);
}

setShapeBoundsEnabled()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsEnabled

(

bool

shapeBoundsEnabled

)

{
    d->setShapeBoundsEnabled(shapeBoundsEnabled);
}

setShapeBoundsXMaxPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsXMaxPercent

(

double

xMaxPercent

)

{
    d->setShapeBoundsXMaxPercent(xMaxPercent);
}

setShapeBoundsXMinPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsXMinPercent

(

double

xMinPercent

)

{
    d->setShapeBoundsXMinPercent(xMinPercent);
}

setShapeBoundsYMaxPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsYMaxPercent

(

double

yMaxPercent

)

{
    d->setShapeBoundsYMaxPercent(yMaxPercent);
}

setShapeBoundsYMinPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsYMinPercent

(

double

yMinPercent

)

{
    d->setShapeBoundsYMinPercent(yMinPercent);
}

setShapeTypes()

void geometrize::preferences::ImageTaskPreferences::setShapeTypes

(

geometrize::ShapeTypes

shapes

)

{
    d->setShapeTypes(shapes);
}

Member Data Documentation

d

std::shared_ptr<ImageTaskPreferencesImpl> geometrize::preferences::ImageTaskPreferences::d

private

---

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

• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/preferences/imagetaskpreferences.h
• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/preferences/imagetaskpreferences.cpp