Geometrize  1.0
An application for geometrizing images into geometric primitives
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Friends Macros
Classes | Public Member Functions | Private Attributes | List of all members
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)
 
ImageTaskPreferencesoperator= (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)
 
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

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences ( )
165  : d{std::make_shared<ImageTaskPreferences::ImageTaskPreferencesImpl>()}
166 {
167 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences ( const std::string &  filePath)
169  : d{std::make_shared<ImageTaskPreferences::ImageTaskPreferencesImpl>(filePath)}
170 {
171 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences ( const ImageTaskPreferences other)
183  : d{other.d}
184 {
185 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
geometrize::preferences::ImageTaskPreferences::~ImageTaskPreferences ( )
virtual
174 {
175 }

Member Function Documentation

void geometrize::preferences::ImageTaskPreferences::disableShapeTypes ( geometrize::ShapeTypes  shapes)
208 {
209  d->disableShapeTypes(shapes);
210 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::enableShapeTypes ( geometrize::ShapeTypes  shapes)
203 {
204  d->enableShapeTypes(shapes);
205 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

geometrize::ImageRunnerOptions geometrize::preferences::ImageTaskPreferences::getImageRunnerOptions ( ) const

getImageRunnerOptions Gets a copy of the image runner options.

Returns
The image runner options.
198 {
199  return d->getImageRunnerOptions();
200 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

std::map< std::string, std::string > geometrize::preferences::ImageTaskPreferences::getScripts ( ) const
263 {
264  return d->getScripts();
265 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

bool geometrize::preferences::ImageTaskPreferences::isScriptModeEnabled ( ) const
248 {
249  return d->isScriptModeEnabled();
250 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

bool geometrize::preferences::ImageTaskPreferences::load ( const std::string &  filePath)

load Loads the image task preferences from a file.

Parameters
filePathThe path to the image task preferences file.
returnTrue if the image task preferences were loaded successfully, else false.
188 {
189  return d->load(filePath);
190 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

ImageTaskPreferences & geometrize::preferences::ImageTaskPreferences::operator= ( const ImageTaskPreferences other)
178 {
179  d = other.d;
180  return *this;
181 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
bool geometrize::preferences::ImageTaskPreferences::save ( const std::string &  filePath)

save Saves the image task preferences to a file.

Parameters
filePathThe path to the image task preferences file.
returnTrue if the image task preferences were saved successfully, else false.
193 {
194  return d->save(filePath);
195 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::setCandidateShapeCount ( std::uint32_t  shapeCount)
223 {
224  d->setCandidateShapeCount(shapeCount);
225 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::setMaxShapeMutations ( std::uint32_t  maxMutations)
228 {
229  d->setMaxShapeMutations(maxMutations);
230 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::setMaxThreads ( std::uint32_t  maxThreads)
238 {
239  d->setMaxThreads(maxThreads);
240 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::setScript ( const std::string &  scriptName,
const std::string &  code 
)
253 {
254  d->setScript(scriptName, code);
255 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
void geometrize::preferences::ImageTaskPreferences::setScriptModeEnabled ( bool  enabled)
243 {
244  d->setScriptModeEnabled(enabled);
245 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
void geometrize::preferences::ImageTaskPreferences::setScripts ( const std::map< std::string, std::string > &  scripts)
258 {
259  d->setScripts(scripts);
260 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73
void geometrize::preferences::ImageTaskPreferences::setSeed ( std::uint32_t  seed)
233 {
234  d->setSeed(seed);
235 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::setShapeAlpha ( std::uint8_t  alpha)
218 {
219  d->setShapeAlpha(alpha);
220 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Here is the caller graph for this function:

void geometrize::preferences::ImageTaskPreferences::setShapeTypes ( geometrize::ShapeTypes  shapes)
213 {
214  d->setShapeTypes(shapes);
215 }
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:73

Member Data Documentation

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

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