palapeli/libpala
#include <Pala/SlicerPropertySet>
Public Member Functions | |
Pala::Slicer * | slicer () const |
Protected Member Functions | |
SlicerPropertySet (Pala::Slicer *slicer) | |
~SlicerPropertySet () | |
void | addPropertyToSlicer (const QByteArray &key, Pala::SlicerProperty *property) |
Detailed Description
Representation of a set of configurable parameters of a slicing algorithm.
In many slicers, you can find common patterns of configuration parameters. For example, many slicers divide the image into X times Y pieces, where X is some configurable "piece count in horizontal direction", and Y is some configurable "piece count in vertical direction".
Such common property sets can be represented by a Pala::SlicerPropertySet subclass. For example, you can add the Pala::SimpleGridPropertySet to your Pala::Slicer subclass to get a set of properties that is useful for slicers that follow the "X times Y pieces" pattern. The recommended way to use property sets is to derive your Pala::Slicer subclass from them (using multiple inheritance; you can safely mix multiple Pala::SlicerPropertySet subclasses into one Pala::Slicer subclass).
A property set is fully self-contained: It adds some properties to your slicer which remain totally invisible to your own implementation. You should always use the methods provided by the property set to read its properties, because the internal representation of the property set might change over time (esp. for those property sets that come with libpala).
- Note
- This is an abstract base class. Use the subclasses provided by this library. Defining own subclasses outside libpala is a good idea if you want to logically separate the configurable parameters of your slicer from the slicing algorithm itself.
Definition at line 49 of file slicerpropertyset.h.
Constructor & Destructor Documentation
|
protected |
Definition at line 41 of file slicerpropertyset.cpp.
|
protected |
Definition at line 47 of file slicerpropertyset.cpp.
Member Function Documentation
|
protected |
A synonym for Pala::Slicer::addProperty (because the latter is "protected"; this abstract base class can access it because it is a "protected friend" of Pala::Slicer).
Definition at line 57 of file slicerpropertyset.cpp.
Pala::Slicer * Pala::SlicerPropertySet::slicer | ( | ) | const |
Definition at line 52 of file slicerpropertyset.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.