KisPaintOpRegistry Class Reference

#include <kis_paintop_registry.h>

Inheritance diagram for KisPaintOpRegistry:

Public Member Functions
KisInterstrokeDataFactory *	createInterstrokeDataFactory (KisPaintOpPresetSP preset) const
KisPaintOpSettingsSP	createSettings (const KoID &id, KisResourcesInterfaceSP resourcesInterface) const
KisPaintOpPresetSP	defaultPreset (const KoID &id, KisResourcesInterfaceSP resourcesInterface) const
QIcon	icon (const KoID &id) const
	KisPaintOpRegistry ()
QList< KoID >	listKeys () const
KisPaintOp *	paintOp (const KisPaintOpPresetSP preset, KisPainter *painter, KisNodeSP node, KisImageSP image) const
	~KisPaintOpRegistry () override
Public Member Functions inherited from KoGenericRegistry< KisPaintOpFactory * >
void	add (const QString &id, KisPaintOpFactory * item)
void	add (KisPaintOpFactory * item)
void	addAlias (const QString &alias, const QString &id)
QHash< QString, KisPaintOpFactory * >::const_iterator	constBegin () const
QHash< QString, KisPaintOpFactory * >::const_iterator	constEnd () const
bool	contains (const QString &id) const
int	count () const
QList< KisPaintOpFactory * >	doubleEntries () const
KisPaintOpFactory *	get (const QString &id) const
QList< QString >	keys () const
	KoGenericRegistry ()
void	remove (const QString &id)
void	removeAlias (const QString &alias)
const KisPaintOpFactory *	value (const QString &id) const
QList< KisPaintOpFactory * >	values () const
virtual	~KoGenericRegistry ()

Static Public Member Functions
static KisPaintOpRegistry *	instance ()

Private Member Functions
void	initRegistry ()
	KisPaintOpRegistry (const KisPaintOpRegistry &)
KisPaintOpRegistry	operator= (const KisPaintOpRegistry &)
KisPaintOp *	paintOp (const QString &id, const KisPaintOpSettingsSP settings, KisPainter *painter, KisNodeSP node, KisImageSP image) const

Friends
class	KisPaintOpSettings

Detailed Description

Manages the loading and creating of all paintop plugins.

Definition at line 30 of file kis_paintop_registry.h.

Constructor & Destructor Documentation

KisPaintOpRegistry() [1/2]

KisPaintOpRegistry::KisPaintOpRegistry

(

)

Definition at line 30 of file kis_paintop_registry.cc.

{
}

~KisPaintOpRegistry()

KisPaintOpRegistry::~KisPaintOpRegistry ( )

override

Definition at line 34 of file kis_paintop_registry.cc.

{
    Q_FOREACH (const QString & id, keys()) {
        delete get(id);
    }
    dbgRegistry << "Deleting KisPaintOpRegistry";
}

References dbgRegistry, KoGenericRegistry< KisPaintOpFactory * >::get(), and KoGenericRegistry< KisPaintOpFactory * >::keys().

KisPaintOpRegistry() [2/2]

KisPaintOpRegistry::KisPaintOpRegistry ( const KisPaintOpRegistry & )

private

Member Function Documentation

createInterstrokeDataFactory()

KisInterstrokeDataFactory * KisPaintOpRegistry::createInterstrokeDataFactory

(

KisPaintOpPresetSP

preset

)

const

Definition at line 94 of file kis_paintop_registry.cc.

{
    if (preset) {
        KisPaintOpFactory* f = value(preset->paintOp().id());
        if (f) {
            return f->createInterstrokeDataFactory(preset->settings(), preset->resourcesInterface());
        }
    }
 
    return 0;
}

References KoGenericRegistry< KisPaintOpFactory * >::value().

createSettings()

KisPaintOpSettingsSP KisPaintOpRegistry::createSettings	(	const KoID &	id,
		KisResourcesInterfaceSP	resourcesInterface ) const

Create and return an (abstracted) configuration widget for using the specified paintop with the specified input device, with the specified parent as widget parent. Returns 0 if there are no settings available for the given device.

Definition at line 106 of file kis_paintop_registry.cc.

{
    KisPaintOpFactory *f = value(id.id());
    Q_ASSERT(f);
    if (f) {
        KisPaintOpSettingsSP settings = f->createSettings(resourcesInterface);
        settings->setProperty("paintop", id.id());
        return settings;
    }
    return 0;
}

References KoGenericRegistry< KisPaintOpFactory * >::value().

defaultPreset()

KisPaintOpPresetSP KisPaintOpRegistry::defaultPreset	(	const KoID &	id,
		KisResourcesInterfaceSP	resourcesInterface ) const

Returns

a default preset for the given paintop.

Definition at line 118 of file kis_paintop_registry.cc.

{
    KisPaintOpSettingsSP s = createSettings(id, resourcesInterface);
    if (s.isNull()) {
        return KisPaintOpPresetSP();
    }
 
    KisPaintOpPresetSP preset(new KisPaintOpPreset());
    preset->setName(i18n("default"));
 
    preset->setSettings(s);
    preset->setPaintOp(id);
    Q_ASSERT(!preset->paintOp().id().isEmpty());
    preset->setValid(true);
    return preset;
}

References createSettings(), and KisSharedPtr< T >::isNull().

icon()

QIcon KisPaintOpRegistry::icon

(

const KoID &

id

)

const

Definition at line 135 of file kis_paintop_registry.cc.

{
    KisPaintOpFactory* f = value(id.id());
 
    if (!f) {
        dbgRegistry << "No paintop" << id.id() << "";
        QPixmap p = QPixmap(22, 22);
        p.fill(Qt::transparent);
        return QIcon(p);
    }
 
    return f->icon();
}

References dbgRegistry, p, and KoGenericRegistry< KisPaintOpFactory * >::value().

initRegistry()

void KisPaintOpRegistry::initRegistry ( )

private

Definition at line 43 of file kis_paintop_registry.cc.

{
    KoPluginLoader::instance()->load("Krita/Paintop");
}

References KoPluginLoader::instance(), and KoPluginLoader::load().

instance()

KisPaintOpRegistry * KisPaintOpRegistry::instance ( )

static

Definition at line 48 of file kis_paintop_registry.cc.

{
    if (!s_registryInstance.exists()) {
        dbgRegistry << "initializing KisPaintOpRegistry";
        s_registryInstance->initRegistry();
    }
    return s_registryInstance;
}

References dbgRegistry, and initRegistry().

listKeys()

QList< KoID > KisPaintOpRegistry::listKeys

(

)

const

This function return a list of all the keys in KoID format by using the name() method on the objects stored in the registry.

Definition at line 149 of file kis_paintop_registry.cc.

{
    QList<KoID> answer;
    Q_FOREACH (const QString & key, keys()) {
        answer.append(KoID(key, get(key)->name()));
    }
 
    return answer;
}

References KoGenericRegistry< KisPaintOpFactory * >::get(), and KoGenericRegistry< KisPaintOpFactory * >::keys().

operator=()

KisPaintOpRegistry KisPaintOpRegistry::operator= ( const KisPaintOpRegistry & )

private

paintOp() [1/2]

KisPaintOp * KisPaintOpRegistry::paintOp	(	const KisPaintOpPresetSP	preset,
		KisPainter *	painter,
		KisNodeSP	node,
		KisImageSP	image ) const

Create and return a paintop based on the given preset. A preset defines a paintop, a settings object and possible a brush tip.

Definition at line 87 of file kis_paintop_registry.cc.

{
    if (!preset) return 0;
    if (!painter) return 0;
    return paintOp(preset->paintOp().id(), preset->settings(), painter, node, image);
}

References paintOp().

paintOp() [2/2]

KisPaintOp * KisPaintOpRegistry::paintOp ( const QString & id, const KisPaintOpSettingsSP settings, KisPainter * painter, KisNodeSP node, KisImageSP image ) const

private

Return a newly created paintop. You are responsible for deleting

Definition at line 67 of file kis_paintop_registry.cc.

{
    if (painter == 0) {
        warnKrita << " KisPaintOpRegistry::paintOp painter is null";
        return 0;
    }
 
    Q_ASSERT(settings);
 
    KisPaintOpFactory* f = value(id);
    if (f) {
        KisPaintOp * op = f->createOp(settings, painter, node, image);
        if (op) {
            return op;
        }
    }
    warnKrita << "Could not create paintop for factory" << id << "with settings" << settings;
    return 0;
}

References KoGenericRegistry< KisPaintOpFactory * >::value(), and warnKrita.

Friends And Related Symbol Documentation

KisPaintOpSettings

friend class KisPaintOpSettings

friend

Definition at line 85 of file kis_paintop_registry.h.

---

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

• libs/image/brushengine/kis_paintop_registry.h
• libs/image/brushengine/kis_paintop_registry.cc