Geometrize  1.0
An application for geometrizing images into geometric primitives
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)
 
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< ImageTaskPreferencesImpld
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImageTaskPreferences() [1/3]

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences ( )
203  : d{std::make_shared<ImageTaskPreferences::ImageTaskPreferencesImpl>()}
204 {
205 }

◆ ImageTaskPreferences() [2/3]

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences ( const std::string &  filePath)
207  : d{std::make_shared<ImageTaskPreferences::ImageTaskPreferencesImpl>(filePath)}
208 {
209 }

◆ ImageTaskPreferences() [3/3]

geometrize::preferences::ImageTaskPreferences::ImageTaskPreferences ( const ImageTaskPreferences other)
221  : d{other.d}
222 {
223 }

◆ ~ImageTaskPreferences()

geometrize::preferences::ImageTaskPreferences::~ImageTaskPreferences ( )
virtual
212 {
213 }

Member Function Documentation

◆ disableShapeTypes()

void geometrize::preferences::ImageTaskPreferences::disableShapeTypes ( geometrize::ShapeTypes  shapes)
246 {
247  d->disableShapeTypes(shapes);
248 }
Here is the caller graph for this function:

◆ enableShapeTypes()

void geometrize::preferences::ImageTaskPreferences::enableShapeTypes ( geometrize::ShapeTypes  shapes)
241 {
242  d->enableShapeTypes(shapes);
243 }
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.
236 {
237  return d->getImageRunnerOptions();
238 }
Here is the caller graph for this function:

◆ getScripts()

std::map< std::string, std::string > geometrize::preferences::ImageTaskPreferences::getScripts ( ) const
336 {
337  return d->getScripts();
338 }
Here is the caller graph for this function:

◆ isScriptModeEnabled()

bool geometrize::preferences::ImageTaskPreferences::isScriptModeEnabled ( ) const
321 {
322  return d->isScriptModeEnabled();
323 }
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
filePathThe path to the image task preferences file.
returnTrue if the image task preferences were loaded successfully, else false.
226 {
227  return d->load(filePath);
228 }
Here is the caller graph for this function:

◆ operator=()

ImageTaskPreferences & geometrize::preferences::ImageTaskPreferences::operator= ( const ImageTaskPreferences other)
216 {
217  d = other.d;
218  return *this;
219 }

◆ save()

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.
231 {
232  return d->save(filePath);
233 }
Here is the caller graph for this function:

◆ setCandidateShapeCount()

void geometrize::preferences::ImageTaskPreferences::setCandidateShapeCount ( std::uint32_t  shapeCount)
261 {
262  d->setCandidateShapeCount(shapeCount);
263 }
Here is the caller graph for this function:

◆ setMaxShapeMutations()

void geometrize::preferences::ImageTaskPreferences::setMaxShapeMutations ( std::uint32_t  maxMutations)
266 {
267  d->setMaxShapeMutations(maxMutations);
268 }
Here is the caller graph for this function:

◆ setMaxThreads()

void geometrize::preferences::ImageTaskPreferences::setMaxThreads ( std::uint32_t  maxThreads)
276 {
277  d->setMaxThreads(maxThreads);
278 }
Here is the caller graph for this function:

◆ setScript()

void geometrize::preferences::ImageTaskPreferences::setScript ( const std::string &  scriptName,
const std::string &  code 
)
326 {
327  d->setScript(scriptName, code);
328 }

◆ setScriptModeEnabled()

void geometrize::preferences::ImageTaskPreferences::setScriptModeEnabled ( bool  enabled)
316 {
317  d->setScriptModeEnabled(enabled);
318 }

◆ setScripts()

void geometrize::preferences::ImageTaskPreferences::setScripts ( const std::map< std::string, std::string > &  scripts)
331 {
332  d->setScripts(scripts);
333 }

◆ setSeed()

void geometrize::preferences::ImageTaskPreferences::setSeed ( std::uint32_t  seed)
271 {
272  d->setSeed(seed);
273 }
Here is the caller graph for this function:

◆ setShapeAlpha()

void geometrize::preferences::ImageTaskPreferences::setShapeAlpha ( std::uint8_t  alpha)
256 {
257  d->setShapeAlpha(alpha);
258 }
Here is the caller graph for this function:

◆ setShapeBounds() [1/2]

void geometrize::preferences::ImageTaskPreferences::setShapeBounds ( const geometrize::ImageRunnerShapeBoundsOptions &  shapeBounds)
281 {
282  d->setShapeBounds(shapeBounds);
283 }

◆ setShapeBounds() [2/2]

void geometrize::preferences::ImageTaskPreferences::setShapeBounds ( double  xMinPercent,
double  yMinPercent,
double  xMaxPercent,
double  yMaxPercent 
)
286 {
287  d->setShapeBounds(xMinPercent, yMinPercent, xMaxPercent, yMaxPercent);
288 }

◆ setShapeBoundsEnabled()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsEnabled ( bool  shapeBoundsEnabled)
311 {
312  d->setShapeBoundsEnabled(shapeBoundsEnabled);
313 }

◆ setShapeBoundsXMaxPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsXMaxPercent ( double  xMaxPercent)
301 {
302  d->setShapeBoundsXMaxPercent(xMaxPercent);
303 }

◆ setShapeBoundsXMinPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsXMinPercent ( double  xMinPercent)
291 {
292  d->setShapeBoundsXMinPercent(xMinPercent);
293 }

◆ setShapeBoundsYMaxPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsYMaxPercent ( double  yMaxPercent)
306 {
307  d->setShapeBoundsYMaxPercent(yMaxPercent);
308 }

◆ setShapeBoundsYMinPercent()

void geometrize::preferences::ImageTaskPreferences::setShapeBoundsYMinPercent ( double  yMinPercent)
296 {
297  d->setShapeBoundsYMinPercent(yMinPercent);
298 }

◆ setShapeTypes()

void geometrize::preferences::ImageTaskPreferences::setShapeTypes ( geometrize::ShapeTypes  shapes)
251 {
252  d->setShapeTypes(shapes);
253 }

Member Data Documentation

◆ d

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

The documentation for this class was generated from the following files:
geometrize::preferences::ImageTaskPreferences::d
std::shared_ptr< ImageTaskPreferencesImpl > d
Definition: imagetaskpreferences.h:80