#include <kis_filter.h>
Basic interface of a Chalk filter.
Definition at line 46 of file kis_filter.h.
◆ KisFilter()
| KisFilter::KisFilter |
( |
const KisID & | id, |
|
|
const TQString & | category, |
|
|
const TQString & | entry ) |
◆ ~KisFilter()
| virtual KisFilter::~KisFilter |
( |
| ) |
|
|
inlinevirtual |
◆ autoUpdate()
| bool KisFilter::autoUpdate |
( |
| ) |
|
◆ cancel()
| virtual void KisFilter::cancel |
( |
| ) |
|
|
inlinevirtual |
◆ cancelRequested()
| bool KisFilter::cancelRequested |
( |
| ) |
const |
|
inline |
◆ colorSpaceIndependence()
| virtual ColorSpaceIndependence KisFilter::colorSpaceIndependence |
( |
| ) |
|
|
inlinevirtual |
Determine the colorspace independence of this filter.
- See also
- ColorSpaceIndependence
- Returns
- the degree of independence
Definition at line 130 of file kis_filter.h.
◆ configuration() [1/2]
- Returns
- a default configuration object Normally this doesn't need to be overriden
Definition at line 39 of file kis_filter.cpp.
◆ configuration() [2/2]
- Returns
- a new configuration derived from the widget. If the widget is NULL or not the correct type, a default configuration object will be returned
Definition at line 34 of file kis_filter.cpp.
◆ createConfigurationWidget()
Create the configuration widget for this filter.
@param parent the TQt owner widget of this widget
@param dev the paintdevice this filter will act on
* - Returns
- NULL if the filter does not use user-settable configuration settings. * else return a pointer to the new configuration widget
Definition at line 44 of file kis_filter.cpp.
◆ disableProgress()
| void KisFilter::disableProgress |
( |
| ) |
|
|
virtual |
◆ enableProgress()
| void KisFilter::enableProgress |
( |
| ) |
|
|
virtual |
◆ enlargeRect()
Similar to overlapMarginNeeded: some filters will alter a lot of pixels that are near to each other at the same time.
So when you changed a single rectangle in a device, the actual rectangle that will feel the influence of this change might be bigger. Use this function to detirmine that rect. The default implementation makes a guess using overlapMarginNeeded.
Definition at line 124 of file kis_filter.cpp.
◆ id()
| const KisID KisFilter::id |
( |
| ) |
const |
|
inline |
◆ incProgress
| void KisFilter::incProgress |
( |
| ) |
|
|
protectedslot |
◆ listOfExamplesConfiguration()
Return a list of default configuration to demonstrates the use of the filter.
- Returns
- a list with a null element if the filter do not use a configuration
Definition at line 92 of file kis_filter.h.
◆ menuCategory()
| TQString KisFilter::menuCategory |
( |
| ) |
const |
|
inline |
◆ menuEntry()
| TQString KisFilter::menuEntry |
( |
| ) |
const |
|
inline |
◆ overlapMarginNeeded()
Used when threading is used – the overlap margin is passed to the filter to use to compute pixels, but the margin is not pasted into the resulting image.
Definition at line 113 of file kis_filter.h.
◆ progress
| TQ_INT32 KisFilter::progress |
( |
| ) |
|
|
inlineprotectedslot |
◆ progressEnabled()
| bool KisFilter::progressEnabled |
( |
| ) |
const |
|
inline |
◆ setAutoUpdate()
| void KisFilter::setAutoUpdate |
( |
bool | set | ) |
|
|
virtual |
◆ setProgress
| void KisFilter::setProgress |
( |
TQ_INT32 | progress | ) |
|
|
protectedslot |
◆ setProgressDisplay()
| void KisFilter::setProgressDisplay |
( |
KisProgressDisplayInterface * | progressDisplay | ) |
|
|
virtual |
◆ setProgressDone
| void KisFilter::setProgressDone |
( |
| ) |
|
|
protectedslot |
◆ setProgressStage
| void KisFilter::setProgressStage |
( |
const TQString & | stage, |
|
|
TQ_INT32 | progress ) |
|
protectedslot |
◆ setProgressTotalSteps
| void KisFilter::setProgressTotalSteps |
( |
TQ_INT32 | totalSteps | ) |
|
|
protectedslot |
◆ supportsAdjustmentLayers()
| virtual bool KisFilter::supportsAdjustmentLayers |
( |
| ) |
|
|
inlinevirtual |
This filter can be used in adjustment layers.
Definition at line 86 of file kis_filter.h.
◆ supportsIncrementalPainting()
| virtual bool KisFilter::supportsIncrementalPainting |
( |
| ) |
|
|
inlinevirtual |
Can this filter work incrementally when painting, or do we need to work on the state as it was before painting started.
The former is faster.
Definition at line 99 of file kis_filter.h.
◆ supportsPainting()
| virtual bool KisFilter::supportsPainting |
( |
| ) |
|
|
inlinevirtual |
If true, this filter can be used in painting tools as a paint operation.
Definition at line 79 of file kis_filter.h.
◆ supportsPreview()
| virtual bool KisFilter::supportsPreview |
( |
| ) |
|
|
inlinevirtual |
This filter can be displayed in a preview dialog.
Definition at line 82 of file kis_filter.h.
◆ supportsThreading()
| virtual bool KisFilter::supportsThreading |
( |
| ) |
|
|
inlinevirtual |
This filter supports cutting up the work area and filtering each chunk in a separate thread.
Filters that need access to the whole area for correct computations should return false.
Definition at line 106 of file kis_filter.h.
◆ workWith()
Determine if this filter can work with this colorSpace.
For instance, some colorspaces don't depend on lcms, and cannot do certain tasks. The colorsfilters are problems here. BSAR: I'm still not convinced that this is the right approach. I think that every colorspace should implement the api fully; and that the filter should simply call that api. After all, you don't need lcms to desaturate.
- Parameters
-
Definition at line 142 of file kis_filter.h.
◆ m_category
| TQString KisFilter::m_category |
|
protected |
◆ m_entry
| TQString KisFilter::m_entry |
|
protected |
◆ m_id
◆ m_lastProgressPerCent
| TQ_INT32 KisFilter::m_lastProgressPerCent |
|
protected |
◆ m_progressDisplay
| KisProgressDisplayInterface* KisFilter::m_progressDisplay |
|
protected |
◆ m_progressSteps
| TQ_INT32 KisFilter::m_progressSteps |
|
protected |
◆ m_progressTotalSteps
| TQ_INT32 KisFilter::m_progressTotalSteps |
|
protected |
The documentation for this class was generated from the following files:
|
