ImageShape Class Reference

#include <ImageShape.h>

Inheritance diagram for ImageShape:

Public Member Functions
KoShape *	cloneShape () const override
	creates a deep copy of the shape or shape's subtree
QImage	image () const
	ImageShape ()
bool	loadSvg (const QDomElement &element, SvgLoadingContext &context) override
	Loads data from specified svg element.
void	paint (QPainter &painter) 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.
	Private ()
	Private (const Private &rhs)
bool	saveSvg (SvgSavingContext &context) override
	Saves data utilizing specified svg saving context.
void	setImage (const QImage &img)
void	setSize (const QSizeF &size) override
	Resize the shape.
void	setViewBoxTransform (const QTransform &tf)
QTransform	viewBoxTransform () const
	~ImageShape () override
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	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.
Public Member Functions inherited from SvgShape
void	saveMetadata (SvgSavingContext &context)
virtual	~SvgShape ()

Public Attributes
QImage	image
QScopedPointer< SvgUtil::PreserveAspectRatioParser >	ratioParser
QTransform	viewBoxTransform

Private Member Functions
	ImageShape (const ImageShape &rhs)

Private Attributes
QSharedDataPointer< Private >	m_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 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)
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

Definition at line 23 of file ImageShape.cpp.

Constructor & Destructor Documentation

ImageShape() [1/2]

ImageShape::ImageShape

(

)

Definition at line 40 of file ImageShape.cpp.

    : m_d(new Private)
{
}

~ImageShape()

ImageShape::~ImageShape ( )

override

Definition at line 51 of file ImageShape.cpp.

{
}

ImageShape() [2/2]

ImageShape::ImageShape ( const ImageShape & rhs )

private

Definition at line 45 of file ImageShape.cpp.

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

Member Function Documentation

cloneShape()

KoShape * ImageShape::cloneShape ( ) const

overridevirtual

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

Returns

a cloned shape

Reimplemented from KoShape.

Definition at line 55 of file ImageShape.cpp.

{
    return new ImageShape(*this);
}

References ImageShape().

image()

QImage ImageShape::image

(

)

const

loadSvg()

bool ImageShape::loadSvg ( const QDomElement & element, SvgLoadingContext & context )

overridevirtual

Loads data from specified svg element.

Reimplemented from SvgShape.

Definition at line 105 of file ImageShape.cpp.

{
    const qreal x = SvgUtil::parseUnitX(context.currentGC(), context.resolvedProperties(), element.attribute("x"));
    const qreal y = SvgUtil::parseUnitY(context.currentGC(), context.resolvedProperties(), element.attribute("y"));
    const qreal w = SvgUtil::parseUnitX(context.currentGC(), context.resolvedProperties(), element.attribute("width"));
    const qreal h = SvgUtil::parseUnitY(context.currentGC(), context.resolvedProperties(), element.attribute("height"));
 
    setSize(QSizeF(w, h));
    setPosition(QPointF(x, y));
 
    if (w == 0.0 || h == 0.0) {
        setVisible(false);
    }
 
    QString fileName = element.attribute("xlink:href");
 
    QByteArray data;
 
    if (fileName.startsWith("data:")) {
 
        QRegularExpression re("data:(.+?);base64,(.+)");
        QRegularExpressionMatch match = re.match(fileName);
 
        data = match.captured(2).toLatin1();
        data = QByteArray::fromBase64(data);
    } else {
        data = context.fetchExternalFile(fileName);
    }
 
    if (!data.isEmpty()) {
        QBuffer buffer(&data);
        m_d->image.load(&buffer, "");
    }
 
    const QString aspectString = element.attribute("preserveAspectRatio", "xMidYMid meet");
    m_d->ratioParser.reset(new SvgUtil::PreserveAspectRatioParser(aspectString));
 
    if (!m_d->image.isNull()) {
 
        m_d->viewBoxTransform =
             QTransform::fromScale(w / m_d->image.width(), h / m_d->image.height());
 
        SvgUtil::parseAspectRatio(*m_d->ratioParser,
                                  QRectF(QPointF(), size()),
                                  QRect(QPoint(), m_d->image.size()),
                                  &m_d->viewBoxTransform);
    }
 
    if (m_d->ratioParser->defer) {
        // TODO:
    }
 
    return true;
}

References SvgLoadingContext::currentGC(), SvgLoadingContext::fetchExternalFile(), m_d, SvgUtil::parseAspectRatio(), SvgUtil::parseUnitX(), SvgUtil::parseUnitY(), SvgLoadingContext::resolvedProperties(), KoShape::setPosition(), setSize(), KoShape::setVisible(), and KoShape::size().

paint()

void ImageShape::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 60 of file ImageShape.cpp.

{
    KisQPainterStateSaver saver(&painter);
 
    const QRectF myrect(QPointF(), size());
 
    painter.setRenderHint(QPainter::SmoothPixmapTransform);
    painter.setClipRect(QRectF(QPointF(), size()), Qt::IntersectClip);
    painter.setTransform(m_d->viewBoxTransform, true);
    painter.drawImage(QPoint(), m_d->image);
}

References m_d, and KoShape::size().

Private() [1/2]

ImageShape::Private ( )

inline

Definition at line 25 of file ImageShape.cpp.

{}

Private() [2/2]

ImageShape::Private ( const Private & rhs )

inline

Definition at line 26 of file ImageShape.cpp.

        : QSharedData(),
          image(rhs.image),
          ratioParser(rhs.ratioParser ? new SvgUtil::PreserveAspectRatioParser(*rhs.ratioParser) : 0),
          viewBoxTransform(rhs.viewBoxTransform)
    {
    }

saveSvg()

bool ImageShape::saveSvg ( SvgSavingContext & context )

overridevirtual

Saves data utilizing specified svg saving context.

Reimplemented from SvgShape.

Definition at line 77 of file ImageShape.cpp.

{
    const QString uid = context.createUID("image");
 
    context.shapeWriter().startElement("image");
    context.shapeWriter().addAttribute("id", uid);
    SvgUtil::writeTransformAttributeLazy("transform", transformation(), context.shapeWriter());
    context.shapeWriter().addAttribute("width", QString("%1px").arg(KisDomUtils::toString(size().width())));
    context.shapeWriter().addAttribute("height", QString("%1px").arg(KisDomUtils::toString(size().height())));
 
    QString aspectString = m_d->ratioParser? m_d->ratioParser->toString(): QString();
    if (!aspectString.isEmpty()) {
        context.shapeWriter().addAttribute("preserveAspectRatio", aspectString);
    }
 
    QBuffer buffer;
    buffer.open(QIODevice::WriteOnly);
    if (m_d->image.save(&buffer, "PNG")) {
        const QString mimeType = KisMimeDatabase::mimeTypeForSuffix("*.png");
        context.shapeWriter().addAttribute("xlink:href", "data:"+ mimeType + ";base64," + buffer.data().toBase64());
    }
    SvgStyleWriter::saveMetadata(this, context);
 
    context.shapeWriter().endElement(); // image
 
    return true;
}

References SvgSavingContext::createUID(), m_d, KisMimeDatabase::mimeTypeForSuffix(), SvgStyleWriter::saveMetadata(), SvgSavingContext::shapeWriter, KoShape::size(), KisDomUtils::toString(), KoShape::transformation(), and SvgUtil::writeTransformAttributeLazy().

setImage()

void ImageShape::setImage

(

const QImage &

img

)

Definition at line 160 of file ImageShape.cpp.

{
    if (m_d->image != img) {
        m_d->image = img;
        shapeChanged(KoShape::ContentChanged);
    }
}

References KoShape::ContentChanged, m_d, and KoShape::shapeChanged().

setSize()

void ImageShape::setSize ( const QSizeF & size )

overridevirtual

Resize the shape.

Parameters

size

the new size of the shape. This is different from scaling as scaling is a so called secondary operation which is comparable to zooming in instead of changing the size of the basic shape. Easiest example of this difference is that using this method will not distort the size of pattern-fills and strokes.

Reimplemented from KoShape.

Definition at line 72 of file ImageShape.cpp.

{
    KoShape::setSize(size);
}

References KoShape::setSize(), and KoShape::size().

setViewBoxTransform()

void ImageShape::setViewBoxTransform

(

const QTransform &

tf

)

Definition at line 173 of file ImageShape.cpp.

{
    if (m_d->viewBoxTransform != tf) {
        m_d->viewBoxTransform = tf;
        shapeChanged(KoShape::GenericMatrixChange);
    }
}

References KoShape::GenericMatrixChange, m_d, and KoShape::shapeChanged().

viewBoxTransform()

QTransform ImageShape::viewBoxTransform

(

)

const

Member Data Documentation

image

QImage ImageShape::image

Definition at line 34 of file ImageShape.cpp.

m_d

QSharedDataPointer<Private> ImageShape::m_d

private

Definition at line 44 of file ImageShape.h.

ratioParser

QScopedPointer<SvgUtil::PreserveAspectRatioParser> ImageShape::ratioParser

Definition at line 35 of file ImageShape.cpp.

viewBoxTransform

QTransform ImageShape::viewBoxTransform

Definition at line 36 of file ImageShape.cpp.

---

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

• plugins/flake/imageshape/ImageShape.cpp
• plugins/flake/imageshape/ImageShape.h