Namespace containing functions to convert to/from different types of gradients. More...

Functions
KoAbstractGradientSP	toAbstractGradient (const QGradient *gradient)
	Convert the stops of a QGradient to a krita abstract gradient.

KoAbstractGradientSP	toAbstractGradient (const QGradientStops &gradient)
	Convert a QGradientStop list to a krita abstract gradient.

KoAbstractGradientSP	toAbstractGradient (KoSegmentGradientSP gradient)
	Create a clone of a KoSegmentGradientSP and return it casted to a krita abstract gradient.

KoAbstractGradientSP	toAbstractGradient (KoStopGradientSP gradient)
	Create a clone of a KoStopGradientSP and return it casted to a krita abstract gradient.

KoGradientStop	toKoGradientStop (const KoColor &color, KoGradientSegmentEndpointType type, qreal offset, KoCanvasResourcesInterfaceSP canvasResourcesInterface)

QGradient *	toQGradient (KoAbstractGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoAbstractGradientSP to a QGradient.

QGradient *	toQGradient (KoSegmentGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoSegmentGradientSP to a QGradient.

QGradient *	toQGradient (KoStopGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoStopGradientSP to a QGradient.

QGradientStop	toQGradientStop (const KoColor &color, KoGradientSegmentEndpointType type, qreal offset, KoCanvasResourcesInterfaceSP canvasResourcesInterface)

QGradientStop	toQGradientStop (const KoColor &color, KoGradientStopType type, qreal position, KoCanvasResourcesInterfaceSP canvasResourcesInterface)

QGradientStops	toQGradientStops (KoAbstractGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoAbstractGradientSP to a QGradientStop list.

QGradientStops	toQGradientStops (KoSegmentGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoSegmentGradientSP to a QGradientStop list.

QGradientStops	toQGradientStops (KoStopGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoStopGradientSP to a QGradientStop list.

KoSegmentGradientSP	toSegmentGradient (const QGradient *gradient)
	Convert a QGradient to a krita segment gradient.

KoSegmentGradientSP	toSegmentGradient (const QGradientStops &gradient)
	Convert a QGradientStop list to a krita segment gradient.

KoSegmentGradientSP	toSegmentGradient (KoAbstractGradientSP gradient)
	Convert a krita abstract gradient to a krita segment gradient.

KoSegmentGradientSP	toSegmentGradient (KoStopGradientSP gradient)
	Convert a krita stop gradient to a krita segment gradient.

KoStopGradientSP	toStopGradient (const QGradient *gradient)
	Convert the stops of a QGradient to a KoStopGradientSP.

KoStopGradientSP	toStopGradient (const QGradientStops &gradient)
	Convert a QGradientStop list to a KoStopGradientSP.

KoStopGradientSP	toStopGradient (KoAbstractGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoAbstractGradientSP to a KoStopGradientSP.

KoStopGradientSP	toStopGradient (KoSegmentGradientSP gradient, KoCanvasResourcesInterfaceSP canvasResourcesInterface=nullptr)
	Convert a KoSegmentGradientSP to a KoStopGradientSP.

Detailed Description

Namespace containing functions to convert to/from different types of gradients.

Function Documentation

◆ toAbstractGradient() [1/4]

KRITAPIGMENT_EXPORT KoAbstractGradientSP KisGradientConversion::toAbstractGradient ( const QGradient * gradient )

Convert the stops of a QGradient to a krita abstract gradient.

This function makes use of toStopGradient(const QGradientStops &) to create a KoStopGradientSP that is casted to a KoAbstractGradientSP

Parameters

gradient A QGradient with the stops of the gradient

Returns: KoAbstractGradientSP containing stops with the positions and colors of the gradient

Definition at line 203 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        return toStopGradient(gradient).dynamicCast<KoAbstractGradient>();
    }

References toStopGradient().

◆ toAbstractGradient() [2/4]

KRITAPIGMENT_EXPORT KoAbstractGradientSP KisGradientConversion::toAbstractGradient ( const QGradientStops & gradient )

Convert a QGradientStop list to a krita abstract gradient.

This function makes use of toStopGradient(const QGradientStops &) to create a KoStopGradientSP that is casted to a KoAbstractGradientSP

Parameters

gradient A QGradientStop list with the stops of the gradient

Returns: KoAbstractGradientSP containing stops with the positions and colors of the gradient

Definition at line 198 of file KisGradientConversion.cpp.

    {
        return toStopGradient(gradient).dynamicCast<KoAbstractGradient>();
    }

References toStopGradient().

◆ toAbstractGradient() [3/4]

KRITAPIGMENT_EXPORT KoAbstractGradientSP KisGradientConversion::toAbstractGradient ( KoSegmentGradientSP gradient )

Create a clone of a KoSegmentGradientSP and return it casted to a krita abstract gradient.

Parameters

gradient A KoSegmentGradientSP gradient to convert from

Returns: A clone of the input gradient casted to KoAbstractGradientSP

Definition at line 219 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        return gradient->clone().dynamicCast<KoAbstractGradient>();
    }

◆ toAbstractGradient() [4/4]

KRITAPIGMENT_EXPORT KoAbstractGradientSP KisGradientConversion::toAbstractGradient ( KoStopGradientSP gradient )

Create a clone of a KoStopGradientSP and return it casted to a krita abstract gradient.

Parameters

gradient A KoStopGradientSP gradient to convert from

Returns: A clone of the input gradient casted to KoAbstractGradientSP

Definition at line 211 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        return gradient->clone().dynamicCast<KoAbstractGradient>();
    }

◆ toKoGradientStop()

KoGradientStop KisGradientConversion::toKoGradientStop	(	const KoColor &	color,
		KoGradientSegmentEndpointType	type,
		qreal	offset,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface )

Definition at line 272 of file KisGradientConversion.cpp.

    {
        KoGradientStop stop;
    
        stop.position = offset;
 
        if (type == FOREGROUND_ENDPOINT) {
            stop.type = FOREGROUNDSTOP;
            stop.color = color;
        } else if (type == FOREGROUND_TRANSPARENT_ENDPOINT) {
            stop.type = COLORSTOP;
            if (canvasResourcesInterface) {
                stop.color = canvasResourcesInterface->resource(KoCanvasResource::ForegroundColor).value<KoColor>();
            } else {
                stop.color = color;
            }
            stop.color.setOpacity(static_cast<quint8>(0));
        } else if (type == BACKGROUND_ENDPOINT) {
            stop.type = BACKGROUNDSTOP;
            stop.color = color;
        } else if (type == BACKGROUND_TRANSPARENT_ENDPOINT) {
            stop.type = COLORSTOP;
            if (canvasResourcesInterface) {
                stop.color = canvasResourcesInterface->resource(KoCanvasResource::BackgroundColor).value<KoColor>();
            } else {
                stop.color = color;
            }
            stop.color.setOpacity(static_cast<quint8>(0));
        } else {
            stop.type = COLORSTOP;
            stop.color = color;
        }
 
        return stop;
    }

References BACKGROUND_ENDPOINT, BACKGROUND_TRANSPARENT_ENDPOINT, KoCanvasResource::BackgroundColor, BACKGROUNDSTOP, KoGradientStop::color, COLORSTOP, FOREGROUND_ENDPOINT, FOREGROUND_TRANSPARENT_ENDPOINT, KoCanvasResource::ForegroundColor, FOREGROUNDSTOP, KoGradientStop::position, KoColor::setOpacity(), and KoGradientStop::type.

◆ toQGradient() [1/3]

KRITAPIGMENT_EXPORT QGradient * KisGradientConversion::toQGradient	(	KoAbstractGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoAbstractGradientSP to a QGradient.

This function makes use of toQGradient(KoStopGradientSP, KoCanvasResourcesInterfaceSP) and toQGradient(KoSegmentGradientSP, KoCanvasResourcesInterfaceSP)

Parameters

gradient	A KoAbstractGradientSP to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient stops should take the foreground/background color

Returns: QGradient containing stops with the positions and colors of the gradient

Definition at line 165 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        if (gradient.dynamicCast<KoStopGradient>()) {
            return toQGradient(gradient.dynamicCast<KoStopGradient>(), canvasResourcesInterface);
        } else if (gradient.dynamicCast<KoSegmentGradient>()) {
            return toQGradient(gradient.dynamicCast<KoSegmentGradient>(), canvasResourcesInterface);
        }
        return nullptr;
    }

References toQGradient().

◆ toQGradient() [2/3]

KRITAPIGMENT_EXPORT QGradient * KisGradientConversion::toQGradient	(	KoSegmentGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoSegmentGradientSP to a QGradient.

Creates a QLinearGradient and sets its stops using toQGradientStops(KoSegmentGradientSP, KoCanvasResourcesInterfaceSP)

Parameters

gradient	A KoSegmentGradientSP to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient stops should take the foreground/background color

Returns: QGradient containing stops with the positions and colors of the gradient

Definition at line 188 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        QGradient *qGradient = new QLinearGradient;
        qGradient->setStops(toQGradientStops(gradient, canvasResourcesInterface));
        return qGradient;
    }

References toQGradientStops().

◆ toQGradient() [3/3]

KRITAPIGMENT_EXPORT QGradient * KisGradientConversion::toQGradient	(	KoStopGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoStopGradientSP to a QGradient.

This function doesn't use the stop gradient's type and start/stop positions to create different types of QGradient. This just creates a QLinearGradient and sets its stops using toQGradientStops(KoStopGradientSP, KoCanvasResourcesInterfaceSP). To get the correct type of QGradient use KoStopGradient::toQGradient()

Parameters

gradient	A KoStopGradientSP to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient stops should take the foreground/background color

Returns: QGradient containing stops with the positions and colors of the gradient

Definition at line 178 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        QGradient *qGradient = new QLinearGradient;
        qGradient->setStops(toQGradientStops(gradient, canvasResourcesInterface));
        return qGradient;
    }

References toQGradientStops().

◆ toQGradientStop() [1/2]

QGradientStop KisGradientConversion::toQGradientStop	(	const KoColor &	color,
		KoGradientSegmentEndpointType	type,
		qreal	offset,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface )

Definition at line 82 of file KisGradientConversion.cpp.

    {
        QGradientStop stop;
        stop.first = offset;
 
        if (type == FOREGROUND_ENDPOINT) {
            if (canvasResourcesInterface) {
                canvasResourcesInterface->resource(KoCanvasResource::ForegroundColor).value<KoColor>().toQColor(&stop.second);
                return stop;
            }
        } else if (type == FOREGROUND_TRANSPARENT_ENDPOINT) {
            if (canvasResourcesInterface) {
                canvasResourcesInterface->resource(KoCanvasResource::ForegroundColor).value<KoColor>().toQColor(&stop.second);
                stop.second.setAlpha(0);
                return stop;
            }
        } else if (type == BACKGROUND_ENDPOINT) {
            if (canvasResourcesInterface) {
                canvasResourcesInterface->resource(KoCanvasResource::BackgroundColor).value<KoColor>().toQColor(&stop.second);
                return stop;
            }
        } else if (type == BACKGROUND_TRANSPARENT_ENDPOINT) {
            if (canvasResourcesInterface) {
                canvasResourcesInterface->resource(KoCanvasResource::BackgroundColor).value<KoColor>().toQColor(&stop.second);
                stop.second.setAlpha(0);
                return stop;
            }
        }
        
        color.toQColor(&stop.second);
        return stop;
    }

References BACKGROUND_ENDPOINT, BACKGROUND_TRANSPARENT_ENDPOINT, KoCanvasResource::BackgroundColor, FOREGROUND_ENDPOINT, FOREGROUND_TRANSPARENT_ENDPOINT, KoCanvasResource::ForegroundColor, and KoColor::toQColor().

◆ toQGradientStop() [2/2]

QGradientStop KisGradientConversion::toQGradientStop	(	const KoColor &	color,
		KoGradientStopType	type,
		qreal	position,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface )

Definition at line 32 of file KisGradientConversion.cpp.

    {
        QGradientStop stop;
        stop.first = position;
 
        if (type == FOREGROUNDSTOP) {
            if (canvasResourcesInterface) {
                canvasResourcesInterface->resource(KoCanvasResource::ForegroundColor).value<KoColor>().toQColor(&stop.second);
                return stop;
            }
        } else if (type == BACKGROUNDSTOP) {
            if (canvasResourcesInterface) {
                canvasResourcesInterface->resource(KoCanvasResource::BackgroundColor).value<KoColor>().toQColor(&stop.second);
                return stop;
            }
        }
        
        color.toQColor(&stop.second);
        return stop;
    }

References KoCanvasResource::BackgroundColor, BACKGROUNDSTOP, KoCanvasResource::ForegroundColor, FOREGROUNDSTOP, and KoColor::toQColor().

◆ toQGradientStops() [1/3]

KRITAPIGMENT_EXPORT QGradientStops KisGradientConversion::toQGradientStops	(	KoAbstractGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoAbstractGradientSP to a QGradientStop list.

This function makes use of toQGradientStops(KoStopGradientSP, KoCanvasResourcesInterfaceSP) and toQGradientStops(KoSegmentGradientSP, KoCanvasResourcesInterfaceSP)

Parameters

gradient	A KoAbstractGradientSP to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient stops should take the foreground/background color

Returns: QGradientStop list containing the positions and colors of the gradient

Definition at line 18 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return QGradientStops();
        }
        if (gradient.dynamicCast<KoStopGradient>()) {
            return toQGradientStops(gradient.dynamicCast<KoStopGradient>(), canvasResourcesInterface);
        } else if (gradient.dynamicCast<KoSegmentGradient>()) {
            return toQGradientStops(gradient.dynamicCast<KoSegmentGradient>(), canvasResourcesInterface);
        }
        return QGradientStops();
    }

References toQGradientStops().

◆ toQGradientStops() [2/3]

KRITAPIGMENT_EXPORT QGradientStops KisGradientConversion::toQGradientStops	(	KoSegmentGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoSegmentGradientSP to a QGradientStop list.

For each segment in the segment gradient two QGradientStop are created, one for the start point and another one for the end point.

To convert end points that have FOREGROUND_ENDPOINT, BACKGROUND_ENDPOINT, FOREGROUND_TRANSPARENT_ENDPOINT or BACKGROUND_TRANSPARENT_ENDPOINT type, the canvasResourcesInterface is used. If the canvasResourcesInterface is null, the color field of the end point is used.

The opacity of the QGradientStop color is set to 0 if the end point type is FOREGROUND_TRANSPARENT_ENDPOINT or BACKGROUND_TRANSPARENT_ENDPOINT.

If two QGradientStop turn out to be in the same position and have the same color, they are collapsed and only one stop is added to the list (This prevents having duplicated stops due to the end point of a segment being equal to the start point of the next segment).

The middle point, interpolation and color interpolation of the segment are ignored, so some information may be lost

Parameters

gradient	A KoSegmentGradientSP to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient stops should take the foreground/background color

Returns: QGradientStop list containing the positions and colors of the gradient

Definition at line 116 of file KisGradientConversion.cpp.

    {
        QGradientStops stops;
 
        if (!gradient) {
            return stops;
        }
 
        QGradientStop lastStop;
        lastStop.first = -1.0;
 
        for (KoGradientSegment *segment : gradient->segments()) {
            QGradientStop stop;
            
            stop = toQGradientStop(
                segment->startColor(), segment->startType(), segment->startOffset(),
                canvasResourcesInterface
            );
            if (qFuzzyCompare(stop.first, lastStop.first)) {
                if (stop.second != lastStop.second) {
                    stop.first = stop.first + 0.000001;
                    stops << stop;
                    lastStop = stop;
                }
            } else {
                stops << stop;
                lastStop = stop;
            }
            
            stop = toQGradientStop(
                segment->endColor(), segment->endType(), segment->endOffset(),
                canvasResourcesInterface
            );
            if (qFuzzyCompare(stop.first, lastStop.first)) {
                if (stop.second != lastStop.second) {
                    stop.first = stop.first + 0.000001;
                    stops << stop;
                    lastStop = stop;
                }
            } else {
                stops << stop;
                lastStop = stop;
            }
        }
 
        return stops;
    }

References qFuzzyCompare(), and toQGradientStop().

◆ toQGradientStops() [3/3]

KRITAPIGMENT_EXPORT QGradientStops KisGradientConversion::toQGradientStops	(	KoStopGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoStopGradientSP to a QGradientStop list.

For each stop in the stop gradient a QGradientStop is created.

To convert stops that have FOREGROUNDSTOP or BACKGROUNDSTOP type, the canvasResourcesInterface is used. If the canvasResourcesInterface is null, the color field of the stop is used

Parameters

gradient	A KoStopGradientSP to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient stops should take the foreground/background color

Returns: QGradientStop list containing the positions and colors of the gradient

Definition at line 54 of file KisGradientConversion.cpp.

    {
        QGradientStops stops;
 
        if (!gradient) {
            return stops;
        }
 
        qreal lastStopPosition = -1.0;
        for (const KoGradientStop &stopGradientStop : gradient->stops()) {
            if (qFuzzyCompare(stopGradientStop.position, lastStopPosition)) {
                stops << toQGradientStop(
                    stopGradientStop.color, stopGradientStop.type, stopGradientStop.position + 0.000001,
                    canvasResourcesInterface
                );
                lastStopPosition = stopGradientStop.position + 0.000001;
            } else {
                stops << toQGradientStop(
                    stopGradientStop.color, stopGradientStop.type, stopGradientStop.position,
                    canvasResourcesInterface
                );
                lastStopPosition = stopGradientStop.position;
            }
        }
        return stops;
    }

References qFuzzyCompare(), and toQGradientStop().

◆ toSegmentGradient() [1/4]

KRITAPIGMENT_EXPORT KoSegmentGradientSP KisGradientConversion::toSegmentGradient ( const QGradient * gradient )

Convert a QGradient to a krita segment gradient.

Creates a segment gradient from the stops of the QGradient using toSegmentGradient(const QGradientStops &)

Parameters

gradient A QGradient with the stops of the gradient

Returns: KoSegmentGradientSP containing segments with the positions and colors of the gradient

Definition at line 381 of file KisGradientConversion.cpp.

    {
        if (!gradient || gradient->type() == QGradient::NoGradient) {
            return nullptr;
        }
        KoSegmentGradientSP segmentGradient = toSegmentGradient(gradient->stops());
        segmentGradient->setType(gradient->type());
        segmentGradient->setSpread(gradient->spread());
        return segmentGradient;
    }

References toSegmentGradient().

◆ toSegmentGradient() [2/4]

KRITAPIGMENT_EXPORT KoSegmentGradientSP KisGradientConversion::toSegmentGradient ( const QGradientStops & gradient )

Convert a QGradientStop list to a krita segment gradient.

If two stops have the same position a new segment between them is not created

Parameters

gradient A QGradientStop list with the stops of the gradient

Returns: KoSegmentGradientSP containing segments with the positions and colors of the gradient

Definition at line 360 of file KisGradientConversion.cpp.

    {
        KoSegmentGradientSP segmentGradient(new KoSegmentGradient);
        const QGradientStops &stops = gradient;
 
        for (int i = 0; i < stops.size() - 1; ++i) {
            if (qFuzzyCompare(stops[i].first, stops[i + 1].first)) {
                continue;
            }
            segmentGradient->createSegment(
                INTERP_LINEAR, COLOR_INTERP_RGB,
                stops[i].first, stops[i + 1].first, (stops[i].first + stops[i + 1].first) / 2,
                stops[i].second, stops[i + 1].second
            );
        }
 
        segmentGradient->setValid(true);
        
        return segmentGradient;
    }

References COLOR_INTERP_RGB, INTERP_LINEAR, and qFuzzyCompare().

◆ toSegmentGradient() [3/4]

KRITAPIGMENT_EXPORT KoSegmentGradientSP KisGradientConversion::toSegmentGradient ( KoAbstractGradientSP gradient )

Convert a krita abstract gradient to a krita segment gradient.

If the underlying gradient is a stop gradient, toSegmentGradient(KoStopGradientSP) is used; otherwise, if it is a segment gradient, a clone is returned

Parameters

gradient A KoAbstractGradientSP to convert from

Returns: KoSegmentGradientSP containing segments with the positions and colors of the gradient

Definition at line 392 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        if (gradient.dynamicCast<KoSegmentGradient>()) {
            return gradient->clone().dynamicCast<KoSegmentGradient>();
        } else if (gradient.dynamicCast<KoStopGradient>()) {
            return toSegmentGradient(gradient.dynamicCast<KoStopGradient>());
        }
        return nullptr;
    }

References toSegmentGradient().

◆ toSegmentGradient() [4/4]

KRITAPIGMENT_EXPORT KoSegmentGradientSP KisGradientConversion::toSegmentGradient ( KoStopGradientSP gradient )

Convert a krita stop gradient to a krita segment gradient.

If two stops have the same position a new segment is not created

Parameters

gradient A KoStopGradientSP to convert from

Returns: KoSegmentGradientSP containing segments with the positions and colors of the gradient

Definition at line 405 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
 
        KoSegmentGradientSP segmentGradient(new KoSegmentGradient);
        QList<KoGradientStop> stops = gradient->stops();
 
        for (int i = 0; i < stops.size() - 1; ++i) {
            if (qFuzzyCompare(stops[i].position, stops[i + 1].position)) {
                continue;
            }
 
            KoGradientSegmentEndpointType startType, endType;
            const KoGradientStopType startStopType = stops[i].type;
            const KoGradientStopType endStopType = stops[i + 1].type;
 
            if (startStopType == FOREGROUNDSTOP) {
                startType = FOREGROUND_ENDPOINT;
            } else if (startStopType == BACKGROUNDSTOP) {
                startType = BACKGROUND_ENDPOINT;
            } else {
                startType = COLOR_ENDPOINT;
            }
 
            if (endStopType == FOREGROUNDSTOP) {
                endType = FOREGROUND_ENDPOINT;
            } else if (endStopType == BACKGROUNDSTOP) {
                endType = BACKGROUND_ENDPOINT;
            } else {
                endType = COLOR_ENDPOINT;
            }
            
            segmentGradient->createSegment(
                INTERP_LINEAR, COLOR_INTERP_RGB,
                stops[i].position, stops[i + 1].position, (stops[i].position + stops[i + 1].position) / 2,
                stops[i].color.toQColor(), stops[i + 1].color.toQColor(),
                startType, endType
            );
        }
 
        segmentGradient->setType(gradient->type());
        segmentGradient->setSpread(gradient->spread());
 
        segmentGradient->setName(gradient->name());
        segmentGradient->setFilename(gradient->filename());
        segmentGradient->setValid(true);
 
        return segmentGradient;
    }

References BACKGROUND_ENDPOINT, BACKGROUNDSTOP, COLOR_ENDPOINT, COLOR_INTERP_RGB, FOREGROUND_ENDPOINT, FOREGROUNDSTOP, INTERP_LINEAR, and qFuzzyCompare().

◆ toStopGradient() [1/4]

KRITAPIGMENT_EXPORT KoStopGradientSP KisGradientConversion::toStopGradient ( const QGradient * gradient )

Convert the stops of a QGradient to a KoStopGradientSP.

Parameters

gradient A QGradient with the stops of the gradient

Returns: KoStopGradientSP containing stops with the positions and colors of the gradient

Definition at line 247 of file KisGradientConversion.cpp.

    {
        if (!gradient || gradient->type() == QGradient::NoGradient) {
            return nullptr;
        }
        KoStopGradientSP stopGradient = toStopGradient(gradient->stops());
        stopGradient->setType(gradient->type());
        stopGradient->setSpread(gradient->spread());
        return stopGradient;
    }

References toStopGradient().

◆ toStopGradient() [2/4]

KRITAPIGMENT_EXPORT KoStopGradientSP KisGradientConversion::toStopGradient ( const QGradientStops & gradient )

Convert a QGradientStop list to a KoStopGradientSP.

Parameters

gradient A QGradientStop list with the stops of the gradient

Returns: KoStopGradientSP containing stops with the positions and colors of the gradient

Definition at line 227 of file KisGradientConversion.cpp.

    {
        KoStopGradientSP stopGradient(new KoStopGradient);
        QList<KoGradientStop> stops;
 
        for (const QGradientStop &qGradientStop : gradient) {
            KoGradientStop stop;
            stop.type = COLORSTOP;
            stop.position = qGradientStop.first;
            stop.color = KoColor(qGradientStop.second, stopGradient->colorSpace());
            stops << stop;
        }
 
        stopGradient->setStops(stops);
        stopGradient->setType(QGradient::LinearGradient);
        stopGradient->setValid(true);
 
        return stopGradient;
    }

References KoGradientStop::color, COLORSTOP, KoGradientStop::position, and KoGradientStop::type.

◆ toStopGradient() [3/4]

KRITAPIGMENT_EXPORT KoStopGradientSP KisGradientConversion::toStopGradient	(	KoAbstractGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoAbstractGradientSP to a KoStopGradientSP.

If the underlying gradient is a segment gradient, toStopGradient(KoSegmentGradientSP, KoCanvasResourcesInterfaceSP) is used; otherwise, if it is a stop gradient, a clone is returned

Parameters

gradient A KoAbstractGradientSP to convert from

Returns: KoStopGradientSP containing stops with the positions and colors of the gradient

Definition at line 258 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
        if (gradient.dynamicCast<KoStopGradient>()) {
            return gradient->clone().dynamicCast<KoStopGradient>();
        } else if (gradient.dynamicCast<KoSegmentGradient>()) {
            return toStopGradient(gradient.dynamicCast<KoSegmentGradient>(), canvasResourcesInterface);
        }
        return nullptr;
    }

References toStopGradient().

◆ toStopGradient() [4/4]

KRITAPIGMENT_EXPORT KoStopGradientSP KisGradientConversion::toStopGradient	(	KoSegmentGradientSP	gradient,
		KoCanvasResourcesInterfaceSP	canvasResourcesInterface = nullptr )

Convert a KoSegmentGradientSP to a KoStopGradientSP.

For each segment in the segment gradient two stops are created, one for the start point and another one for the end point.

To convert end points that have FOREGROUND_TRANSPARENT_ENDPOINT or BACKGROUND_TRANSPARENT_ENDPOINT type, the stop type is set to the COLORSTOP and the canvasResourcesInterface is used to set the stop color if it is not null. If the canvasResourcesInterface is null, the color field of the end point is used.

The opacity of the stop color is set to 0 if the end point type is FOREGROUND_TRANSPARENT_ENDPOINT or BACKGROUND_TRANSPARENT_ENDPOINT.

If two stops turn out to be in the same position and have the same type and color, they are collapsed and only one stop is added to the list (This prevents having duplicated stops due to the end point of a segment being equal to the start point of the next segment).

The middle point, interpolation and color interpolation of the segment are ignored, so some information may be lost

Parameters

gradient	A KoSegmentGradientSP gradient to convert from
canvasResourcesInterface	KoCanvasResourcesInterfaceSP used if some of the gradient end points have FOREGROUND_TRANSPARENT_ENDPOINT or BACKGROUND_TRANSPARENT_ENDPOINT type

Returns: KoStopGradientSP containing stops with the positions and colors of the gradient

Definition at line 309 of file KisGradientConversion.cpp.

    {
        if (!gradient) {
            return nullptr;
        }
 
        KoStopGradientSP stopGradient(new KoStopGradient);
        QList<KoGradientStop> stops;
 
        KoGradientStop lastStop;
        lastStop.position = -1.0;
 
        for (KoGradientSegment *segment : gradient->segments()) {
            KoGradientStop stop;
            
            stop = toKoGradientStop(
                segment->startColor(), segment->startType(), segment->startOffset(),
                canvasResourcesInterface
            );
            stop.color.convertTo(stopGradient->colorSpace());
            if (!qFuzzyCompare(stop.position, lastStop.position) || stop.type != lastStop.type || stop.color != lastStop.color) {
                stops << stop;
                lastStop.type = stop.type;
                lastStop.color = stop.color;
                lastStop.position = stop.position;
            }
            
            stop = toKoGradientStop(
                segment->endColor(), segment->endType(), segment->endOffset(),
                canvasResourcesInterface
            );
            stop.color.convertTo(stopGradient->colorSpace());
            if (!qFuzzyCompare(stop.position, lastStop.position) || stop.type != lastStop.type || stop.color != lastStop.color) {
                stops << stop;
                lastStop.type = stop.type;
                lastStop.color = stop.color;
                lastStop.position = stop.position;
            }
        }
 
        stopGradient->setType(gradient->type());
        stopGradient->setSpread(gradient->spread());
        stopGradient->setStops(stops);
 
        stopGradient->setName(gradient->name());
        stopGradient->setFilename(gradient->filename());
        stopGradient->setValid(true);
 
        return stopGradient;
    }

References KoGradientStop::color, KoColor::convertTo(), KoGradientStop::position, qFuzzyCompare(), toKoGradientStop(), and KoGradientStop::type.

Functions

Detailed Description

Function Documentation

◆ toAbstractGradient() [1/4]

◆ toAbstractGradient() [2/4]

◆ toAbstractGradient() [3/4]

◆ toAbstractGradient() [4/4]

◆ toKoGradientStop()

◆ toQGradient() [1/3]

◆ toQGradient() [2/3]

◆ toQGradient() [3/3]

◆ toQGradientStop() [1/2]

◆ toQGradientStop() [2/2]

◆ toQGradientStops() [1/3]

◆ toQGradientStops() [2/3]

◆ toQGradientStops() [3/3]

◆ toSegmentGradient() [1/4]

◆ toSegmentGradient() [2/4]

◆ toSegmentGradient() [3/4]

◆ toSegmentGradient() [4/4]

◆ toStopGradient() [1/4]

◆ toStopGradient() [2/4]

◆ toStopGradient() [3/4]

◆ toStopGradient() [4/4]