#include <KoAbstractGradient.h>

Inheritance diagram for KoAbstractGradient:

Public Member Functions
virtual void	bakeVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

KoAbstractGradientSP	cloneAndBakeVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface) const

KoAbstractGradientSP	cloneAndUpdateVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface) const

virtual void	colorAt (KoColor &, qreal t) const
	gets the color at position 0 <= t <= 1

const KoColorSpace *	colorSpace () const

QImage	generatePreview (int width, int height) const

QImage	generatePreview (int width, int height, KoCanvasResourcesInterfaceSP canvasResourcesInterface) const

	KoAbstractGradient (const KoAbstractGradient &rhs)

	KoAbstractGradient (const QString &filename)

void	setColorSpace (KoColorSpace *colorSpace)

void	setSpread (QGradient::Spread spreadMethod)

void	setType (QGradient::Type repeatType)

QGradient::Spread	spread () const

virtual QGradient *	toQGradient () const

QGradient::Type	type () const

void	updatePreview ()

virtual void	updateVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

	~KoAbstractGradient () override

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

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

virtual QPair< QString, QString >	resourceType () const =0

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 Attributes
const KoColorSpace *	colorSpace

QGradient::Spread	spread

QGradient::Type	type

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

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}

Private Attributes
Private *const	d

Detailed Description

KoAbstractGradient is the base class of all gradient resources

Definition at line 20 of file KoAbstractGradient.cpp.

Constructor & Destructor Documentation

◆ KoAbstractGradient() [1/2]

KoAbstractGradient::KoAbstractGradient ( const QString & filename )

explicit

Definition at line 26 of file KoAbstractGradient.cpp.

        : KoResource(filename)
        , d(new Private)
{
    d->colorSpace = KoColorSpaceRegistry::instance()->rgb8();
    d->spread = QGradient::PadSpread;
    d->type = QGradient::NoGradient;
}

References d, KoColorSpaceRegistry::instance(), and KoColorSpaceRegistry::rgb8().

◆ ~KoAbstractGradient()

KoAbstractGradient::~KoAbstractGradient ( )

override

Definition at line 35 of file KoAbstractGradient.cpp.

{
    delete d;
}

References d.

◆ KoAbstractGradient() [2/2]

KoAbstractGradient::KoAbstractGradient ( const KoAbstractGradient & rhs )

Definition at line 40 of file KoAbstractGradient.cpp.

    : KoResource(rhs)
    , d(new Private(*rhs.d))
{
}

Member Function Documentation

◆ bakeVariableColors()

void KoAbstractGradient::bakeVariableColors ( KoCanvasResourcesInterfaceSP canvasResourcesInterface )

virtual

Reimplemented in KoSegmentGradient, and KoStopGradient.

Definition at line 55 of file KoAbstractGradient.cpp.

{
    Q_UNUSED(canvasResourcesInterface);
}

◆ cloneAndBakeVariableColors()

KoAbstractGradientSP KoAbstractGradient::cloneAndBakeVariableColors ( KoCanvasResourcesInterfaceSP canvasResourcesInterface ) const

Definition at line 46 of file KoAbstractGradient.cpp.

{
    KoAbstractGradientSP result = this->clone().dynamicCast<KoAbstractGradient>();
    if (canvasResourcesInterface) {
        result->bakeVariableColors(canvasResourcesInterface);
    }
    return result;
}

References KoResource::clone().

◆ cloneAndUpdateVariableColors()

KoAbstractGradientSP KoAbstractGradient::cloneAndUpdateVariableColors ( KoCanvasResourcesInterfaceSP canvasResourcesInterface ) const

Definition at line 60 of file KoAbstractGradient.cpp.

{
    KoAbstractGradientSP result = this->clone().dynamicCast<KoAbstractGradient>();
    if (canvasResourcesInterface) {
        result->updateVariableColors(canvasResourcesInterface);
    }
    return result;
}

References KoResource::clone().

◆ colorAt()

void KoAbstractGradient::colorAt	(	KoColor &	,
		qreal	t ) const

virtual

gets the color at position 0 <= t <= 1

Reimplemented in KoStopGradient, KoCachedGradient, and KoSegmentGradient.

Definition at line 74 of file KoAbstractGradient.cpp.

{
    Q_UNUSED(t);
}

◆ colorSpace()

const KoColorSpace * KoAbstractGradient::colorSpace ( ) const

◆ generatePreview() [1/2]

QImage KoAbstractGradient::generatePreview	(	int	width,
		int	height ) const

Definition at line 109 of file KoAbstractGradient.cpp.

{
    QImage image(width, height, QImage::Format_ARGB32);
 
    QRgb * firstLine = reinterpret_cast<QRgb*>(image.scanLine(0));
 
    KoColor c;
    QColor color;
    // first create a reference line
    for (int x = 0; x < image.width(); ++x) {
 
        qreal t = static_cast<qreal>(x) / (image.width() - 1);
        colorAt(c, t);
        c.toQColor(&color);
 
        firstLine[x] = color.rgba();
    }
 
    int bytesPerLine = image.bytesPerLine();
 
    // now copy lines accordingly
    for (int y = 1; y < image.height(); ++y) {
        QRgb * line = reinterpret_cast<QRgb*>(image.scanLine(y));
 
        memcpy(line, firstLine, bytesPerLine);
    }
 
    return image;
}

References colorAt(), KoResource::image, and KoColor::toQColor().

◆ generatePreview() [2/2]

QImage KoAbstractGradient::generatePreview	(	int	width,
		int	height,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface ) const

Definition at line 139 of file KoAbstractGradient.cpp.

{
    QImage result;
 
    if (!requiredCanvasResources().isEmpty()) {
        KoAbstractGradientSP gradient = cloneAndBakeVariableColors(canvasResourcesInterface);
        result = gradient->generatePreview(width, height);
    } else {
        result = generatePreview(width, height);
    }
 
    return result;
}

References cloneAndBakeVariableColors(), generatePreview(), and KoResource::requiredCanvasResources().

◆ setColorSpace()

void KoAbstractGradient::setColorSpace ( KoColorSpace * colorSpace )

Definition at line 79 of file KoAbstractGradient.cpp.

{
    d->colorSpace = colorSpace;
}

References colorSpace, and d.

◆ setSpread()

void KoAbstractGradient::setSpread ( QGradient::Spread spreadMethod )

Definition at line 89 of file KoAbstractGradient.cpp.

{
    d->spread = spreadMethod;
}

References d.

◆ setType()

void KoAbstractGradient::setType ( QGradient::Type repeatType )

Definition at line 99 of file KoAbstractGradient.cpp.

{
    d->type = repeatType;
}

References d.

◆ spread()

QGradient::Spread KoAbstractGradient::spread ( ) const

◆ toQGradient()

virtual QGradient * KoAbstractGradient::toQGradient ( ) const

inlinevirtual

Creates a QGradient from the gradient. The resulting QGradient might differ from original gradient

Reimplemented in KoCachedGradient, KoSegmentGradient, and KoStopGradient.

Definition at line 37 of file KoAbstractGradient.h.

                                           {
        return new QGradient();
    }

◆ type()

QGradient::Type KoAbstractGradient::type ( ) const

◆ updatePreview()

void KoAbstractGradient::updatePreview ( )

Definition at line 153 of file KoAbstractGradient.cpp.

{
    setImage(generatePreview(PREVIEW_WIDTH, PREVIEW_HEIGHT));
}

References generatePreview(), PREVIEW_HEIGHT, PREVIEW_WIDTH, and KoResource::setImage().

◆ updateVariableColors()

void KoAbstractGradient::updateVariableColors ( KoCanvasResourcesInterfaceSP canvasResourcesInterface )

virtual

Reimplemented in KoSegmentGradient, and KoStopGradient.

Definition at line 69 of file KoAbstractGradient.cpp.

{
    Q_UNUSED(canvasResourcesInterface);
}

Member Data Documentation

◆ colorSpace

const KoColorSpace * KoAbstractGradient::colorSpace

Definition at line 21 of file KoAbstractGradient.cpp.

◆ d

Private* const KoAbstractGradient::d

private

Definition at line 68 of file KoAbstractGradient.h.

◆ spread

QGradient::Spread KoAbstractGradient::spread

Definition at line 22 of file KoAbstractGradient.cpp.

◆ type

QGradient::Type KoAbstractGradient::type

Definition at line 23 of file KoAbstractGradient.cpp.

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

libs/pigment/resources/KoAbstractGradient.cpp
libs/pigment/resources/KoAbstractGradient.h

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KoAbstractGradient() [1/2]

◆ ~KoAbstractGradient()

◆ KoAbstractGradient() [2/2]

Member Function Documentation

◆ bakeVariableColors()

◆ cloneAndBakeVariableColors()

◆ cloneAndUpdateVariableColors()

◆ colorAt()

◆ colorSpace()

◆ generatePreview() [1/2]

◆ generatePreview() [2/2]

◆ setColorSpace()

◆ setSpread()

◆ setType()

◆ spread()

◆ toQGradient()

◆ type()

◆ updatePreview()

◆ updateVariableColors()

Member Data Documentation

◆ colorSpace

◆ d

◆ spread

◆ type