#include <KoCachedGradient.h>

Inheritance diagram for KoCachedGradient:

Public Member Functions
const quint8 *	cachedAt (qreal t) const
	gets the color data at position 0 <= t <= 1

KoResourceSP	clone () const override

void	colorAt (KoColor &color, qreal t) const override
	allow access to the actual color at position 0 <= t <= 1, instead of the cached color

const KoColorSpace *	colorSpace () const

KoAbstractGradientSP	gradient ()

	KoCachedGradient ()

	KoCachedGradient (const KoAbstractGradientSP gradient, qint32 steps, const KoColorSpace *cs)

bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override

QPair< QString, QString >	resourceType () const override

void	setColorSpace (const KoColorSpace *colorSpace)

void	setGradient (const KoAbstractGradientSP gradient, qint32 steps)

void	setGradient (const KoAbstractGradientSP gradient, qint32 steps, const KoColorSpace *cs)

QGradient *	toQGradient () const override

	~KoCachedGradient () override

Public Member Functions inherited from KoAbstractGradient
virtual void	bakeVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface)

KoAbstractGradientSP	cloneAndBakeVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface) const

KoAbstractGradientSP	cloneAndUpdateVariableColors (KoCanvasResourcesInterfaceSP canvasResourcesInterface) const

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

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 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)

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 ()

Private Attributes
KoColor	m_black

QVector< KoColor >	m_colors

const KoColorSpace *	m_colorSpace = 0

qint32	m_max = 0

KoAbstractGradientSP	m_subject

Additional Inherited Members
Public Attributes inherited from KoAbstractGradient
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}

Detailed Description

Definition at line 9 of file KoCachedGradient.h.

Constructor & Destructor Documentation

◆ KoCachedGradient() [1/2]

KoCachedGradient::KoCachedGradient ( )

inline

Definition at line 13 of file KoCachedGradient.h.

                       : KoAbstractGradient("")
    {
    }

◆ KoCachedGradient() [2/2]

KoCachedGradient::KoCachedGradient	(	const KoAbstractGradientSP	gradient,
		qint32	steps,
		const KoColorSpace *	cs )

inline

Definition at line 17 of file KoCachedGradient.h.

        : KoAbstractGradient(gradient->filename())
    {
        setGradient(gradient, steps, cs);
    }

References gradient(), and setGradient().

◆ ~KoCachedGradient()

KoCachedGradient::~KoCachedGradient ( )

inlineoverride

Definition at line 23 of file KoCachedGradient.h.

23{}

Member Function Documentation

◆ cachedAt()

const quint8 * KoCachedGradient::cachedAt ( qreal t ) const

inline

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

Definition at line 58 of file KoCachedGradient.h.

    {
        qint32 tInt = t * m_max + 0.5;
        if (m_colors.size() > tInt) {
            return m_colors[tInt].data();
        }
        else {
            return m_black.data();
        }
    }

References KoColor::data(), m_black, m_colors, and m_max.

◆ clone()

KoResourceSP KoCachedGradient::clone ( ) const

inlineoverridevirtual

Implements KoResource.

Definition at line 25 of file KoCachedGradient.h.

                                        {
        return KoResourceSP(new KoCachedGradient(m_subject, m_max + 1, m_colorSpace));
    }

References KoCachedGradient(), m_colorSpace, m_max, and m_subject.

◆ colorAt()

void KoCachedGradient::colorAt	(	KoColor &	color,
		qreal	t ) const

inlineoverridevirtual

allow access to the actual color at position 0 <= t <= 1, instead of the cached color

Reimplemented from KoAbstractGradient.

Definition at line 70 of file KoCachedGradient.h.

    {
        m_subject->colorAt(color, t);
    }

References m_subject.

◆ colorSpace()

const KoColorSpace * KoCachedGradient::colorSpace ( ) const

inline

Definition at line 83 of file KoCachedGradient.h.

83{ return m_colorSpace; }

References m_colorSpace.

◆ gradient()

KoAbstractGradientSP KoCachedGradient::gradient ( )

inline

Definition at line 85 of file KoCachedGradient.h.

85{ return m_subject; }

References m_subject.

◆ loadFromDevice()

bool KoCachedGradient::loadFromDevice	(	QIODevice *	dev,
		KisResourcesInterfaceSP	resourcesInterface )

inlineoverridevirtual

Implements KoResource.

Definition at line 87 of file KoCachedGradient.h.

                                                                                             {
        return m_subject->loadFromDevice(dev, resourcesInterface);
    }

References m_subject.

◆ resourceType()

QPair< QString, QString > KoCachedGradient::resourceType ( ) const

inlineoverridevirtual

Returns: the resource type

Implements KoResource.

Definition at line 91 of file KoCachedGradient.h.

                                                          {
        return m_subject->resourceType();
    }

References m_subject.

◆ setColorSpace()

void KoCachedGradient::setColorSpace ( const KoColorSpace * colorSpace )

inline

Definition at line 74 of file KoCachedGradient.h.

    { 
        if (!m_colorSpace || *m_colorSpace != *colorSpace) {
            m_colorSpace = colorSpace;
            for (qint32 i = 0; i < m_colors.size(); i++) {
                m_colors[i].convertTo(m_colorSpace);
            }
        }
    }

References colorSpace(), m_colors, and m_colorSpace.

◆ setGradient() [1/2]

void KoCachedGradient::setGradient	(	const KoAbstractGradientSP	gradient,
		qint32	steps )

inline

Definition at line 53 of file KoCachedGradient.h.

                                                                        {
        setGradient(gradient, steps, gradient->colorSpace());
    }

References gradient(), and setGradient().

◆ setGradient() [2/2]

void KoCachedGradient::setGradient	(	const KoAbstractGradientSP	gradient,
		qint32	steps,
		const KoColorSpace *	cs )

inline

Definition at line 38 of file KoCachedGradient.h.

                                                                                                {
        m_subject = gradient;
        m_max = steps - 1;
        m_colorSpace = cs;
        m_colors.clear();
 
        m_black = KoColor(cs);
 
        KoColor tmpColor(m_colorSpace);
        for (qint32 i = 0; i < steps; i++) {
            m_subject->colorAt(tmpColor, qreal(i) / m_max);
            m_colors << tmpColor;
        }
    }

References gradient(), m_black, m_colors, m_colorSpace, m_max, and m_subject.

◆ toQGradient()

QGradient * KoCachedGradient::toQGradient ( ) const

inlineoverridevirtual

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

Reimplemented from KoAbstractGradient.

Definition at line 33 of file KoCachedGradient.h.

    {
        return m_subject->toQGradient();
    }

References m_subject.

Member Data Documentation

◆ m_black

KoColor KoCachedGradient::m_black

private

Definition at line 101 of file KoCachedGradient.h.

◆ m_colors

QVector<KoColor> KoCachedGradient::m_colors

private

Definition at line 100 of file KoCachedGradient.h.

◆ m_colorSpace

const KoColorSpace* KoCachedGradient::m_colorSpace = 0

private

Definition at line 98 of file KoCachedGradient.h.

◆ m_max

qint32 KoCachedGradient::m_max = 0

private

Definition at line 99 of file KoCachedGradient.h.

◆ m_subject

KoAbstractGradientSP KoCachedGradient::m_subject

private

Definition at line 97 of file KoCachedGradient.h.

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

libs/pigment/resources/KoCachedGradient.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KoCachedGradient() [1/2]

◆ KoCachedGradient() [2/2]

◆ ~KoCachedGradient()

Member Function Documentation

◆ cachedAt()

◆ clone()

◆ colorAt()

◆ colorSpace()

◆ gradient()

◆ loadFromDevice()

◆ resourceType()

◆ setColorSpace()

◆ setGradient() [1/2]

◆ setGradient() [2/2]

◆ toQGradient()

Member Data Documentation

◆ m_black

◆ m_colors

◆ m_colorSpace

◆ m_max

◆ m_subject