The KisReferenceImage class represents a single reference image. More...

#include <KisReferenceImage.h>

Inheritance diagram for KisReferenceImage:

Classes
struct	Private

struct	SetSaturationCommand

Public Member Functions
KoShape *	cloneShape () const override
	creates a deep copy of the shape or shape's subtree

bool	embed ()

QString	filename () const

QImage	getImage ()

QColor	getPixel (QPointF position)

bool	hasLocalFile ()

QString	internalFile () const

	KisReferenceImage ()

	KisReferenceImage (const KisReferenceImage &rhs)

bool	loadImage (KoStore *store)

void	paint (QPainter &gc) const override
	Paint the shape fill The class extending this one is responsible for painting itself. `painter` is expected to be preconfigured to work in "document" pixels.

qreal	saturation () const

bool	saveImage (KoStore *store) const

void	saveXml (QDomDocument &document, QDomElement &parentElement, int id)

void	setEmbed (bool embed)

void	setFilename (const QString &filename)

void	setSaturation (qreal saturation)

	~KisReferenceImage ()

Public Member Functions inherited from KoShape
QRectF	absoluteOutlineRect () const

QPointF	absolutePosition (KoFlake::AnchorPosition anchor=KoFlake::Center) const

QTransform	absoluteTransformation () const

bool	addDependee (KoShape *shape)

QString	additionalAttribute (const QString &name) const

void	addShapeChangeListener (ShapeChangeListener *listener)

KoShapeAnchor *	anchor () const

void	applyAbsoluteTransformation (const QTransform &matrix)

void	applyTransformation (const QTransform &matrix)

virtual QSharedPointer< KoShapeBackground >	background () const

virtual QRectF	boundingRect () const
	Get the bounding box of the shape.

virtual ChildZOrderPolicy	childZOrderPolicy ()

KoClipMask *	clipMask () const
	Returns the currently set clip mask or 0 if there is no clip mask set.

KoClipPath *	clipPath () const
	Returns the currently set clip path or 0 if there is no clip path set.

KoShape *	cloneShapeAndBakeAbsoluteTransform () const
	creates a deep copy of the shape/shapes tree and bakes the absolute transform of `this` into the resulting shape.

void	copySettings (const KoShape *shape)

QList< KoShape * >	dependees () const
	Returns list of shapes depending on this shape.

QPointF	documentToShape (const QPointF &point) const
	Transforms point from document coordinates to shape coordinates.

QRectF	documentToShape (const QRectF &rect) const
	Transform rect from document coordinates to shape coordinates.

bool	hasAdditionalAttribute (const QString &name) const

bool	hasCommonParent (const KoShape *shape) const

bool	hasDependee (KoShape *shape) const
	Returns if the given shape is dependent on this shape.

virtual bool	hasTransparency () const

virtual bool	hitTest (const QPointF &position) const
	Check if the shape is hit on position.

QString	hyperLink () const

bool	inheritBackground () const
	inheritBackground shows if the shape inherits background from its parent

bool	inheritPaintOrder () const
	inheritPaintOrder

bool	inheritsTransformFromAny (const QList< KoShape * > ancestorsInQuestion) const
	inheritsTransformFromAny checks if the shape inherits transformation from any of the shapes listed in `ancestorsInQuestion`. The inheritance is checked in recursive way.

bool	inheritStroke () const
	inheritStroke shows if the shape inherits the stroke from its parent

bool	isContentProtected () const

bool	isGeometryProtected () const

bool	isPrintable () const

bool	isSelectable () const

virtual bool	isShapeEditable (bool recursive=true) const
	checks recursively if the shape or one of its parents is not visible or locked

bool	isVisible (bool recursive=true) const

bool	keepAspectRatio () const

	KoShape ()
	Constructor.

qreal	minimumHeight () const

QString	name () const

void	notifyChanged ()

virtual QPainterPath	outline () const

virtual QRectF	outlineRect () const

virtual void	paintMarkers (QPainter &painter) const
	paintStroke paints the shape's markers

virtual QVector< PaintOrder >	paintOrder () const
	paintOrder

virtual void	paintStroke (QPainter &painter) const
	paintStroke paints the shape's stroked outline

KoShapeContainer *	parent () const

QPointF	position () const
	Get the position of the shape in pt.

void	removeAdditionalAttribute (const QString &name)

void	removeAdditionalStyleAttribute (const char *name)

void	removeDependee (KoShape *shape)

void	removeShapeChangeListener (ShapeChangeListener *listener)

void	rotate (qreal angle)
	Rotate the shape (relative)

qreal	rotation () const

void	scale (qreal sx, qreal sy)
	Scale the shape using the zero-point which is the top-left corner.

void	setAbsolutePosition (const QPointF &newPosition, KoFlake::AnchorPosition anchor=KoFlake::Center)

void	setAdditionalAttribute (const QString &name, const QString &value)

void	setAdditionalStyleAttribute (const char *name, const QString &value)

void	setAnchor (KoShapeAnchor *anchor)

virtual void	setBackground (QSharedPointer< KoShapeBackground > background)

void	setClipMask (KoClipMask *clipMask)
	Sets a new clip mask, removing the old one. The mask is owned by the shape.

void	setClipPath (KoClipPath *clipPath)
	Sets a new clip path, removing the old one.

void	setContentProtected (bool protect)

void	setGeometryProtected (bool on)

void	setHyperLink (const QString &hyperLink)

void	setInheritBackground (bool value)
	setInheritBackground marks a shape as inheriting the background from the parent shape. NOTE: The currently selected background is destroyed.

void	setInheritPaintOrder (bool value)
	setInheritPaintOrder set inherit paint order.

void	setInheritStroke (bool value)
	setInheritStroke marks a shape as inheriting the stroke from the parent shape. NOTE: The currently selected stroke is destroyed.

void	setKeepAspectRatio (bool keepAspect)

void	setMinimumHeight (qreal height)

void	setName (const QString &name)

virtual void	setPaintOrder (PaintOrder first, PaintOrder second)
	setPaintOrder set the paint order. As there's only three entries in any given paintorder, you only need to have the first and second entry to set it.

void	setParent (KoShapeContainer *parent)

virtual void	setPosition (const QPointF &position)
	Set the position of the shape in pt.

void	setPrintable (bool on)

virtual void	setResolution (qreal xRes, qreal yRes)

void	setSelectable (bool selectable)

void	setShapeId (const QString &id)

virtual void	setSize (const QSizeF &size)
	Resize the shape.

virtual void	setStroke (KoShapeStrokeModelSP stroke)

void	setToolDelegates (const QSet< KoShape * > &delegates)

void	setTransformation (const QTransform &matrix)

void	setTransparency (qreal transparency)

void	setUserData (KoShapeUserData *userData)

void	setVisible (bool on)

void	setZIndex (qint16 zIndex)

QString	shapeId () const

QPointF	shapeToDocument (const QPointF &point) const
	Transforms point from shape coordinates to document coordinates.

QRectF	shapeToDocument (const QRectF &rect) const
	Transforms rect from shape coordinates to document coordinates.

void	shear (qreal sx, qreal sy)
	Shear the shape The shape will be sheared using the zero-point which is the top-left corner.

virtual QSizeF	size () const
	Get the size of the shape in pt.

virtual KoSnapData	snapData () const
	Returns additional snap data the shape wants to have snapping to.

virtual KoShapeStrokeModelSP	stroke () const

KoInsets	strokeInsets () const

QSet< KoShape * >	toolDelegates () const

QTransform	transformation () const
	Returns the shapes local transformation matrix.

qreal	transparency (bool recursive=false) const

virtual void	update () const

virtual void	updateAbsolute (const QRectF &rect) const

KoShapeUserData *	userData () const

virtual void	waitUntilReady (bool asynchronous=true) const

qint16	zIndex () const

virtual	~KoShape ()
	Destructor.

Static Public Member Functions
static KisReferenceImage *	fromClipboard (const KisCoordinatesConverter &converter)

static KisReferenceImage *	fromFile (const QString &filename, const KisCoordinatesConverter &converter, QWidget *parent)

static KisReferenceImage *	fromPaintDevice (KisPaintDeviceSP src, const KisCoordinatesConverter &converter, QWidget *parent)

static KisReferenceImage *	fromQImage (const KisCoordinatesConverter &converter, const QImage &img)

static KisReferenceImage *	fromXml (const QDomElement &elem)

Static Public Member Functions inherited from KoShape
static QRectF	absoluteOutlineRect (const QList< KoShape * > &shapes)

static QRectF	boundingRect (const QList< KoShape * > &shapes)

static bool	compareShapeZIndex (KoShape s1, KoShape s2)

static KisHandlePainterHelper	createHandlePainterHelperDocument (QPainter painter, KoShape shape, qreal handleRadius, int decorationThickness)

static KisHandlePainterHelper	createHandlePainterHelperView (QPainter painter, KoShape shape, const KoViewConverter &converter, qreal handleRadius=0.0, int decorationThickness=1)

static QVector< PaintOrder >	defaultPaintOrder ()
	default paint order as per SVG specification

static QList< KoShape * >	linearizeSubtree (const QList< KoShape * > &shapes)

static QList< KoShape * >	linearizeSubtreeSorted (const QList< KoShape * > &shapes)

Private Attributes
QSharedDataPointer< Private >	d

Additional Inherited Members
Public Types inherited from KoShape
enum	ChangeType { PositionChanged , RotationChanged , ScaleChanged , ShearChanged , SizeChanged , GenericMatrixChange , KeepAspectRatioChange , ParentChanged , Deleted , StrokeChanged , BackgroundChanged , BorderChanged , ParameterChanged , ContentChanged , TextContourMarginChanged , ChildChanged , ConnectionPointChanged , ClipPathChanged , ClipMaskChanged , TransparencyChanged }
	Used by shapeChanged() to select which change was made. More...

enum	ChildZOrderPolicy { ChildZDefault , ChildZParentChild = ChildZDefault , ChildZPassThrough }
	Used by compareShapeZIndex() to order shapes. More...

enum	PaintOrder { Fill , Stroke , Markers }

Static Public Attributes inherited from KoShape
static const qint16	maxZIndex = std::numeric_limits<qint16>::max()

static const qint16	minZIndex = std::numeric_limits<qint16>::min()

Protected Member Functions inherited from KoShape
	KoShape (const KoShape &rhs)

QList< ShapeChangeListener * >	listeners () const

void	setSizeImpl (const QSizeF &size) const

virtual void	shapeChanged (ChangeType type, KoShape *shape=0)

void	shapeChangedPriv (KoShape::ChangeType type)

QTransform	transform () const
	return the current matrix that contains the rotation/scale/position of this shape

Detailed Description

The KisReferenceImage class represents a single reference image.

Definition at line 29 of file KisReferenceImage.h.

Constructor & Destructor Documentation

◆ KisReferenceImage() [1/2]

KisReferenceImage::KisReferenceImage ( )

Definition at line 147 of file KisReferenceImage.cpp.

    : d(new Private())
{
    setKeepAspectRatio(true);
}

References KoShape::setKeepAspectRatio().

◆ KisReferenceImage() [2/2]

KisReferenceImage::KisReferenceImage ( const KisReferenceImage & rhs )

Definition at line 153 of file KisReferenceImage.cpp.

    : KoShape(rhs)
    , d(rhs.d)
{}

◆ ~KisReferenceImage()

KisReferenceImage::~KisReferenceImage ( )

Definition at line 158 of file KisReferenceImage.cpp.

159{}

Member Function Documentation

◆ cloneShape()

KoShape * KisReferenceImage::cloneShape ( ) const

overridevirtual

creates a deep copy of the shape or shape's subtree

Returns: a cloned shape

Reimplemented from KoShape.

Definition at line 423 of file KisReferenceImage.cpp.

{
    return new KisReferenceImage(*this);
}

References KisReferenceImage().

◆ embed()

bool KisReferenceImage::embed ( )

Definition at line 279 of file KisReferenceImage.cpp.

{
    return d->embed;
}

References d.

◆ filename()

QString KisReferenceImage::filename ( ) const

Definition at line 289 of file KisReferenceImage.cpp.

{
    return d->externalFilename;
}

References d.

◆ fromClipboard()

KisReferenceImage * KisReferenceImage::fromClipboard ( const KisCoordinatesConverter & converter )

static

Definition at line 184 of file KisReferenceImage.cpp.

{
    const auto sz = KisClipboard::instance()->clipSize();
    KisPaintDeviceSP clip = KisClipboard::instance()->clip({0, 0, sz.width(), sz.height()}, true);
    return fromPaintDevice(clip, converter, nullptr);
}

References KisClipboard::clip, KisClipboard::clipSize(), fromPaintDevice(), and KisClipboard::instance().

◆ fromFile()

KisReferenceImage * KisReferenceImage::fromFile	(	const QString &	filename,
		const KisCoordinatesConverter &	converter,
		QWidget *	parent )

static

Load a reference image from specified file. If parent is provided and the image cannot be loaded, a warning message will be displayed to user.

Returns: reference image or null if one could not be loaded

Definition at line 161 of file KisReferenceImage.cpp.

{
    KisReferenceImage *reference = new KisReferenceImage();
    reference->d->externalFilename = filename;
    bool ok = reference->d->loadFromFile();
 
    if (ok) {
        QRect r = QRect(QPoint(), reference->d->image.size());
        QSizeF shapeSize = converter.imageToDocument(r).size();
        reference->setSize(shapeSize);
    } else {
        delete reference;
 
        if (parent) {
            QMessageBox::critical(parent, i18nc("@title:window", "Krita"), i18n("Could not load %1.", filename));
        }
 
        return nullptr;
    }
 
    return reference;
}

References d, filename(), KisCoordinatesConverter::imageToDocument(), KisReferenceImage(), KoShape::parent(), and KoShape::setSize().

◆ fromPaintDevice()

KisReferenceImage * KisReferenceImage::fromPaintDevice	(	KisPaintDeviceSP	src,
		const KisCoordinatesConverter &	converter,
		QWidget *	parent )

static

Load a reference image from specified paint device.

Returns: reference image or null if one could not be loaded

Definition at line 192 of file KisReferenceImage.cpp.

{
    if (!src) {
        return nullptr;
    }
 
    auto *reference = new KisReferenceImage();
    reference->d->image = src->convertToQImage(KoColorSpaceRegistry::instance()->p709SRGBProfile());
 
    QRect r = QRect(QPoint(), reference->d->image.size());
    QSizeF size = converter.imageToDocument(r).size();
    reference->setSize(size);
 
    return reference;
}

References KisCoordinatesConverter::imageToDocument(), KoColorSpaceRegistry::instance(), KisReferenceImage(), and KoShape::size().

◆ fromQImage()

KisReferenceImage * KisReferenceImage::fromQImage	(	const KisCoordinatesConverter &	converter,
		const QImage &	img )

static

Definition at line 208 of file KisReferenceImage.cpp.

{
    KisReferenceImage *reference = new KisReferenceImage();
    bool ok = reference->d->loadFromQImage(img);
 
    if (ok) {
        QRect r = QRect(QPoint(), reference->d->image.size());
        QSizeF size = converter.imageToDocument(r).size();
        reference->setSize(size);
    } else {
        delete reference;
        reference = 0;
    }
 
    return reference;
}

References d, KisCoordinatesConverter::imageToDocument(), KisReferenceImage(), KoShape::setSize(), and KoShape::size().

◆ fromXml()

KisReferenceImage * KisReferenceImage::fromXml ( const QDomElement & elem )

static

Definition at line 347 of file KisReferenceImage.cpp.

{
    auto *reference = new KisReferenceImage();
 
    const QString &src = elem.attribute("src");
 
    if (src.startsWith("file://")) {
        reference->d->externalFilename = src.mid(7);
        reference->d->embed = false;
    } else {
        reference->d->internalFilename = src;
        reference->d->embed = true;
    }
 
    qreal width = KisDomUtils::toDouble(elem.attribute("width", "100"));
    qreal height = KisDomUtils::toDouble(elem.attribute("height", "100"));
    reference->setSize(QSizeF(width, height));
    reference->setKeepAspectRatio(elem.attribute("keepAspectRatio", "true").toLower() == "true");
 
    auto transform = SvgTransformParser(elem.attribute("transform")).transform();
    reference->setTransformation(transform);
 
    qreal opacity = KisDomUtils::toDouble(elem.attribute("opacity", "1"));
    reference->setTransparency(1.0 - opacity);
 
    qreal saturation = KisDomUtils::toDouble(elem.attribute("saturation", "1"));
    reference->setSaturation(saturation);
 
    return reference;
}

References KisReferenceImage(), saturation(), KisDomUtils::toDouble(), KoShape::transform(), and SvgTransformParser::transform().

◆ getImage()

QImage KisReferenceImage::getImage ( )

Definition at line 418 of file KisReferenceImage.cpp.

{
    return d->image;
}

References d.

◆ getPixel()

QColor KisReferenceImage::getPixel ( QPointF position )

Definition at line 305 of file KisReferenceImage.cpp.

{
    if (transparency() == 1.0) return Qt::transparent;
 
    const QSizeF shapeSize = size();
    const QTransform scale = QTransform::fromScale(d->image.width() / shapeSize.width(), d->image.height() / shapeSize.height());
 
    const QTransform transform = absoluteTransformation().inverted() * scale;
    const QPointF localPosition = position * transform;
 
    if (d->cachedImage.isNull()) {
        d->updateCache();
    }
 
    return d->cachedImage.pixelColor(localPosition.toPoint());
}

References KoShape::absoluteTransformation(), d, KoShape::position(), KoShape::scale(), KoShape::size(), KoShape::transform(), and KoShape::transparency().

◆ hasLocalFile()

bool KisReferenceImage::hasLocalFile ( )

Definition at line 284 of file KisReferenceImage.cpp.

{
    return !d->externalFilename.isEmpty();
}

References d.

◆ internalFile()

QString KisReferenceImage::internalFile ( ) const

Definition at line 294 of file KisReferenceImage.cpp.

{
    return d->internalFilename;
}

References d.

◆ loadImage()

bool KisReferenceImage::loadImage ( KoStore * store )

Definition at line 396 of file KisReferenceImage.cpp.

{
    if (!d->embed) {
        return d->loadFromFile();
    }
 
    if (!store->open(d->internalFilename)) {
        return false;
    }
 
    KoStoreDevice storeDev(store);
    if (!storeDev.open(QIODevice::ReadOnly)) {
        return false;
    }
 
    if (!d->image.load(&storeDev, "PNG")) {
        return false;
    }
 
    return store->close();
}

References KoStore::close(), d, KoStore::open(), and KoStoreDevice::open().

◆ paint()

void KisReferenceImage::paint ( QPainter & painter ) const

overridevirtual

Paint the shape fill The class extending this one is responsible for painting itself. painter is expected to be preconfigured to work in "document" pixels.

Parameters

painter used for painting the shape

Implements KoShape.

Definition at line 225 of file KisReferenceImage.cpp.

{
    if (!parent()) return;
 
    gc.save();
 
    QSizeF shapeSize = size();
    // scale and rotation done by the user (excluding zoom)
    QTransform transform = QTransform::fromScale(shapeSize.width() / d->image.width(), shapeSize.height() / d->image.height());
 
    if (d->cachedImage.isNull()) {
        // detach the data
        const_cast<KisReferenceImage*>(this)->d->updateCache();
    }
 
    qreal scale;
    // scale from the highDPI display
    QTransform devicePixelRatioFTransform = QTransform::fromScale(gc.device()->devicePixelRatioF(), gc.device()->devicePixelRatioF());
    // all three transformations: scale and rotation done by the user, scale from highDPI display, and zoom + rotation of the view
    // order: zoom/rotation of the view; scale to high res; scale and rotation done by the user
    QImage prescaled = d->mipmap.getClosestWithoutWorkaroundBorder(transform * devicePixelRatioFTransform * gc.transform(), &scale);
    transform.scale(1.0 / scale, 1.0 / scale);
 
    if (scale > 1.0) {
        // enlarging should be done without smooth transformation
        // so the user can see pixels just as they are painted
        gc.setRenderHints(QPainter::Antialiasing);
    } else {
        gc.setRenderHints(QPainter::Antialiasing | QPainter::SmoothPixmapTransform);
    }
    gc.setClipRect(QRectF(QPointF(), shapeSize), Qt::IntersectClip);
    gc.setTransform(transform, true);
    gc.drawImage(QPoint(), prescaled);
 
    gc.restore();
}

References d, KoShape::parent(), KoShape::scale(), KoShape::size(), and KoShape::transform().

◆ saturation()

qreal KisReferenceImage::saturation ( ) const

Definition at line 268 of file KisReferenceImage.cpp.

{
    return d->saturation;
}

References d.

◆ saveImage()

bool KisReferenceImage::saveImage ( KoStore * store ) const

Definition at line 378 of file KisReferenceImage.cpp.

{
    if (!d->embed) return true;
 
    if (!store->open(d->internalFilename)) {
        return false;
    }
 
    bool saved = false;
 
    KoStoreDevice storeDev(store);
    if (storeDev.open(QIODevice::WriteOnly)) {
        saved = d->image.save(&storeDev, "PNG");
    }
 
    return store->close() && saved;
}

References KoStore::close(), d, KoStore::open(), and KoStoreDevice::open().

◆ saveXml()

void KisReferenceImage::saveXml	(	QDomDocument &	document,
		QDomElement &	parentElement,
		int	id )

Definition at line 322 of file KisReferenceImage.cpp.

{
    d->id = id;
 
    QDomElement element = document.createElement("referenceimage");
 
    if (d->embed) {
        d->internalFilename = QString("reference_images/%1.png").arg(id);
    }
    
    const QString src = d->embed ? d->internalFilename : (QString("file://") + d->externalFilename);
    element.setAttribute("src", src);
 
    const QSizeF &shapeSize = size();
    element.setAttribute("width", KisDomUtils::toString(shapeSize.width()));
    element.setAttribute("height", KisDomUtils::toString(shapeSize.height()));
    element.setAttribute("keepAspectRatio", keepAspectRatio() ? "true" : "false");
    element.setAttribute("transform", SvgUtil::transformToString(transform()));
 
    element.setAttribute("opacity", KisDomUtils::toString(1.0 - transparency()));
    element.setAttribute("saturation", KisDomUtils::toString(d->saturation));
 
    parentElement.appendChild(element);
}

References d, KoShape::keepAspectRatio(), KoShape::size(), KisDomUtils::toString(), KoShape::transform(), SvgUtil::transformToString(), and KoShape::transparency().

◆ setEmbed()

void KisReferenceImage::setEmbed ( bool embed )

Definition at line 273 of file KisReferenceImage.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(embed || !d->externalFilename.isEmpty());
    d->embed = embed;
}

References d, embed(), and KIS_SAFE_ASSERT_RECOVER_RETURN.

◆ setFilename()

void KisReferenceImage::setFilename ( const QString & filename )

Definition at line 300 of file KisReferenceImage.cpp.

{
    d->externalFilename = filename;
}

References d, and filename().

◆ setSaturation()

void KisReferenceImage::setSaturation ( qreal saturation )

Definition at line 262 of file KisReferenceImage.cpp.

{
    d->saturation = saturation;
    d->cachedImage = QImage();
}

References d, and saturation().

Member Data Documentation

◆ d

QSharedDataPointer<Private> KisReferenceImage::d

private

Definition at line 89 of file KisReferenceImage.h.

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

libs/ui/KisReferenceImage.h
libs/ui/KisReferenceImage.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisReferenceImage() [1/2]

◆ KisReferenceImage() [2/2]

◆ ~KisReferenceImage()

Member Function Documentation

◆ cloneShape()

◆ embed()

◆ filename()

◆ fromClipboard()

◆ fromFile()

◆ fromPaintDevice()

◆ fromQImage()

◆ fromXml()

◆ getImage()

◆ getPixel()

◆ hasLocalFile()

◆ internalFile()

◆ loadImage()

◆ paint()

◆ saturation()

◆ saveImage()

◆ saveXml()

◆ setEmbed()

◆ setFilename()

◆ setSaturation()

Member Data Documentation

◆ d