KisBrushOptionProperties Class Reference

#include <kis_brush_option.h>

Inheritance diagram for KisBrushOptionProperties:

Public Member Functions
KisBrushSP	brush () const
enumBrushApplication	brushApplication (const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface)
QList< KoResourceLoadResult >	prepareEmbeddedResourcesImpl (const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const override
QList< KoResourceLoadResult >	prepareLinkedResourcesImpl (const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const override
void	readOptionSettingResourceImpl (const KisPropertiesConfiguration *setting, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface) override
void	setBrush (KisBrushSP brush)
void	writeOptionSettingImpl (KisPropertiesConfiguration *setting) const override
Public Member Functions inherited from KisPaintopPropertiesCanvasResourcesBase
template<typename KisPropertiesConfigurationPointer >
QList< KoResourceLoadResult >	prepareEmbeddedResources (const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
template<typename KisPropertiesConfigurationPointer >
QList< KoResourceLoadResult >	prepareLinkedResources (const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
template<typename KisPropertiesConfigurationPointer >
void	readOptionSetting (KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface)
template<typename KisPropertiesConfigurationPointer >
void	writeOptionSetting (KisPropertiesConfigurationPointer settings) const
virtual	~KisPaintopPropertiesCanvasResourcesBase ()

Private Attributes
KisBrushSP	m_brush

Additional Inherited Members

Detailed Description

Definition at line 19 of file kis_brush_option.h.

Member Function Documentation

brush()

KisBrushSP KisBrushOptionProperties::brush

(

)

const

Definition at line 111 of file kis_brush_option.cpp.

{
    return m_brush;
}

References m_brush.

brushApplication()

enumBrushApplication KisBrushOptionProperties::brushApplication	(	const KisPropertiesConfiguration *	settings,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 83 of file kis_brush_option.cpp.

{
    QList<KoResourceSP> resources;
 
    QDomElement element = getBrushXMLElement(settings);
    if (element.isNull()) return ALPHAMASK;
 
    KisBrushSP brush = KisBrush::fromXML(element, resourcesInterface);
 
    return brush ? brush->brushApplication() : ALPHAMASK;
}

References ALPHAMASK, brush(), KisBrush::fromXML(), and getBrushXMLElement().

prepareEmbeddedResourcesImpl()

QList< KoResourceLoadResult > KisBrushOptionProperties::prepareEmbeddedResourcesImpl ( const KisPropertiesConfiguration * settings, KisResourcesInterfaceSP resourcesInterface ) const

overridevirtual

Implements KisPaintopPropertiesCanvasResourcesBase.

Definition at line 76 of file kis_brush_option.cpp.

{
    Q_UNUSED(settings);
    Q_UNUSED(resourcesInterface);
    return {};
}

prepareLinkedResourcesImpl()

QList< KoResourceLoadResult > KisBrushOptionProperties::prepareLinkedResourcesImpl ( const KisPropertiesConfiguration * settings, KisResourcesInterfaceSP resourcesInterface ) const

overridevirtual

Implements KisPaintopPropertiesCanvasResourcesBase.

Definition at line 60 of file kis_brush_option.cpp.

{
    QList<KoResourceLoadResult> resources;
    QDomElement element = getBrushXMLElement(settings);
    if (element.isNull()) return resources;
 
    KoResourceLoadResult result = KisBrush::fromXMLLoadResult(element, resourcesInterface);
 
    KoResourceSP resource = result.resource();
    if (!resource || !resource->isEphemeral()) {
        resources << result;
    }
 
    return resources;
}

References KisBrush::fromXMLLoadResult(), getBrushXMLElement(), and KoResourceLoadResult::resource().

readOptionSettingResourceImpl()

void KisBrushOptionProperties::readOptionSettingResourceImpl ( const KisPropertiesConfiguration * setting, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface )

overridevirtual

Implements KisPaintopPropertiesCanvasResourcesBase.

Definition at line 48 of file kis_brush_option.cpp.

{
    QDomElement element = getBrushXMLElement(setting);
    if (!element.isNull()) {
        m_brush = KisBrush::fromXML(element, resourcesInterface);
        if (m_brush && m_brush->applyingGradient() && canvasResourcesInterface) {
            KoAbstractGradientSP gradient = canvasResourcesInterface->resource(KoCanvasResource::CurrentGradient).value<KoAbstractGradientSP>()->cloneAndBakeVariableColors(canvasResourcesInterface);
            m_brush->setGradient(gradient);
        }
    }
}

References KoCanvasResource::CurrentGradient, KisBrush::fromXML(), getBrushXMLElement(), and m_brush.

setBrush()

void KisBrushOptionProperties::setBrush

(

KisBrushSP

brush

)

Definition at line 116 of file kis_brush_option.cpp.

{
    m_brush = brush;
}

References brush(), and m_brush.

writeOptionSettingImpl()

void KisBrushOptionProperties::writeOptionSettingImpl ( KisPropertiesConfiguration * setting ) const

overridevirtual

Implements KisPaintopPropertiesCanvasResourcesBase.

Definition at line 22 of file kis_brush_option.cpp.

{
    if (!m_brush) return;
 
    QDomDocument d;
    QDomElement e = d.createElement("Brush");
    m_brush->toXML(d, e);
    d.appendChild(e);
    setting->setProperty("brush_definition", d.toString());
}

References m_brush, and KisPropertiesConfiguration::setProperty().

Member Data Documentation

m_brush

KisBrushSP KisBrushOptionProperties::m_brush

private

Definition at line 38 of file kis_brush_option.h.

---

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

• plugins/paintops/libpaintop/kis_brush_option.h
• plugins/paintops/libpaintop/kis_brush_option.cpp