#include <Filter.h>

Inheritance diagram for Filter:

Public Slots
bool	apply (Node *node, int x, int y, int w, int h)

InfoObject *	configuration () const

QString	name () const

void	setConfiguration (InfoObject *value)

void	setName (const QString &name)

bool	startFilter (Node *node, int x, int y, int w, int h)

Public Member Functions
	Filter ()

bool	operator!= (const Filter &other) const

bool	operator== (const Filter &other) const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Filter: represents a filter and its configuration.

A filter is identified by an internal name. The configuration for each filter is defined as an InfoObject: a map of name and value pairs.

Currently available filters are:

'autocontrast', 'blur', 'bottom edge detections', 'brightnesscontrast', 'burn', 'colorbalance', 'colortoalpha', 'colortransfer', 'desaturate', 'dodge', 'emboss', 'emboss all directions', 'emboss horizontal and vertical', 'emboss horizontal only', 'emboss laplascian', 'emboss vertical only', 'gaussian blur', 'gaussiannoisereducer', 'gradientmap', 'halftone', 'hsvadjustment', 'indexcolors', 'invert', 'left edge detections', 'lens blur', 'levels', 'maximize', 'mean removal', 'minimize', 'motion blur', 'noise', 'normalize', 'oilpaint', 'perchannel', 'phongbumpmap', 'pixelize', 'posterize', 'raindrops', 'randompick', 'right edge detections', 'roundcorners', 'sharpen', 'smalltiles', 'sobel', 'threshold', 'top edge detections', 'unsharp', 'wave', 'waveletnoisereducer']

Definition at line 30 of file Filter.h.

Constructor & Destructor Documentation

◆ Filter()

Filter::Filter ( )

explicit

Filter: create an empty filter object.

Until a name is set, the filter cannot be applied.

Definition at line 37 of file Filter.cpp.

◆ ~Filter()

Filter::~Filter ( )

override

Definition at line 43 of file Filter.cpp.

Member Function Documentation

◆ apply

bool Filter::apply	(	Node *	node,
		int	x,
		int	y,
		int	w,
		int	h )

slot

Apply the filter to the given node.

Parameters

node	the node to apply the filter to
x
y
w
h	describe the rectangle the filter should be apply. This is always in image pixel coordinates and not relative to the x, y of the node.

Returns: true if the filter was applied successfully, or false if the filter could not be applied because the node is locked or does not have an editable paint device.

Definition at line 85 of file Filter.cpp.

◆ configuration

InfoObject * Filter::configuration ( ) const

slot

Returns: the configuration object for the filter

Definition at line 75 of file Filter.cpp.

◆ name

QString Filter::name ( ) const

slot

name the internal name of this filter.

Returns: the name.

Definition at line 61 of file Filter.cpp.

◆ operator!=()

bool Filter::operator!= ( const Filter & other ) const

Definition at line 55 of file Filter.cpp.

◆ operator==()

bool Filter::operator== ( const Filter & other ) const

Definition at line 49 of file Filter.cpp.

◆ setConfiguration

void Filter::setConfiguration ( InfoObject * value )

slot

setConfiguration set the configuration object for the filter

Definition at line 80 of file Filter.cpp.

◆ setName

void Filter::setName ( const QString & name )

slot

setName set the filter's name to the given name.

Definition at line 66 of file Filter.cpp.

◆ startFilter

bool Filter::startFilter	(	Node *	node,
		int	x,
		int	y,
		int	w,
		int	h )

slot

startFilter starts the given filter on the given node.

Parameters

node	the node to apply the filter to
x
y
w
h	describe the rectangle the filter should be apply. This is always in image pixel coordinates and not relative to the x, y of the node.

Definition at line 101 of file Filter.cpp.

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

Class Picker

Quick Links

About Krita

Filter

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Filter()

◆ ~Filter()

Member Function Documentation

◆ apply

◆ configuration

◆ name

◆ operator!=()

◆ operator==()

◆ setConfiguration

◆ setName

◆ startFilter