#include <KisColorfulBrush.h>

Inheritance diagram for KisColorfulBrush:

Public Member Functions
qreal	adjustedMidPoint () const

quint8	adjustmentMidPoint () const

bool	autoAdjustMidPoint () const

qreal	brightnessAdjustment () const

QImage	brushTipImage () const override
	brushImage the image the brush tip can paint with. Not all brush types have a single image.

qreal	contrastAdjustment () const

qreal	estimatedSourceMidPoint () const

bool	hasColorAndTransparency () const

virtual bool	isImageType () const

	KisColorfulBrush ()=default

	KisColorfulBrush (const KisColorfulBrush &rhs)=default

	KisColorfulBrush (const QString &filename)

virtual void	setAdjustmentMidPoint (quint8 value)

virtual void	setAutoAdjustMidPoint (bool autoAdjustMidPoint)

virtual void	setBrightnessAdjustment (qreal value)

virtual void	setContrastAdjustment (qreal value)

void	setHasColorAndTransparency (bool value)

void	toXML (QDomDocument &d, QDomElement &e) const override

Public Member Functions inherited from KisScalingSizeBrush
	KisScalingSizeBrush ()

	KisScalingSizeBrush (const KisScalingSizeBrush &rhs)

	KisScalingSizeBrush (const QString &filename)

void	setUserEffectiveSize (qreal value) override

qreal	userEffectiveSize () const override

Public Member Functions inherited from KisBrush
qreal	angle () const

virtual bool	applyingGradient () const

bool	autoSpacingActive () const

qreal	autoSpacingCoeff () const

virtual enumBrushApplication	brushApplication () const

virtual quint32	brushIndex () const

virtual enumBrushType	brushType () const

virtual bool	canPaintFor (const KisPaintInformation &)

virtual QSizeF	characteristicSize (KisDabShape const &) const

void	clearBrushPyramid ()

virtual void	coldInitBrush ()

virtual void	generateMaskAndApplyMaskOrCreateDab (KisFixedPaintDeviceSP dst, ColoringInformation *coloringInfo, KisDabShape const &, const KisPaintInformation &info, double subPixelX, double subPixelY, qreal softnessFactor, qreal lightnessStrength) const

void	generateMaskAndApplyMaskOrCreateDab (KisFixedPaintDeviceSP dst, ColoringInformation *coloringInfo, KisDabShape const &, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR) const

qint32	height () const

QPointF	hotSpot (KisDabShape const &, const KisPaintInformation &info) const

virtual bool	isPiercedApprox () const

	KisBrush ()

	KisBrush (const KisBrush &rhs)

	KisBrush (const QString &filename)

virtual void	lodLimitations (KisPaintopLodLimitations *l) const

void	mask (KisFixedPaintDeviceSP dst, const KisPaintDeviceSP src, KisDabShape const &shape, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR, qreal lightnessStrength=DEFAULT_LIGHTNESS_STRENGTH) const

void	mask (KisFixedPaintDeviceSP dst, const KoColor &color, KisDabShape const &shape, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0, qreal softnessFactor=DEFAULT_SOFTNESS_FACTOR, qreal lightnessStrength=DEFAULT_LIGHTNESS_STRENGTH) const

double	maskAngle (double angle=0) const

virtual qint32	maskHeight (KisDabShape const &, qreal subPixelX, qreal subPixelY, const KisPaintInformation &info) const

virtual qint32	maskWidth (KisDabShape const &, qreal subPixelX, qreal subPixelY, const KisPaintInformation &info) const

virtual void	notifyBrushIsGoingToBeClonedForStroke ()

virtual void	notifyStrokeStarted ()

KisBrush &	operator= (const KisBrush &rhs)=delete

virtual KisOptimizedBrushOutline	outline (bool forcePreciseOutline=false) const

virtual KisFixedPaintDeviceSP	outlineSourceImage () const

virtual KisFixedPaintDeviceSP	paintDevice (const KoColorSpace *colorSpace, KisDabShape const &, const KisPaintInformation &info, double subPixelX=0, double subPixelY=0) const

virtual void	prepareForSeqNo (const KisPaintInformation &info, int seqNo)

virtual bool	preserveLightness () const

QPair< QString, QString >	resourceType () const override

qreal	scale () const

virtual void	setAngle (qreal _angle)

void	setAutoSpacing (bool active, qreal coeff)

virtual void	setBrushApplication (enumBrushApplication brushApplication)

virtual void	setBrushTipImage (const QImage &image)

virtual void	setGradient (KoAbstractGradientSP gradient)

virtual void	setScale (qreal _scale)

virtual void	setSpacing (double spacing)

double	spacing () const

virtual bool	supportsCaching () const

qint32	width () const

	~KisBrush () override

Public Member Functions inherited from KoResource
bool	active () const

void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource

virtual void	clearSideLoadedResources ()

virtual KoResourceSP	clone () const =0

virtual QString	defaultFileExtension () const

virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const

QString	filename () const

QImage	image () const

bool	isDirty () const

virtual bool	isEphemeral () const

virtual bool	isSerializable () const

	KoResource ()

	KoResource (const KoResource &rhs)

	KoResource (const QString &filename)

virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const

bool	load (KisResourcesInterfaceSP resourcesInterface)

virtual bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface)=0

QString	md5Sum (bool generateIfEmpty=true) const

QMap< QString, QVariant >	metadata () const
	get a map with all the metadata

virtual QString	name () const

KoResource &	operator= (const KoResource &rhs)=delete

bool	permanent () const

virtual QList< int >	requiredCanvasResources () const

QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const

int	resourceId () const

bool	save ()

virtual bool	saveToDevice (QIODevice *dev) const

void	setActive (bool active)

void	setDirty (bool value)
	Mark the preset as modified but not saved.

void	setFilename (const QString &filename)

void	setImage (const QImage &image)

void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.

void	setName (const QString &name)

void	setPermanent (bool permanent)

void	setResourceId (int id)

void	setStorageLocation (const QString &location)

void	setValid (bool valid)

void	setVersion (int version)

virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const

KoResourceSignature	signature () const

QString	storageLocation () const

QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)

virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors

virtual QString	thumbnailPath () const
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.

virtual void	updateThumbnail ()
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.

bool	valid () const

int	version () const
	Get the version of the resource.

virtual	~KoResource ()

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
quint8	m_adjustmentMidPoint = 127

bool	m_autoAdjustMidPoint = false

qreal	m_brightnessAdjustment = 0.0

qreal	m_contrastAdjustment = 0.0

bool	m_hasColorAndTransparency = false

Additional Inherited Members
Static Public Member Functions inherited from KisBrush
static KisBrushSP	fromXML (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface)

static KoResourceLoadResult	fromXMLLoadResult (const QDomElement &element, KisResourcesInterfaceSP resourcesInterface)

Public Attributes inherited from KoResource
bool	active {true}

QString	filename

QImage	image

QString	md5sum

QMap< QString, QVariant >	metadata

bool	modified {false}

QString	name

bool	permanent {false}

int	resourceId {-1}

QString	storageLocation

bool	valid {false}

int	version {-1}

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Static Public Attributes inherited from KisBrush
static const QString	brushTypeMetaDataKey = "image-based-brush"

Protected Member Functions inherited from KisBrush
void	generateOutlineCache ()

bool	outlineCacheIsValid () const

void	predefinedBrushToXML (const QString &type, QDomElement &e) const

void	resetOutlineCache ()

virtual void	setBrushType (enumBrushType type)

void	setHeight (qint32 height)

void	setHotSpot (QPointF)

void	setWidth (qint32 width)

Detailed Description

Definition at line 13 of file KisColorfulBrush.h.

Constructor & Destructor Documentation

◆ KisColorfulBrush() [1/3]

KisColorfulBrush::KisColorfulBrush ( )

default

◆ KisColorfulBrush() [2/3]

KisColorfulBrush::KisColorfulBrush ( const QString & filename )

Definition at line 10 of file KisColorfulBrush.cpp.

    : KisScalingSizeBrush(filename)
{
}

◆ KisColorfulBrush() [3/3]

KisColorfulBrush::KisColorfulBrush ( const KisColorfulBrush & rhs )

default

Member Function Documentation

◆ adjustedMidPoint()

qreal KisColorfulBrush::adjustedMidPoint ( ) const

Definition at line 49 of file KisColorfulBrush.cpp.

{
    return estimateImageAverage(this->brushTipImage());
}

References brushTipImage().

◆ adjustmentMidPoint()

quint8 KisColorfulBrush::adjustmentMidPoint ( ) const

Definition at line 167 of file KisColorfulBrush.cpp.

{
    return m_adjustmentMidPoint;
}

References m_adjustmentMidPoint.

◆ autoAdjustMidPoint()

bool KisColorfulBrush::autoAdjustMidPoint ( ) const

Definition at line 54 of file KisColorfulBrush.cpp.

{
    return m_autoAdjustMidPoint;
}

References m_autoAdjustMidPoint.

◆ brightnessAdjustment()

qreal KisColorfulBrush::brightnessAdjustment ( ) const

Definition at line 172 of file KisColorfulBrush.cpp.

{
    return m_brightnessAdjustment;
}

References m_brightnessAdjustment.

◆ brushTipImage()

QImage KisColorfulBrush::brushTipImage ( ) const

overridevirtual

brushImage the image the brush tip can paint with. Not all brush types have a single image.

Returns: a valid QImage.

Reimplemented from KisBrush.

Definition at line 64 of file KisColorfulBrush.cpp.

{
    QImage image = KisBrush::brushTipImage();
    if (isImageType() && brushApplication() != IMAGESTAMP) {
 
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(image.format() == QImage::Format_ARGB32, image);
 
        const qreal adjustmentMidPoint =
                m_autoAdjustMidPoint ?
                estimateImageAverage(image) :
                m_adjustmentMidPoint;
 
        if (qAbs(adjustmentMidPoint - 127.0) > 0.1 ||
            !qFuzzyIsNull(m_brightnessAdjustment) ||
            !qFuzzyIsNull(m_contrastAdjustment)) {
 
            const int half = KoColorSpaceMathsTraits<quint8>::halfValue;
            const int unit = KoColorSpaceMathsTraits<quint8>::unitValue;
 
            const qreal midX = adjustmentMidPoint;
            const qreal midY = m_brightnessAdjustment > 0 ?
                        KoColorSpaceMaths<qreal>::blend(unit, half, m_brightnessAdjustment) :
                        KoColorSpaceMaths<qreal>::blend(0, half, -m_brightnessAdjustment);
 
            qreal loA = 0.0;
            qreal hiA = 0.0;
 
            qreal loB = 0.0;
            qreal hiB = 255.0;
 
            if (!qFuzzyCompare(m_contrastAdjustment, 1.0)) {
                if (m_contrastAdjustment > 0.0) {
                    loA = midY / (1.0 - m_contrastAdjustment) / midX;
                    hiA = (unit - midY) / (1.0 - m_contrastAdjustment) / (unit - midX);
                } else {
                    loA = midY * (1.0 + m_contrastAdjustment) / midX;
                    hiA = (unit - midY) * (1.0 + m_contrastAdjustment) / (unit - midX);
                }
 
                loB = midY - midX * loA;
                hiB = midY - midX * hiA;
            }
 
            for (int y = 0; y < image.height(); y++) {
                QRgb *pixel = reinterpret_cast<QRgb *>(image.scanLine(y));
                for (int x = 0; x < image.width(); x++) {
                    QRgb c = pixel[x];
 
                    int v = qGray(c);
 
                    if (v >= midX) {
                        v = qMin(unit, qRound(hiA * v + hiB));
                    } else {
                        v = qMax(0, qRound(loA * v + loB));
                    }
 
                    pixel[x] = qRgba(v, v, v, qAlpha(c));
                }
            }
        } else {
            for (int y = 0; y < image.height(); y++) {
                QRgb *pixel = reinterpret_cast<QRgb *>(image.scanLine(y));
                for (int x = 0; x < image.width(); x++) {
                    QRgb c = pixel[x];
 
                    int v = qGray(c);
                    pixel[x] = qRgba(v, v, v, qAlpha(c));
                }
            }
        }
    }
    return image;
}

References adjustmentMidPoint(), KoColorSpaceMaths< _T, _Tdst >::blend(), KisBrush::brushApplication(), KisBrush::brushTipImage(), KoResource::image, IMAGESTAMP, isImageType(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_adjustmentMidPoint, m_autoAdjustMidPoint, m_brightnessAdjustment, m_contrastAdjustment, qFuzzyCompare(), qFuzzyIsNull(), and v.

◆ contrastAdjustment()

qreal KisColorfulBrush::contrastAdjustment ( ) const

Definition at line 177 of file KisColorfulBrush.cpp.

{
    return m_contrastAdjustment;
}

References m_contrastAdjustment.

◆ estimatedSourceMidPoint()

qreal KisColorfulBrush::estimatedSourceMidPoint ( ) const

Definition at line 44 of file KisColorfulBrush.cpp.

{
    return estimateImageAverage(KisBrush::brushTipImage());
}

References KisBrush::brushTipImage().

◆ hasColorAndTransparency()

bool KisColorfulBrush::hasColorAndTransparency ( ) const

Definition at line 202 of file KisColorfulBrush.cpp.

{
    return m_hasColorAndTransparency;
}

References m_hasColorAndTransparency.

◆ isImageType()

bool KisColorfulBrush::isImageType ( ) const

virtual

Definition at line 162 of file KisColorfulBrush.cpp.

{
    return brushType() == IMAGE || brushType() == PIPE_IMAGE;
}

References KisBrush::brushType(), IMAGE, and PIPE_IMAGE.

◆ setAdjustmentMidPoint()

void KisColorfulBrush::setAdjustmentMidPoint ( quint8 value )

virtual

Reimplemented in KisImagePipeBrush.

Definition at line 138 of file KisColorfulBrush.cpp.

{
    if (m_adjustmentMidPoint != value) {
        m_adjustmentMidPoint = value;
        clearBrushPyramid();
    }
}

References KisBrush::clearBrushPyramid(), m_adjustmentMidPoint, and value().

◆ setAutoAdjustMidPoint()

void KisColorfulBrush::setAutoAdjustMidPoint ( bool autoAdjustMidPoint )

virtual

Reimplemented in KisImagePipeBrush.

Definition at line 59 of file KisColorfulBrush.cpp.

{
    m_autoAdjustMidPoint = autoAdjustMidPoint;
}

References autoAdjustMidPoint(), and m_autoAdjustMidPoint.

◆ setBrightnessAdjustment()

void KisColorfulBrush::setBrightnessAdjustment ( qreal value )

virtual

Reimplemented in KisImagePipeBrush.

Definition at line 146 of file KisColorfulBrush.cpp.

{
    if (m_brightnessAdjustment != value) {
        m_brightnessAdjustment = value;
        clearBrushPyramid();
    }
}

References KisBrush::clearBrushPyramid(), m_brightnessAdjustment, and value().

◆ setContrastAdjustment()

void KisColorfulBrush::setContrastAdjustment ( qreal value )

virtual

Reimplemented in KisImagePipeBrush.

Definition at line 154 of file KisColorfulBrush.cpp.

{
    if (m_contrastAdjustment != value) {
        m_contrastAdjustment = value;
        clearBrushPyramid();
    }
}

References KisBrush::clearBrushPyramid(), m_contrastAdjustment, and value().

◆ setHasColorAndTransparency()

void KisColorfulBrush::setHasColorAndTransparency ( bool value )

Definition at line 197 of file KisColorfulBrush.cpp.

{
    m_hasColorAndTransparency = value;
}

References m_hasColorAndTransparency, and value().

◆ toXML()

void KisColorfulBrush::toXML	(	QDomDocument &	,
		QDomElement &	element ) const

overridevirtual

Serialize this brush to XML.

Reimplemented from KisBrush.

Reimplemented in KisGbrBrush, and KisPngBrush.

Definition at line 184 of file KisColorfulBrush.cpp.

{
    // legacy setting, now 'brushApplication' is used instead
    e.setAttribute("ColorAsMask", QString::number((int)(brushApplication() != IMAGESTAMP)));
 
    e.setAttribute("AdjustmentMidPoint", QString::number(m_adjustmentMidPoint));
    e.setAttribute("BrightnessAdjustment", QString::number(m_brightnessAdjustment));
    e.setAttribute("ContrastAdjustment", QString::number(m_contrastAdjustment));
    e.setAttribute("AutoAdjustMidPoint", QString::number(m_autoAdjustMidPoint));
    e.setAttribute("AdjustmentVersion", QString::number(2));
    KisBrush::toXML(d, e);
}

References KisBrush::brushApplication(), KisBrush::d, IMAGESTAMP, m_adjustmentMidPoint, m_autoAdjustMidPoint, m_brightnessAdjustment, m_contrastAdjustment, and KisBrush::toXML().

Member Data Documentation

◆ m_adjustmentMidPoint

quint8 KisColorfulBrush::m_adjustmentMidPoint = 127

private

Definition at line 45 of file KisColorfulBrush.h.

◆ m_autoAdjustMidPoint

bool KisColorfulBrush::m_autoAdjustMidPoint = false

private

Definition at line 44 of file KisColorfulBrush.h.

◆ m_brightnessAdjustment

qreal KisColorfulBrush::m_brightnessAdjustment = 0.0

private

Definition at line 46 of file KisColorfulBrush.h.

◆ m_contrastAdjustment

qreal KisColorfulBrush::m_contrastAdjustment = 0.0

private

Definition at line 47 of file KisColorfulBrush.h.

◆ m_hasColorAndTransparency

bool KisColorfulBrush::m_hasColorAndTransparency = false

private

Definition at line 48 of file KisColorfulBrush.h.

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

libs/brush/KisColorfulBrush.h
libs/brush/KisColorfulBrush.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisColorfulBrush() [1/3]

◆ KisColorfulBrush() [2/3]

◆ KisColorfulBrush() [3/3]

Member Function Documentation

◆ adjustedMidPoint()

◆ adjustmentMidPoint()

◆ autoAdjustMidPoint()

◆ brightnessAdjustment()

◆ brushTipImage()

◆ contrastAdjustment()

◆ estimatedSourceMidPoint()

◆ hasColorAndTransparency()

◆ isImageType()

◆ setAdjustmentMidPoint()

◆ setAutoAdjustMidPoint()

◆ setBrightnessAdjustment()

◆ setContrastAdjustment()

◆ setHasColorAndTransparency()

◆ toXML()

Member Data Documentation

◆ m_adjustmentMidPoint

◆ m_autoAdjustMidPoint

◆ m_brightnessAdjustment

◆ m_contrastAdjustment

◆ m_hasColorAndTransparency