#include <Document.h>

Inheritance diagram for Document:

Public Slots
Node *	activeNode () const
	activeNode retrieve the node that is currently active in the currently active window

int	animationLength ()
	get total frame range for animation

QByteArray	annotation (const QString &type)
	annotation the actual data for the annotation for this type. It's a simple QByteArray, what's in it depends on the type of the annotation

QString	annotationDescription (const QString &type) const
	annotationDescription gets the pretty description for the current annotation

QStringList	annotationTypes () const
	annotationTypes returns the list of annotations present in the document. Each annotation type is unique.

qreal	audioLevel () const
	Return current audio level for document.

QList< QString >	audioTracks () const
	Return a list of current audio tracks for document.

bool	autosave ()
	Return autosave status for document Notes:

QColor	backgroundColor ()
	backgroundColor returns the current background color of the document. The color will also include the opacity.

bool	batchmode () const

QRect	bounds () const
	bounds return the bounds of the image

Document *	clone () const
	clone create a shallow clone of this document.

bool	close ()
	close Close the document: remove it from Krita's internal list of documents and close all views. If the document is modified, you should save it first. There will be no prompt for saving.

QString	colorDepth () const

QString	colorModel () const
	colorModel retrieve the current color model of this document:

QString	colorProfile () const

CloneLayer *	createCloneLayer (const QString &name, const Node *source)
	createCloneLayer

ColorizeMask *	createColorizeMask (const QString &name)
	createColorizeMask Creates a colorize mask, which can be used to color fill via keystrokes.

FileLayer *	createFileLayer (const QString &name, const QString fileName, const QString scalingMethod, const QString scalingFilter="Bicubic")
	createFileLayer returns a layer that shows an external image.

FillLayer *	createFillLayer (const QString &name, const QString generatorName, InfoObject &configuration, Selection &selection)
	createFillLayer creates a fill layer object, which is a layer

FilterLayer *	createFilterLayer (const QString &name, Filter &filter, Selection &selection)
	createFilterLayer creates a filter layer, which is a layer that represents a filter applied non-destructively.

FilterMask *	createFilterMask (const QString &name, Filter &filter, const Node *selection_source)
	createFilterMask Creates a filter mask object that much like a filterlayer can apply a filter non-destructively.

FilterMask *	createFilterMask (const QString &name, Filter &filter, Selection &selection)
	createFilterMask Creates a filter mask object that much like a filterlayer can apply a filter non-destructively.

GroupLayer *	createGroupLayer (const QString &name)
	createGroupLayer Returns a grouplayer object. Grouplayers are nodes that can have other layers as children and have the passthrough mode.

Node *	createNode (const QString &name, const QString &nodeType)

SelectionMask *	createSelectionMask (const QString &name)
	createSelectionMask Creates a selection mask, which can be used to store selections.

TransformMask *	createTransformMask (const QString &name)
	createTransformMask Creates a transform mask, which can be used to apply a transformation non-destructively.

TransparencyMask *	createTransparencyMask (const QString &name)
	createTransparencyMask Creates a transparency mask, which can be used to assign transparency to regions.

VectorLayer *	createVectorLayer (const QString &name)
	createVectorLayer Creates a vector layer that can contain vector shapes.

void	crop (int x, int y, int w, int h)
	crop the image to rectangle described by `x`, `y`, `w` and `h`

int	currentTime ()
	get current frame selected of animation

QString	documentInfo () const
	documentInfo creates and XML document representing document and author information.

bool	exportImage (const QString &filename, const InfoObject &exportConfiguration)
	exportImage export the image, without changing its URL to the given path.

QString	fileName () const

void	flatten ()
	flatten all layers in the image

int	framesPerSecond ()
	frames per second of document

int	fullClipRangeEndTime ()
	get the full clip range end time

int	fullClipRangeStartTime ()
	get the full clip range start time

GridConfig *	gridConfig ()
	Returns a GridConfig grid configuration for current document.

GuidesConfig *	guidesConfig ()
	Returns a GuidesConfig guides configuration for current document.

Q_DECL_DEPRECATED bool	guidesLocked () const
	DEPRECATED - use guidesConfig() instead Returns guide lockedness.

Q_DECL_DEPRECATED bool	guidesVisible () const
	DEPRECATED - use guidesConfig() instead Returns guide visibility.

int	height () const

Q_DECL_DEPRECATED QList< qreal >	horizontalGuides () const
	DEPRECATED - use guidesConfig() instead The horizontal guides.

bool	importAnimation (const QList< QString > &files, int firstFrame, int step)
	Import an image sequence of files from a directory. This will grab all images from the directory and import them with a potential offset (firstFrame) and step (images on 2s, 3s, etc)

void	lock ()

bool	modified () const
	modified returns true if the document has unsaved modifications.

QString	name () const

Node *	nodeByName (const QString &name) const
	nodeByName searches the node tree for a node with the given name and returns it

Node *	nodeByUniqueID (const QUuid &id) const
	nodeByUniqueID searches the node tree for a node with the given name and returns it.

QByteArray	pixelData (int x, int y, int w, int h) const
	pixelData reads the given rectangle from the image projection and returns it as a byte array. The pixel data starts top-left, and is ordered row-first.

int	playBackEndTime ()
	get end time of current playback

int	playBackStartTime ()
	get start time of current playback

QImage	projection (int x=0, int y=0, int w=0, int h=0) const
	projection creates a QImage from the rendered image or a cutout rectangle.

void	refreshProjection ()

void	removeAnnotation (const QString &type)
	removeAnnotation remove the specified annotation from the image

void	resizeImage (int x, int y, int w, int h)
	resizeImage resizes the canvas to the given left edge, top edge, width and height. Note: This doesn't scale, use scale image for that.

int	resolution () const

Node *	rootNode () const
	rootNode the root node is the invisible group layer that contains the entire node hierarchy.

void	rotateImage (double radians)
	rotateImage Rotate the image by the given radians.

bool	save ()
	save the image to its currently set path. The modified flag of the document will be reset

bool	saveAs (const QString &filename)
	saveAs save the document under the `filename`. The document's filename will be reset to `filename`.

void	scaleImage (int w, int h, int xres, int yres, QString strategy)
	scaleImage

Selection *	selection () const
	selection Create a Selection object around the global selection, if there is one.

void	setActiveNode (Node *value)
	setActiveNode make the given node active in the currently active view and window

void	setAnnotation (const QString &type, const QString &description, const QByteArray &annotation)
	setAnnotation Add the given annotation to the document

void	setAudioLevel (const qreal level)
	Set current audio level for document.

bool	setAudioTracks (const QList< QString > files) const
	Set a list of audio tracks for document Note: the function allows to add more than one file while from Krita's UI, importing a file will replace the complete list.

void	setAutosave (bool active)
	Allow to activate/deactivate autosave for document When activated, it will use default Krita autosave settings It means that even when autosave is set to True, under condition Krita will not proceed to automatic save of document:

bool	setBackgroundColor (const QColor &color)
	setBackgroundColor sets the background color of the document. It will trigger a projection update.

void	setBatchmode (bool value)

bool	setColorProfile (const QString &colorProfile)
	setColorProfile set the color profile of the image to the given profile. The profile has to be registered with krita and be compatible with the current color model and depth; the image data is not converted.

bool	setColorSpace (const QString &colorModel, const QString &colorDepth, const QString &colorProfile)
	setColorSpace convert the nodes and the image to the given colorspace. The conversion is done with Perceptual as intent, High Quality and No LCMS Optimizations as flags and no blackpoint compensation.

void	setCurrentTime (int time)
	set current time of document's animation

void	setDocumentInfo (const QString &document)
	setDocumentInfo set the Document information to the information contained in document

void	setFileName (QString value)
	setFileName set the full path of the document to

void	setFramesPerSecond (int fps)
	set frames per second of document

void	setFullClipRangeEndTime (int endTime)
	set full clip range end time

void	setFullClipRangeStartTime (int startTime)
	set start time of animation

void	setGridConfig (GridConfig *gridConfig)

void	setGuidesConfig (GuidesConfig *guidesConfig)

Q_DECL_DEPRECATED void	setGuidesLocked (bool locked)
	DEPRECATED - use guidesConfig() instead set guides locked on this document.

Q_DECL_DEPRECATED void	setGuidesVisible (bool visible)
	DEPRECATED - use guidesConfig() instead set guides visible on this document.

void	setHeight (int value)
	setHeight resize the document to

Q_DECL_DEPRECATED void	setHorizontalGuides (const QList< qreal > &lines)
	DEPRECATED - use guidesConfig() instead replace all existing horizontal guides with the entries in the list.

void	setModified (bool modified)
	setModified sets the modified status of the document

void	setName (QString value)
	setName sets the name of the document to `value`. This is the title field in the documentInfo

void	setPlayBackRange (int start, int stop)
	set temporary playback range of document

void	setResolution (int value)
	setResolution set the resolution of the image; this does not scale the image

void	setSelection (Selection *value)
	setSelection set or replace the global selection

Q_DECL_DEPRECATED void	setVerticalGuides (const QList< qreal > &lines)
	DEPRECATED - use guidesConfig() instead replace all existing horizontal guides with the entries in the list.

void	setWidth (int value)
	setWidth resize the document to

void	setXOffset (int x)
	setXOffset sets the left edge of the canvas to `x`.

void	setXRes (double xRes) const
	setXRes set the horizontal resolution of the image to xRes in pixels per inch

void	setYOffset (int y)
	setYOffset sets the top edge of the canvas to `y`.

void	setYRes (double yRes) const
	setYRes set the vertical resolution of the image to yRes in pixels per inch

void	shearImage (double angleX, double angleY)
	shearImage shear the whole image.

QImage	thumbnail (int w, int h) const
	thumbnail create a thumbnail of the given dimensions.

QList< Node * >	topLevelNodes () const
	toplevelNodes return a list with all top level nodes in the image graph

bool	tryBarrierLock ()
	Tries to lock the image without waiting for the jobs to finish.

void	unlock ()

Q_DECL_DEPRECATED QList< qreal >	verticalGuides () const
	DEPRECATED - use guidesConfig() instead The vertical guide lines.

void	waitForDone ()

int	width () const

int	xOffset () const

double	xRes () const

int	yOffset () const

double	yRes () const

Public Member Functions
	Document (KisDocument document, bool ownsDocument, QObject parent=0)

bool	operator!= (const Document &other) const

bool	operator== (const Document &other) const

	~Document () override

Private Member Functions
QPointer< KisDocument >	document () const

void	setOwnsDocument (bool ownsDocument)

Private Attributes
Private *const	d

Friends
class	Filter

class	Krita

class	Shape
	Freehand and shapes like ellipses and lines.

class	VectorLayer

class	View
	Assistance tools: guides, reference, etc.

class	Window

Detailed Description

The Document class encapsulates a Krita Document/Image. A Krita document is an Image with a filename. Libkis does not differentiate between a document and an image, like Krita does internally.

Definition at line 36 of file Document.h.

Constructor & Destructor Documentation

◆ Document()

Document::Document	(	KisDocument *	document,
		bool	ownsDocument,
		QObject *	parent = 0 )

explicit

Definition at line 79 of file Document.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->document = document;
    d->ownsDocument = ownsDocument;
}

References d, krita::Document::Private::document, document(), and krita::Document::Private::ownsDocument.

◆ ~Document()

Document::~Document ( )

override

Definition at line 87 of file Document.cpp.

{
    if (d->ownsDocument && d->document) {
        KisPart::instance()->removeDocument(d->document);
        delete d->document;
    }
    delete d;
}

References d, krita::Document::Private::document, KisPart::instance(), krita::Document::Private::ownsDocument, and KisPart::removeDocument().

Member Function Documentation

◆ activeNode

Node * Document::activeNode ( ) const

slot

activeNode retrieve the node that is currently active in the currently active window

Returns: the active node. If there is no active window, the first child node is returned.

Definition at line 118 of file Document.cpp.

{
    // see a related comment in Document::setActiveNode
    KisSynchronizedConnectionBase::forceDeliverAllSynchronizedEvents();
 
    QList<KisNodeSP> activeNodes;
    Q_FOREACH(QPointer<KisView> view, KisPart::instance()->views()) {
        if (view && view->document() == d->document) {
            activeNodes << view->currentNode();
 
        }
    }
    if (activeNodes.size() > 0) {
        QList<Node*> nodes = LibKisUtils::createNodeList(activeNodes, d->document->image());
        return nodes.first();
    }
 
    return 0;
}

References LibKisUtils::createNodeList(), d, krita::Document::Private::document, KisSynchronizedConnectionBase::forceDeliverAllSynchronizedEvents(), and KisPart::instance().

◆ animationLength

int Document::animationLength ( )

slot

get total frame range for animation

Returns: total frame range for animation

Definition at line 1048 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->totalLength();
}

References d, and krita::Document::Private::document.

◆ annotation

QByteArray Document::annotation ( const QString & type )

slot

annotation the actual data for the annotation for this type. It's a simple QByteArray, what's in it depends on the type of the annotation

Parameters

type	the type of the annotation

Returns: a bytearray, possibly empty if this type of annotation doesn't exist

Definition at line 1131 of file Document.cpp.

{
    KisImageSP image = d->document->image().toStrongRef();
    KisAnnotationSP annotation = image->annotation(type);
    if (annotation) {
        return annotation->annotation();
    }
    else {
        return QByteArray();
    }
}

References KisImage::annotation(), annotation(), d, and krita::Document::Private::document.

◆ annotationDescription

QString Document::annotationDescription ( const QString & type ) const

slot

annotationDescription gets the pretty description for the current annotation

Parameters

type	the type of the annotation

Returns: a string that can be presented to the user

Definition at line 1124 of file Document.cpp.

{
    KisImageSP image = d->document->image().toStrongRef();
    KisAnnotationSP annotation = image->annotation(type);
    return annotation->description();
}

References KisImage::annotation(), annotation(), d, and krita::Document::Private::document.

◆ annotationTypes

QStringList Document::annotationTypes ( ) const

slot

annotationTypes returns the list of annotations present in the document. Each annotation type is unique.

Definition at line 1097 of file Document.cpp.

{
    if (!d->document) return QStringList();
 
    QStringList types;
 
    KisImageSP image = d->document->image().toStrongRef();
 
    if (!image) return QStringList();
 
    vKisAnnotationSP_it beginIt = image->beginAnnotations();
    vKisAnnotationSP_it endIt = image->endAnnotations();
 
    vKisAnnotationSP_it it = beginIt;
    while (it != endIt) {
        if (!(*it) || (*it)->type().isEmpty()) {
            qWarning() << "Warning: empty annotation";
            it++;
            continue;
        }
        types << (*it)->type();
 
        it++;
    }
    return types;
}

References KisImage::beginAnnotations(), d, krita::Document::Private::document, and KisImage::endAnnotations().

◆ audioLevel

qreal Document::audioLevel ( ) const

slot

Return current audio level for document.

Returns: A value between 0.0 and 1.0 (1.0 = 100%)

Definition at line 1268 of file Document.cpp.

{
    return d->document->getAudioLevel();
}

References d, and krita::Document::Private::document.

◆ audioTracks

QList< QString > Document::audioTracks ( ) const

slot

Return a list of current audio tracks for document.

Returns: List of absolute path/file name of audio files

Definition at line 1278 of file Document.cpp.

{
    QList<QString> fileList;
    Q_FOREACH(QFileInfo fileInfo, d->document->getAudioTracks()) {
        fileList.append(fileInfo.absoluteFilePath());
    }
    return fileList;
}

References d, and krita::Document::Private::document.

◆ autosave

bool Document::autosave ( )

slot

Return autosave status for document Notes:

returned value is Autosave flag value Even if autosave is set to True, under condition Krita will not proceed to automatic save of document:
- autosave is globally deactivated
- document is read-only
When autosave is set to False, Krita never execute automatic save for document

Returns: True if autosave is active, otherwise False

Definition at line 1162 of file Document.cpp.

{
    return d->document->isAutoSaveActive();
}

References d, and krita::Document::Private::document.

◆ backgroundColor

QColor Document::backgroundColor ( )

slot

backgroundColor returns the current background color of the document. The color will also include the opacity.

Returns: QColor

Definition at line 236 of file Document.cpp.

{
    if (!d->document) return QColor();
    if (!d->document->image()) return QColor();
 
    const KoColor color = d->document->image()->defaultProjectionColor();
    return color.toQColor();
}

References d, krita::Document::Private::document, and KoColor::toQColor().

◆ batchmode

bool Document::batchmode ( ) const

slot

Batchmode means that no actions on the document should show dialogs or popups.

Returns: true if the document is in batchmode.

Definition at line 106 of file Document.cpp.

{
    if (!d->document) return false;
    return d->document->fileBatchMode();
}

References d, and krita::Document::Private::document.

◆ bounds

QRect Document::bounds ( ) const

slot

bounds return the bounds of the image

Returns: the bounds

Definition at line 964 of file Document.cpp.

{
    if (!d->document) return QRect();
    return d->document->image()->bounds();
}

References d, and krita::Document::Private::document.

◆ clone

Document * Document::clone ( ) const

slot

clone create a shallow clone of this document.

Returns: a new Document that should be identical to this one in every respect.

We set ownsDocument to true, it will be reset automatically as soon as we create the first view for the document

Definition at line 890 of file Document.cpp.

{
    if (!d->document) return 0;
    QPointer<KisDocument> clone = d->document->clone();
 
    Document * newDocument = new Document(clone, true);
    return newDocument;
}

References clone(), d, krita::Document::Private::document, and Document().

◆ close

bool Document::close ( )

slot

close Close the document: remove it from Krita's internal list of documents and close all views. If the document is modified, you should save it first. There will be no prompt for saving.

After closing the document it becomes invalid.

Returns: true if the document is closed.

Definition at line 488 of file Document.cpp.

{
    bool retval = d->document->closePath(false);
 
    Q_FOREACH(KisView *view, KisPart::instance()->views()) {
        if (view->document() == d->document) {
            view->close();
            view->closeView();
            view->deleteLater();
        }
    }
 
    KisPart::instance()->removeDocument(d->document, !d->ownsDocument);
 
    if (d->ownsDocument) {
 
        delete d->document;
    }
 
    d->document = 0;
    return retval;
}

References KisView::closeView(), d, krita::Document::Private::document, KisView::document, KisPart::instance(), krita::Document::Private::ownsDocument, and KisPart::removeDocument().

◆ colorDepth

QString Document::colorDepth ( ) const

slot

colorDepth A string describing the color depth of the image:

U8: unsigned 8 bits integer, the most common type
U16: unsigned 16 bits integer
F16: half, 16 bits floating point. Only available if Krita was built with OpenEXR
F32: 32 bits floating point

Returns: the color depth.

Definition at line 192 of file Document.cpp.

{
    if (!d->document) return "";
    return d->document->image()->colorSpace()->colorDepthId().id();
}

References d, and krita::Document::Private::document.

◆ colorModel

QString Document::colorModel ( ) const

slot

colorModel retrieve the current color model of this document:

A: Alpha mask
RGBA: RGB with alpha channel (The actual order of channels is most often BGR!)
XYZA: XYZ with alpha channel
LABA: LAB with alpha channel
CMYKA: CMYK with alpha channel
GRAYA: Gray with alpha channel
YCbCrA: YCbCr with alpha channel

Returns: the internal color model string.

Definition at line 198 of file Document.cpp.

{
    if (!d->document) return "";
    return d->document->image()->colorSpace()->colorModelId().id();
}

References d, and krita::Document::Private::document.

◆ colorProfile

QString Document::colorProfile ( ) const

slot

Returns: the name of the current color profile

Definition at line 204 of file Document.cpp.

{
    if (!d->document) return "";
    return d->document->image()->colorSpace()->profile()->name();
}

References d, and krita::Document::Private::document.

◆ createCloneLayer

CloneLayer * Document::createCloneLayer	(	const QString &	name,
		const Node *	source )

slot

createCloneLayer

Parameters

name
source

Returns

Definition at line 709 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
    KisLayerSP layer = qobject_cast<KisLayer*>(source->node().data());
 
    return new CloneLayer(image, name, layer);
}

References d, krita::Document::Private::document, name(), and source().

◆ createColorizeMask

ColorizeMask * Document::createColorizeMask ( const QString & name )

slot

createColorizeMask Creates a colorize mask, which can be used to color fill via keystrokes.

Parameters

name	- the name of the layer.

Returns: a TransparencyMask

Definition at line 792 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new ColorizeMask(image, name);
}

References d, krita::Document::Private::document, and name().

◆ createFileLayer

FileLayer * Document::createFileLayer	(	const QString &	name,
		const QString	fileName,
		const QString	scalingMethod,
		const QString	scalingFilter = "Bicubic" )

slot

createFileLayer returns a layer that shows an external image.

Parameters

name	name of the file layer.
fileName	the absolute filename of the file referenced. Symlinks will be resolved.
scalingMethod	how the dimensions of the file are interpreted can be either "None", "ImageToSize" or "ImageToPPI"
scalingFilter	filter used to scale the file can be "Bicubic", "Hermite", "NearestNeighbor", "Bilinear", "Bell", "BSpline", "Lanczos3", "Mitchell"

Returns: a FileLayer

Definition at line 672 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new FileLayer(image, name, this->fileName(), fileName, scalingMethod, scalingFilter);
}

References d, krita::Document::Private::document, fileName(), and name().

◆ createFillLayer

FillLayer * Document::createFillLayer	(	const QString &	name,
		const QString	generatorName,
		InfoObject &	configuration,
		Selection &	selection )

slot

createFillLayer creates a fill layer object, which is a layer

Parameters

name
generatorName	- name of the generation filter.
configuration	- the configuration for the generation filter.
selection	- the selection.

Returns: a filllayer object.

from krita import *
d = Krita.instance().activeDocument()
i = InfoObject();
i.setProperty("pattern", "Cross01.pat")
s = Selection();
s.select(0, 0, d.width(), d.height(), 255)
n = d.createFillLayer("test", "pattern", i, s)
r = d.rootNode();
c = r.childNodes();
r.addChildNode(n, c[0])
d.refreshProjection()

Definition at line 690 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    KisGeneratorSP generator = KisGeneratorRegistry::instance()->value(generatorName);
    if (generator) {
 
        KisFilterConfigurationSP config = generator->factoryConfiguration(KisGlobalResourcesInterface::instance());
        Q_FOREACH(const QString property, configuration.properties().keys()) {
            config->setProperty(property, configuration.property(property));
        }
 
        return new FillLayer(image, name, config, selection);
    }
    return 0;
}

References d, krita::Document::Private::document, KisBaseProcessor::factoryConfiguration(), KisGeneratorRegistry::instance(), KisGlobalResourcesInterface::instance(), name(), InfoObject::properties(), InfoObject::property(), selection(), and KoGenericRegistry< T >::value().

◆ createFilterLayer

FilterLayer * Document::createFilterLayer	(	const QString &	name,
		Filter &	filter,
		Selection &	selection )

slot

createFilterLayer creates a filter layer, which is a layer that represents a filter applied non-destructively.

Parameters

name	name of the filterLayer
filter	the filter that this filter layer will us.
selection	the selection.

Returns: a filter layer object.

Definition at line 681 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new FilterLayer(image, name, filter, selection);
}

References d, krita::Document::Private::document, name(), and selection().

◆ createFilterMask [1/2]

FilterMask * Document::createFilterMask	(	const QString &	name,
		Filter &	filter,
		const Node *	selection_source )

slot

createFilterMask Creates a filter mask object that much like a filterlayer can apply a filter non-destructively.

Parameters

name	the name of the layer.
filter	the filter assigned.
selection_source	a node from which the selection should be initialized

Returns: a FilterMask

Definition at line 728 of file Document.cpp.

{
    if (!d->document)
        return 0;
 
    if (!d->document->image())
        return 0;
 
    if(!selection_source)
        return 0;
 
    KisLayerSP layer = qobject_cast<KisLayer*>(selection_source->node().data());
    if(layer.isNull())
        return 0;
 
    KisImageSP image = d->document->image();
    FilterMask* mask = new FilterMask(image, name, filter);
    qobject_cast<KisMask*>(mask->node().data())->initSelection(layer);
 
    return mask;
}

References d, KisSharedPtr< T >::data(), krita::Document::Private::document, KisSharedPtr< T >::isNull(), name(), and Node::node().

◆ createFilterMask [2/2]

FilterMask * Document::createFilterMask	(	const QString &	name,
		Filter &	filter,
		Selection &	selection )

slot

createFilterMask Creates a filter mask object that much like a filterlayer can apply a filter non-destructively.

Parameters

name	the name of the layer.
filter	the filter assigned.
selection	the selection to be used by the filter mask

Returns: a FilterMask

Definition at line 750 of file Document.cpp.

{
    if (!d->document)
        return 0;
 
    if (!d->document->image())
        return 0;
 
    KisImageSP image = d->document->image();
    FilterMask* mask = new FilterMask(image, name, filter);
    qobject_cast<KisMask*>(mask->node().data())->setSelection(selection.selection());
 
    return mask;
}

References d, KisSharedPtr< T >::data(), krita::Document::Private::document, name(), Node::node(), selection(), and Selection::selection().

◆ createGroupLayer

GroupLayer * Document::createGroupLayer ( const QString & name )

slot

createGroupLayer Returns a grouplayer object. Grouplayers are nodes that can have other layers as children and have the passthrough mode.

Parameters

name	the name of the layer.

Returns: a GroupLayer object.

Definition at line 663 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new GroupLayer(image, name);
}

References d, krita::Document::Private::document, and name().

◆ createNode

Node * Document::createNode	(	const QString &	name,
		const QString &	nodeType )

slot

   @brief createNode create a new node of the given type. The node is not added
   to the node hierarchy; you need to do that by finding the right parent node,
   getting its list of child nodes and adding the node in the right place, then
   calling Node::SetChildNodes

   @param name The name of the node

   @param nodeType The type of the node. Valid types are:
   <ul>
    <li>paintlayer
    <li>grouplayer
    <li>filelayer
    <li>filterlayer
    <li>filllayer
    <li>clonelayer
    <li>vectorlayer
    <li>transparencymask
    <li>filtermask
    <li>transformmask
    <li>selectionmask
   </ul>

   When relevant, the new Node will have the colorspace of the image by default;
   that can be changed with Node::setColorSpace.

   The settings and selections for relevant layer and mask types can also be set
   after the Node has been created.

d = Application.createDocument(1000, 1000, "Test", "RGBA", "U8", "", 120.0)
root = d.rootNode();
print(root.childNodes())
l2 = d.createNode("layer2", "paintLayer")
print(l2)
root.addChildNode(l2, None)
print(root.childNodes())

Returns: the new Node.

Definition at line 615 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    Node *node = 0;
 
    if (nodeType.toLower()== "paintlayer") {
        node = new Node(image, new KisPaintLayer(image, name, OPACITY_OPAQUE_U8));
    }
    else if (nodeType.toLower()  == "grouplayer") {
        node = new Node(image, new KisGroupLayer(image, name, OPACITY_OPAQUE_U8));
    }
    else if (nodeType.toLower()  == "filelayer") {
        node = new Node(image, new KisFileLayer(image, name, OPACITY_OPAQUE_U8));
    }
    else if (nodeType.toLower()  == "filterlayer") {
        node = new Node(image, new KisAdjustmentLayer(image, name, 0, 0));
    }
    else if (nodeType.toLower()  == "filllayer") {
        node = new Node(image, new KisGeneratorLayer(image, name, 0, 0));
    }
    else if (nodeType.toLower()  == "clonelayer") {
        node = new Node(image, new KisCloneLayer(0, image, name, OPACITY_OPAQUE_U8));
    }
    else if (nodeType.toLower()  == "vectorlayer") {
        node = new Node(image, new KisShapeLayer(d->document->shapeController(), image, name, OPACITY_OPAQUE_U8));
    }
    else if (nodeType.toLower()  == "transparencymask") {
        node = new Node(image, new KisTransparencyMask(image, name));
    }
    else if (nodeType.toLower()  == "filtermask") {
        node = new Node(image, new KisFilterMask(image, name));
    }
    else if (nodeType.toLower()  == "transformmask") {
        node = new Node(image, new KisTransformMask(image, name));
    }
    else if (nodeType.toLower()  == "selectionmask") {
        node = new Node(image, new KisSelectionMask(image, name));
    }
    else if (nodeType.toLower()  == "colorizemask") {
        node = new Node(image, new KisColorizeMask(image, name));
    }
 
    return node;
}

References d, krita::Document::Private::document, name(), nodeType(), and OPACITY_OPAQUE_U8.

◆ createSelectionMask

SelectionMask * Document::createSelectionMask ( const QString & name )

slot

createSelectionMask Creates a selection mask, which can be used to store selections.

Parameters

name	- the name of the layer.

Returns: a SelectionMask

Definition at line 765 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new SelectionMask(image, name);
}

References d, krita::Document::Private::document, and name().

◆ createTransformMask

TransformMask * Document::createTransformMask ( const QString & name )

slot

createTransformMask Creates a transform mask, which can be used to apply a transformation non-destructively.

Parameters

name	- the name of the layer mask.

Returns: a TransformMask

Definition at line 783 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new TransformMask(image, name);
}

References d, krita::Document::Private::document, and name().

◆ createTransparencyMask

TransparencyMask * Document::createTransparencyMask ( const QString & name )

slot

createTransparencyMask Creates a transparency mask, which can be used to assign transparency to regions.

Parameters

name	- the name of the layer.

Returns: a TransparencyMask

Definition at line 774 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new TransparencyMask(image, name);
}

References d, krita::Document::Private::document, and name().

◆ createVectorLayer

VectorLayer * Document::createVectorLayer ( const QString & name )

slot

createVectorLayer Creates a vector layer that can contain vector shapes.

Parameters

name	the name of this layer.

Returns: a VectorLayer.

Definition at line 719 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    KisImageSP image = d->document->image();
 
    return new VectorLayer(d->document->shapeController(), image, name);
}

References d, krita::Document::Private::document, name(), and VectorLayer.

◆ crop

void Document::crop	(	int	x,
		int	y,
		int	w,
		int	h )

slot

crop the image to rectangle described by x, y, w and h

Parameters

x	x coordinate of the top left corner
y	y coordinate of the top left corner
w	width
h	height

Definition at line 511 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
    QRect rc(x, y, w, h);
    image->cropImage(rc);
    image->waitForDone();
}

References KisImage::cropImage(), d, krita::Document::Private::document, and KisImage::waitForDone().

◆ currentTime

int Document::currentTime ( )

slot

get current frame selected of animation

Returns: current frame selected of animation

Definition at line 1081 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->currentTime();
}

References d, and krita::Document::Private::document.

◆ document()

QPointer< KisDocument > Document::document ( ) const

private

Definition at line 970 of file Document.cpp.

{
    return d->document;
}

References d, and krita::Document::Private::document.

◆ documentInfo

QString Document::documentInfo ( ) const

slot

documentInfo creates and XML document representing document and author information.

Returns: a string containing a valid XML document with the right information about the document and author. The DTD can be found here:

https://phabricator.kde.org/source/krita/browse/master/krita/dtd/

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document-info PUBLIC '-//KDE//DTD document-info 1.1//EN' 'http://www.calligra.org/DTD/document-info-1.1.dtd'>
<document-info xmlns="http://www.calligra.org/DTD/document-info">
<about>
 <title>My Document</title>
  <description></description>
  <subject></subject>
  <abstract><![CDATA[]]></abstract>
  <keyword></keyword>
  <initial-creator>Unknown</initial-creator>
  <editing-cycles>1</editing-cycles>
  <editing-time>35</editing-time>
  <date>2017-02-27T20:15:09</date>
  <creation-date>2017-02-27T20:14:33</creation-date>
  <language></language>
 </about>
 <author>
  <full-name>Boudewijn Rempt</full-name>
  <initial></initial>
  <author-title></author-title>
  <email></email>
  <telephone></telephone>
  <telephone-work></telephone-work>
  <fax></fax>
  <country></country>
  <postal-code></postal-code>
  <city></city>
  <street></street>
  <position></position>
  <company></company>
 </author>
</document-info>

Definition at line 259 of file Document.cpp.

{
    QDomDocument doc = KisDocument::createDomDocument("document-info"
                                                      /*DTD name*/, "document-info" /*tag name*/, "1.1");
    doc = d->document->documentInfo()->save(doc);
    return doc.toString();
}

References KisDocument::createDomDocument(), d, and krita::Document::Private::document.

◆ exportImage

bool Document::exportImage	(	const QString &	filename,
		const InfoObject &	exportConfiguration )

slot

exportImage export the image, without changing its URL to the given path.

Parameters

filename	the full path to which the image is to be saved
exportConfiguration	a configuration object appropriate to the file format. An InfoObject will used to that configuration.

The supported formats have specific configurations that must be used when in batchmode. They are described below:

png

alpha: bool (True or False)
compression: int (1 to 9)
forceSRGB: bool (True or False)
indexed: bool (True or False)
interlaced: bool (True or False)
saveSRGBProfile: bool (True or False)
transparencyFillcolor: rgb (Ex:[255,255,255])

jpeg

baseline: bool (True or False)
exif: bool (True or False)
filters: bool (['ToolInfo', 'Anonymizer'])
forceSRGB: bool (True or False)
iptc: bool (True or False)
is_sRGB: bool (True or False)
optimize: bool (True or False)
progressive: bool (True or False)
quality: int (0 to 100)
saveProfile: bool (True or False)
smoothing: int (0 to 100)
subsampling: int (0 to 3)
transparencyFillcolor: rgb (Ex:[255,255,255])
xmp: bool (True or False)

Returns: true if the export succeeded, false if it failed.

Definition at line 521 of file Document.cpp.

{
    if (!d->document) return false;
 
    const QString outputFormatString = KisMimeDatabase::mimeTypeForFile(filename, false);
    const QByteArray outputFormat = outputFormatString.toLatin1();
 
    return d->document->exportDocumentSync(filename, outputFormat, exportConfiguration.configuration());
}

References InfoObject::configuration(), d, krita::Document::Private::document, and KisMimeDatabase::mimeTypeForFile().

◆ fileName

QString Document::fileName ( ) const

slot

Returns: the full path to the document, if it has been set.

Definition at line 277 of file Document.cpp.

{
    if (!d->document) return QString();
    return d->document->path();
}

References d, and krita::Document::Private::document.

◆ flatten

void Document::flatten ( )

slot

flatten all layers in the image

Definition at line 531 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
    d->document->image()->flatten(0);
    d->document->image()->waitForDone();
}

References d, and krita::Document::Private::document.

◆ framesPerSecond

int Document::framesPerSecond ( )

slot

frames per second of document

Returns: the fps of the document

Definition at line 997 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->framerate();
}

References d, and krita::Document::Private::document.

◆ fullClipRangeEndTime

int Document::fullClipRangeEndTime ( )

slot

get the full clip range end time

Returns: full clip range end time

Definition at line 1040 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->documentPlaybackRange().end();
}

References d, and krita::Document::Private::document.

◆ fullClipRangeStartTime

int Document::fullClipRangeStartTime ( )

slot

get the full clip range start time

Returns: full clip range start time

Definition at line 1022 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->documentPlaybackRange().start();
}

References d, and krita::Document::Private::document.

◆ gridConfig

GridConfig * Document::gridConfig ( )

slot

Returns a GridConfig grid configuration for current document.

Returns: a GridConfig object with grid configuration

Definition at line 1254 of file Document.cpp.

{
    KisGridConfig *tmpConfig = new KisGridConfig(d->document->gridConfig());
    GridConfig *gridConfig = new GridConfig(tmpConfig);
    return gridConfig;
}

References d, krita::Document::Private::document, and gridConfig().

◆ guidesConfig

GuidesConfig * Document::guidesConfig ( )

slot

Returns a GuidesConfig guides configuration for current document.

Returns: a GuidesConfig object with guides configuration

Definition at line 1167 of file Document.cpp.

{
    // The way Krita manage guides position is a little bit strange
    //
    // Let's say, set a guide at a position of 100pixels from UI
    // In KisGuidesConfig, the saved position (using KoUnit 'px') is set taking in account the
    // document resolution
    // So:
    //  100px at 300dpi ==> the stored value will be 72 * 100 / 300.00 = 24.00
    //  100px at 600dpi ==> the stored value will be 72 * 100 / 600.00 = 12.00
    // We have a position saved in 'pt', with unit 'px'
    // This is also what is saved in maindoc.xml...
    //
    // The weird thing in this process:
    // - use unit 'px' as what is reallt stored is 'pt'
    // - use 'pt' to store an information that should be 'px' (because 100pixels is 100pixels whatever the
    //   resolution of document)
    //
    // But OK, it works like this and reviewing this is probably a huge workload, and also there'll be
    // a problem with old saved documents (taht's store 100px@300dpi as '24.00')
    //
    // The solution here is, before restitue the guideConfig to user, the internal value is transformed...
    KisGuidesConfig *tmpConfig = new KisGuidesConfig(d->document->guidesConfig());
 
    if (d->document && d->document->image()) {
        const QTransform documentToImage =
            QTransform::fromScale(d->document->image()->xRes(), d->document->image()->yRes());
        QList<qreal> transformedLines;
        QList<qreal> untransformedLines = tmpConfig->horizontalGuideLines();
        for (int i = 0; i< untransformedLines.size(); i++) {
            qreal untransformedLine = untransformedLines[i];
            transformedLines.append(documentToImage.map(QPointF(untransformedLine, untransformedLine)).x());
        }
        tmpConfig->setHorizontalGuideLines(transformedLines);
 
        transformedLines.clear();
        untransformedLines = tmpConfig->verticalGuideLines();
        for (int i = 0; i< untransformedLines.size(); i++) {
            qreal untransformedLine = untransformedLines[i];
            transformedLines.append(documentToImage.map(QPointF(untransformedLine, untransformedLine)).y());
        }
        tmpConfig->setVerticalGuideLines(transformedLines);
    }
    else {
        // unable to proceed to transform, return no guides
        tmpConfig->removeAllGuides();
    }
 
    GuidesConfig *guideConfig = new GuidesConfig(tmpConfig);
    return guideConfig;
}

References d, krita::Document::Private::document, KisGuidesConfig::horizontalGuideLines(), KisGuidesConfig::removeAllGuides(), KisGuidesConfig::setHorizontalGuideLines(), KisGuidesConfig::setVerticalGuideLines(), and KisGuidesConfig::verticalGuideLines().

◆ guidesLocked

bool Document::guidesLocked ( ) const

slot

DEPRECATED - use guidesConfig() instead Returns guide lockedness.

Returns: whether the guides are locked.

Definition at line 884 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.guidesLocked() - use Document.guidesConfig().locked() instead";
    return d->document->guidesConfig().lockGuides();
}

References d, krita::Document::Private::document, and warnScript.

◆ guidesVisible

bool Document::guidesVisible ( ) const

slot

DEPRECATED - use guidesConfig() instead Returns guide visibility.

Returns: whether the guides are visible.

Definition at line 878 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.guidesVisible() - use Document.guidesConfig().visible() instead";
    return d->document->guidesConfig().showGuides();
}

References d, krita::Document::Private::document, and warnScript.

◆ height

int Document::height ( ) const

slot

Returns: the height of the image in pixels

Definition at line 291 of file Document.cpp.

{
    if (!d->document) return 0;
    KisImageSP image = d->document->image();
    if (!image) return 0;
    return image->height();
}

References d, krita::Document::Private::document, and KisImage::height().

◆ horizontalGuides

QList< qreal > Document::horizontalGuides ( ) const

slot

DEPRECATED - use guidesConfig() instead The horizontal guides.

Returns: a list of the horizontal positions of guides.

Definition at line 847 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.horizontalGuides() - use Document.guidesConfig().horizontalGuides() instead";
    QList<qreal> lines;
    if (!d->document || !d->document->image()) return lines;
    const QTransform documentToImage =
        QTransform::fromScale(d->document->image()->xRes(), d->document->image()->yRes());
 
    QList<qreal> untransformedLines = d->document->guidesConfig().horizontalGuideLines();
    for (int i = 0; i< untransformedLines.size(); i++) {
        qreal line = untransformedLines[i];
        lines.append(documentToImage.map(QPointF(line, line)).x());
    }
    return lines;
}

References d, krita::Document::Private::document, and warnScript.

◆ importAnimation

bool Document::importAnimation	(	const QList< QString > &	files,
		int	firstFrame,
		int	step )

slot

Import an image sequence of files from a directory. This will grab all images from the directory and import them with a potential offset (firstFrame) and step (images on 2s, 3s, etc)

Returns: whether the animation import was successful

Definition at line 982 of file Document.cpp.

{
    KisView *activeView = KisPart::instance()->currentMainwindow()->activeView();
 
    KoUpdaterPtr updater = 0;
    if (activeView && d->document->fileBatchMode()) {
         updater = activeView->viewManager()->createUnthreadedUpdater(i18n("Import frames"));
    }
 
    KisAnimationImporter importer(d->document->image(), updater);
    KisImportExportErrorCode status = importer.import(files, firstFrame, step);
 
    return status.isOk();
}

References KisMainWindow::activeView, KisViewManager::createUnthreadedUpdater(), KisPart::currentMainwindow(), d, krita::Document::Private::document, KisAnimationImporter::import(), KisPart::instance(), KisImportExportErrorCode::isOk(), and KisView::viewManager.

◆ lock

void Document::lock ( )

slot

[low-level] Lock the image without waiting for all the internal job queues are processed

WARNING: Don't use it unless you really know what you are doing! Use barrierLock() instead!

Waits for all the currently running internal jobs to complete and locks the image for writing. Please note that this function does not wait for all the internal queues to process, so there might be some non-finished actions pending. It means that you just postpone these actions until you unlock() the image back. Until then, then image might easily be frozen in some inconsistent state.

The only sane usage for this function is to lock the image for emergency processing, when some internal action or scheduler got hung up, and you just want to fetch some data from the image without races.

In all other cases, please use barrierLock() instead!

Definition at line 814 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return;
    d->document->image()->barrierLock();
}

References d, and krita::Document::Private::document.

◆ modified

bool Document::modified ( ) const

slot

modified returns true if the document has unsaved modifications.

Definition at line 952 of file Document.cpp.

{
    if (!d->document) return false;
    return d->document->isModified();
}

References d, and krita::Document::Private::document.

◆ name

QString Document::name ( ) const

slot

Returns: the name of the document. This is the title field in the documentInfo

Definition at line 310 of file Document.cpp.

{
    if (!d->document) return "";
    return d->document->documentInfo()->aboutInfo("title");
}

References d, and krita::Document::Private::document.

◆ nodeByName

Node * Document::nodeByName ( const QString & name ) const

slot

nodeByName searches the node tree for a node with the given name and returns it

Parameters

name	the name of the node

Returns: the first node with the given name or 0 if no node is found

Definition at line 171 of file Document.cpp.

{
    if (!d->document) return 0;
    KisNodeSP node = KisLayerUtils::findNodeByName(d->document->image()->rootLayer(),name);
 
    if (node.isNull()) return 0;
 
    return Node::createNode(d->document->image(), node);
}

References Node::createNode(), d, krita::Document::Private::document, KisLayerUtils::findNodeByName(), KisSharedPtr< T >::isNull(), and name().

◆ nodeByUniqueID

Node * Document::nodeByUniqueID ( const QUuid & id ) const

slot

nodeByUniqueID searches the node tree for a node with the given name and returns it.

Parameters

uuid	the unique id of the node

Returns: the node with the given unique id, or 0 if no node is found.

Definition at line 181 of file Document.cpp.

{
    if (!d->document) return 0;
 
    KisNodeSP node = KisLayerUtils::findNodeByUuid(d->document->image()->rootLayer(), id);
 
    if (node.isNull()) return 0;
    return Node::createNode(d->document->image(), node);
}

References Node::createNode(), d, krita::Document::Private::document, KisLayerUtils::findNodeByUuid(), and KisSharedPtr< T >::isNull().

◆ operator!=()

bool Document::operator!= ( const Document & other ) const

Definition at line 101 of file Document.cpp.

{
    return !(operator==(other));
}

References operator==().

◆ operator==()

bool Document::operator== ( const Document & other ) const

Definition at line 96 of file Document.cpp.

{
    return (d->document == other.d->document);
}

References d, and krita::Document::Private::document.

◆ pixelData

QByteArray Document::pixelData	(	int	x,
		int	y,
		int	w,
		int	h ) const

slot

pixelData reads the given rectangle from the image projection and returns it as a byte array. The pixel data starts top-left, and is ordered row-first.

The byte array can be interpreted as follows: 8 bits images have one byte per channel, and as many bytes as there are channels. 16 bits integer images have two bytes per channel, representing an unsigned short. 16 bits float images have two bytes per channel, representing a half, or 16 bits float. 32 bits float images have four bytes per channel, representing a float.

You can read outside the image boundaries; those pixels will be transparent black.

The order of channels is:

Integer RGBA: Blue, Green, Red, Alpha
Float RGBA: Red, Green, Blue, Alpha
LabA: L, a, b, Alpha
CMYKA: Cyan, Magenta, Yellow, Key, Alpha
XYZA: X, Y, Z, A
YCbCrA: Y, Cb, Cr, Alpha

The byte array is a copy of the original image data. In Python, you can use bytes, bytearray and the struct module to interpret the data and construct, for instance, a Pillow Image object.

Parameters

x	x position from where to start reading
y	y position from where to start reading
w	row length to read
h	number of rows to read

Returns: a QByteArray with the pixel data. The byte array may be empty.

Definition at line 474 of file Document.cpp.

{
    QByteArray ba;
 
    if (!d->document) return ba;
    KisImageSP image = d->document->image();
    if (!image) return ba;
 
    KisPaintDeviceSP dev = image->projection();
    ba.resize(w * h * dev->pixelSize());
    dev->readBytes(reinterpret_cast<quint8*>(ba.data()), x, y, w, h);
    return ba;
}

References d, krita::Document::Private::document, KisPaintDevice::pixelSize(), KisImage::projection(), and KisPaintDevice::readBytes().

◆ playBackEndTime

int Document::playBackEndTime ( )

slot

get end time of current playback

Returns: end time of current playback

Definition at line 1073 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->activePlaybackRange().end();
}

References d, and krita::Document::Private::document.

◆ playBackStartTime

int Document::playBackStartTime ( )

slot

get start time of current playback

Returns: start time of current playback

Definition at line 1065 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    return d->document->image()->animationInterface()->activePlaybackRange().start();
}

References d, and krita::Document::Private::document.

◆ projection

QImage Document::projection	(	int	x = 0,
		int	y = 0,
		int	w = 0,
		int	h = 0 ) const

slot

projection creates a QImage from the rendered image or a cutout rectangle.

Definition at line 801 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return QImage();
    return d->document->image()->convertToQImage(x, y, w, h, 0);
}

References d, and krita::Document::Private::document.

◆ refreshProjection

void Document::refreshProjection ( )

slot

Starts a synchronous recomposition of the projection: everything will wait until the image is fully recomputed.

Definition at line 839 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return;
    d->document->image()->refreshGraphAsync();
    d->document->image()->waitForDone();
 
}

References d, and krita::Document::Private::document.

◆ removeAnnotation

void Document::removeAnnotation ( const QString & type )

slot

removeAnnotation remove the specified annotation from the image

Parameters

type	the type defining the annotation

Definition at line 1151 of file Document.cpp.

{
    KisImageSP image = d->document->image().toStrongRef();
    image->removeAnnotation(type);
}

References d, krita::Document::Private::document, and KisImage::removeAnnotation().

◆ resizeImage

void Document::resizeImage	(	int	x,
		int	y,
		int	w,
		int	h )

slot

resizeImage resizes the canvas to the given left edge, top edge, width and height. Note: This doesn't scale, use scale image for that.

Parameters

x	the new left edge
y	the new top edge
w	the new width
h	the new height

Definition at line 539 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
    QRect rc;
    rc.setX(x);
    rc.setY(y);
    rc.setWidth(w);
    rc.setHeight(h);
 
    image->resizeImage(rc);
    image->waitForDone();
}

References d, krita::Document::Private::document, KisImage::resizeImage(), and KisImage::waitForDone().

◆ resolution

int Document::resolution ( ) const

slot

Returns: the resolution in pixels per inch

Definition at line 323 of file Document.cpp.

{
    if (!d->document) return 0;
    KisImageSP image = d->document->image();
    if (!image) return 0;
 
    return qRound(d->document->image()->xRes() * 72);
}

References d, and krita::Document::Private::document.

◆ rootNode

Node * Document::rootNode ( ) const

slot

rootNode the root node is the invisible group layer that contains the entire node hierarchy.

Returns: the root of the image

Definition at line 346 of file Document.cpp.

{
    if (!d->document) return 0;
    KisImageSP image = d->document->image();
    if (!image) return 0;
 
    return Node::createNode(image, image->root());
}

References Node::createNode(), d, krita::Document::Private::document, and KisNodeFacade::root.

◆ rotateImage

void Document::rotateImage ( double radians )

slot

rotateImage Rotate the image by the given radians.

Parameters

radians the amount you wish to rotate the image in radians

Definition at line 570 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
    image->rotateImage(radians);
    image->waitForDone();
}

References d, krita::Document::Private::document, KisImage::rotateImage(), and KisImage::waitForDone().

◆ save

bool Document::save ( )

slot

save the image to its currently set path. The modified flag of the document will be reset

Returns: true if saving succeeded, false otherwise.

Definition at line 588 of file Document.cpp.

{
    if (!d->document) return false;
    if (d->document->path().isEmpty()) return false;
 
    bool retval = d->document->save(true, 0);
    d->document->waitForSavingToComplete();
 
    return retval;
}

References d, and krita::Document::Private::document.

◆ saveAs

bool Document::saveAs ( const QString & filename )

slot

saveAs save the document under the filename. The document's filename will be reset to filename.

Parameters

filename the new filename (full path) for the document

Returns: true if saving succeeded, false otherwise.

Definition at line 599 of file Document.cpp.

{
    if (!d->document) return false;
 
    setFileName(filename);
    const QString outputFormatString = KisMimeDatabase::mimeTypeForFile(filename, false);
    const QByteArray outputFormat = outputFormatString.toLatin1();
    QString oldPath = d->document->path();
    d->document->setPath(filename);
    bool retval = d->document->saveAs(filename, outputFormat, true);
    d->document->waitForSavingToComplete();
    d->document->setPath(oldPath);
 
    return retval;
}

References d, krita::Document::Private::document, KisMimeDatabase::mimeTypeForFile(), and setFileName().

◆ scaleImage

void Document::scaleImage	(	int	w,
		int	h,
		int	xres,
		int	yres,
		QString	strategy )

slot

scaleImage

Parameters

w	the new width
h	the new height
xres	the new xres
yres	the new yres
strategy	the scaling strategy. There's several ones amongst these that aren't available in the regular UI. The list of filters is extensible and can be retrieved with Krita::filter Hermite Bicubic - Adds pixels using the color of surrounding pixels. Produces smoother tonal gradations than Bilinear. Box - Replicate pixels in the image. Preserves all the original detail, but can produce jagged effects. Bilinear - Adds pixels averaging the color values of surrounding pixels. Produces medium quality results when the image is scaled from half to two times the original size. Bell BSpline Kanczos3 - Offers similar results than Bicubic, but maybe a little bit sharper. Can produce light and dark halos along strong edges. Mitchell

Definition at line 554 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
    QRect rc = image->bounds();
    rc.setWidth(w);
    rc.setHeight(h);
 
    KisFilterStrategy *actualStrategy = KisFilterStrategyRegistry::instance()->get(strategy);
    if (!actualStrategy) actualStrategy = KisFilterStrategyRegistry::instance()->get("Bicubic");
 
    image->scaleImage(rc.size(), xres / 72.0, yres / 72.0, actualStrategy);
    image->waitForDone();
}

References KisImage::bounds(), d, krita::Document::Private::document, KoGenericRegistry< T >::get(), KisFilterStrategyRegistry::instance(), KisImage::scaleImage(), and KisImage::waitForDone().

◆ selection

Selection * Document::selection ( ) const

slot

selection Create a Selection object around the global selection, if there is one.

Returns: the global selection or None if there is no global selection.

Definition at line 355 of file Document.cpp.

{
    if (!d->document) return 0;
    if (!d->document->image()) return 0;
    if (!d->document->image()->globalSelection()) return 0;
    return new Selection(d->document->image()->globalSelection());
}

References d, and krita::Document::Private::document.

◆ setActiveNode

void Document::setActiveNode ( Node * value )

slot

setActiveNode make the given node active in the currently active view and window

Parameters

value the node to make active.

If we created any nodes via the same script, then dummies state may be not synchronized with the actual state of the nodes in the image. Hence, we should explicitly deliver the synchronized events before we try to manipulate with the GUI representation of nodes.

Definition at line 138 of file Document.cpp.

{
    if (!value) return;
    if (!value->node()) return;
    KisMainWindow *mainWin = KisPart::instance()->currentMainwindow();
    if (!mainWin) return;
    KisViewManager *viewManager = mainWin->viewManager();
    if (!viewManager) return;
    if (viewManager->document() != d->document) return;
    KisNodeManager *nodeManager = viewManager->nodeManager();
    if (!nodeManager) return;
    KisNodeSelectionAdapter *selectionAdapter = nodeManager->nodeSelectionAdapter();
    if (!selectionAdapter) return;
 
    KisSynchronizedConnectionBase::forceDeliverAllSynchronizedEvents();
 
    selectionAdapter->setActiveNode(value->node());
}

References KisPart::currentMainwindow(), d, krita::Document::Private::document, KisViewManager::document(), KisSynchronizedConnectionBase::forceDeliverAllSynchronizedEvents(), KisPart::instance(), KisViewManager::nodeManager(), KisNodeManager::nodeSelectionAdapter(), KisNodeSelectionAdapter::setActiveNode(), value(), and KisMainWindow::viewManager.

◆ setAnnotation

void Document::setAnnotation	(	const QString &	type,
		const QString &	description,
		const QByteArray &	annotation )

slot

setAnnotation Add the given annotation to the document

Parameters

type	the unique type of the annotation
description	the user-visible description of the annotation
annotation	the annotation itself

Definition at line 1143 of file Document.cpp.

{
    KisAnnotation *a = new KisAnnotation(key, description, annotation);
    KisImageSP image = d->document->image().toStrongRef();
    image->addAnnotation(a);
 
}

References KisImage::addAnnotation(), annotation(), d, and krita::Document::Private::document.

◆ setAudioLevel

void Document::setAudioLevel ( const qreal level )

slot

Set current audio level for document.

Parameters

level Audio volume between 0.0 and 1.0 (1.0 = 100%)

Definition at line 1273 of file Document.cpp.

{
    d->document->setAudioVolume(level);
}

References d, and krita::Document::Private::document.

◆ setAudioTracks

bool Document::setAudioTracks ( const QList< QString > files ) const

slot

Set a list of audio tracks for document Note: the function allows to add more than one file while from Krita's UI, importing a file will replace the complete list.

The reason why this method let the ability to provide more than one file is related to the internal's Krita method from KisDocument class: void KisDocument::setAudioTracks(QVector<QFileInfo> f)

Parameters

files List of absolute path/file name of audio files

Returns: True if all files from list have been added, otherwise False (a file was not found)

Definition at line 1287 of file Document.cpp.

{
    bool returned = true;
    QVector<QFileInfo> fileList;
    QFileInfo fileInfo;
    Q_FOREACH(QString fileName, files) {
        fileInfo.setFile(fileName);
        if (fileInfo.exists()) {
            // ensure the file exists before adding it
            fileList.append(fileInfo);
        }
        else {
            // if at least one file is not valid, return false
            returned = false;
        }
    }
    d->document->setAudioTracks(fileList);
    return returned;
}

References d, krita::Document::Private::document, and fileName().

◆ setAutosave

void Document::setAutosave ( bool active )

slot

Allow to activate/deactivate autosave for document When activated, it will use default Krita autosave settings It means that even when autosave is set to True, under condition Krita will not proceed to automatic save of document:

autosave is globally deactivated
document is read-only

Being able to deactivate autosave on a document can make sense when a plugin use internal document (document is not exposed in a view, only created for internal process purposes)

Parameters

active True to activate autosave

Definition at line 1157 of file Document.cpp.

{
    d->document->setAutoSaveActive(active);
}

References d, and krita::Document::Private::document.

◆ setBackgroundColor

bool Document::setBackgroundColor ( const QColor & color )

slot

setBackgroundColor sets the background color of the document. It will trigger a projection update.

Parameters

color A QColor. The color will be converted from sRGB.

Returns: bool

Definition at line 245 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
 
    KoColor background = KoColor(color, d->document->image()->colorSpace());
    d->document->image()->setDefaultProjectionColor(background);
 
    d->document->image()->setModifiedWithoutUndo();
    d->document->image()->initialRefreshGraph();
 
    return true;
}

References d, and krita::Document::Private::document.

◆ setBatchmode

void Document::setBatchmode ( bool value )

slot

Set batchmode to value. If batchmode is true, then there should be no popups or dialogs shown to the user.

Definition at line 112 of file Document.cpp.

{
    if (!d->document) return;
    d->document->setFileBatchMode(value);
}

References d, krita::Document::Private::document, and value().

◆ setColorProfile

bool Document::setColorProfile ( const QString & colorProfile )

slot

setColorProfile set the color profile of the image to the given profile. The profile has to be registered with krita and be compatible with the current color model and depth; the image data is not converted.

Parameters

colorProfile

Returns: false if the colorProfile name does not correspond to to a registered profile or if assigning the profile failed.

Definition at line 210 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
    const KoColorProfile *profile = KoColorSpaceRegistry::instance()->profileByName(value);
    if (!profile) return false;
    bool retval = d->document->image()->assignImageProfile(profile);
    d->document->image()->waitForDone();
    return retval;
}

References d, krita::Document::Private::document, KoColorSpaceRegistry::instance(), KoColorSpaceRegistry::profileByName(), and value().

◆ setColorSpace

bool Document::setColorSpace	(	const QString &	colorModel,
		const QString &	colorDepth,
		const QString &	colorProfile )

slot

setColorSpace convert the nodes and the image to the given colorspace. The conversion is done with Perceptual as intent, High Quality and No LCMS Optimizations as flags and no blackpoint compensation.

Parameters

colorModel	A string describing the color model of the image: A: Alpha mask RGBA: RGB with alpha channel (The actual order of channels is most often BGR!) XYZA: XYZ with alpha channel LABA: LAB with alpha channel CMYKA: CMYK with alpha channel GRAYA: Gray with alpha channel YCbCrA: YCbCr with alpha channel
colorDepth	A string describing the color depth of the image: U8: unsigned 8 bits integer, the most common type U16: unsigned 16 bits integer F16: half, 16 bits floating point. Only available if Krita was built with OpenEXR F32: 32 bits floating point
colorProfile	a valid color profile for this color model and color depth combination.

Returns: false the combination of these arguments does not correspond to a colorspace.

Definition at line 221 of file Document.cpp.

{
    if (!d->document) return false;
    if (!d->document->image()) return false;
    const KoColorSpace *colorSpace = KoColorSpaceRegistry::instance()->colorSpace(colorModel, colorDepth, colorProfile);
    if (!colorSpace) return false;
 
    d->document->image()->convertImageColorSpace(colorSpace,
                                                 KoColorConversionTransformation::IntentPerceptual,
                                                 KoColorConversionTransformation::HighQuality | KoColorConversionTransformation::NoOptimization);
 
    d->document->image()->waitForDone();
    return true;
}

References colorDepth(), colorModel(), colorProfile(), KoColorSpaceRegistry::colorSpace(), d, krita::Document::Private::document, KoColorConversionTransformation::HighQuality, KoColorSpaceRegistry::instance(), KoColorConversionTransformation::IntentPerceptual, and KoColorConversionTransformation::NoOptimization.

◆ setCurrentTime

void Document::setCurrentTime ( int time )

slot

set current time of document's animation

Definition at line 1089 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
 
    return d->document->image()->animationInterface()->requestTimeSwitchWithUndo(time);
}

References d, and krita::Document::Private::document.

◆ setDocumentInfo

void Document::setDocumentInfo ( const QString & document )

slot

setDocumentInfo set the Document information to the information contained in document

Parameters

document A string containing a valid XML document that conforms to the document-info DTD that can be found here:

https://phabricator.kde.org/source/krita/browse/master/krita/dtd/

Definition at line 267 of file Document.cpp.

{
    QDomDocument doc;
    QString errorMsg;
    int errorLine, errorColumn;
    doc.setContent(document, &errorMsg, &errorLine, &errorColumn);
    d->document->documentInfo()->load(doc);
}

References d, and krita::Document::Private::document.

◆ setFileName

void Document::setFileName ( QString value )

slot

setFileName set the full path of the document to

Parameters

value

Definition at line 283 of file Document.cpp.

{
    if (!d->document) return;
    QString mimeType = KisMimeDatabase::mimeTypeForFile(value, false);
    d->document->setMimeType(mimeType.toLatin1());
    d->document->setPath(value);
}

References d, krita::Document::Private::document, KisMimeDatabase::mimeTypeForFile(), and value().

◆ setFramesPerSecond

void Document::setFramesPerSecond ( int fps )

slot

set frames per second of document

Definition at line 1005 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
 
    d->document->image()->animationInterface()->setFramerate(fps);
}

References d, and krita::Document::Private::document.

◆ setFullClipRangeEndTime

void Document::setFullClipRangeEndTime ( int endTime )

slot

set full clip range end time

Definition at line 1031 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
 
    d->document->image()->animationInterface()->setDocumentRangeEndFrame(endTime);
}

References d, and krita::Document::Private::document.

◆ setFullClipRangeStartTime

void Document::setFullClipRangeStartTime ( int startTime )

slot

set start time of animation

Definition at line 1013 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
 
    d->document->image()->animationInterface()->setDocumentRangeStartFrame(startTime);
}

References d, and krita::Document::Private::document.

◆ setGridConfig

void Document::setGridConfig ( GridConfig * gridConfig )

slot

   @brief Set grid configuration for current document
   @param gridConfig a GridConfig object to apply for grid configuration

   To modify/set grid property on a document

# get document (create one or get active one for example)
newDoc = Krita.instance().createDocument(500, 500, "Test", "RGBA", "U8", "", 300)
 
# retrieve document grid configuration
newDocGrid = newDoc.gridConfig()
 
# update properties
newDocGrid.setColorMain(QColor('#ff00ff'))
newDocGrid.setLineTypeMain('dashed')
newDocGrid.setVisible(True)
newDocGrid.setAngleLeft(30)
newDocGrid.setAngleRight(15)
newDocGrid.setType('isometric')
 
# set grid configuration to document
newDoc.setGridConfig(newDocGrid)

Definition at line 1261 of file Document.cpp.

{
    if (!d->document) return;
    KisGridConfig tmpConfig = gridConfig->gridConfig();
    d->document->setGridConfig(tmpConfig);
}

References d, krita::Document::Private::document, gridConfig(), and GridConfig::gridConfig().

◆ setGuidesConfig

void Document::setGuidesConfig ( GuidesConfig * guidesConfig )

slot

   @brief Set guides configuration for current document
   @param guidesConfig a GuidesConfig object to apply for guides configuration

   To modify/set guides property on a document

# get document (create one or get active one for example)
newDoc = Krita.instance().createDocument(500, 500, "Test", "RGBA", "U8", "", 300)
 
# retrieve document guides configuration
newDocGuides = newDoc.guidesConfig()
 
# update properties
newDocGuides.setColor(QColor('#ff00ff'))
newDocGuides.setLineType('dotted')
newDocGuides.setVisible(True)
newDocGuides.setLocked(True)
newDocGuides.setSnap(True)
newDocGuides.setHorizontalGuides([100,200])
 
# set guides configuration to document
newDoc.setGuidesConfig(newDocGuides)

Definition at line 1219 of file Document.cpp.

{
    if (!d->document) return;
    // Like for guidesConfig() method, need to manage transform from internal stored value
    // to pixels values
    KisGuidesConfig tmpConfig = guidesConfig->guidesConfig();
 
    if (d->document->image()) {
        const QTransform imageToDocument =
            QTransform::fromScale(1.0 / d->document->image()->xRes(), 1.0 / d->document->image()->yRes());
        QList<qreal> transformedLines;
        QList<qreal> untransformedLines = tmpConfig.horizontalGuideLines();
        for (int i = 0; i< untransformedLines.size(); i++) {
            qreal untransformedLine = untransformedLines[i];
            transformedLines.append(imageToDocument.map(QPointF(untransformedLine, untransformedLine)).x());
        }
        tmpConfig.setHorizontalGuideLines(transformedLines);
 
        transformedLines.clear();
        untransformedLines = tmpConfig.verticalGuideLines();
        for (int i = 0; i< untransformedLines.size(); i++) {
            qreal untransformedLine = untransformedLines[i];
            transformedLines.append(imageToDocument.map(QPointF(untransformedLine, untransformedLine)).x());
        }
        tmpConfig.setVerticalGuideLines(transformedLines);
    }
    else {
        // unable to proceed to transform, set no guides
        tmpConfig.removeAllGuides();
    }
 
    d->document->setGuidesConfig(tmpConfig);
}

References d, krita::Document::Private::document, guidesConfig(), GuidesConfig::guidesConfig(), KisGuidesConfig::horizontalGuideLines(), KisGuidesConfig::removeAllGuides(), KisGuidesConfig::setHorizontalGuideLines(), KisGuidesConfig::setVerticalGuideLines(), and KisGuidesConfig::verticalGuideLines().

◆ setGuidesLocked

void Document::setGuidesLocked ( bool locked )

slot

DEPRECATED - use guidesConfig() instead set guides locked on this document.

Parameters

locked whether or not to lock the guides on this document.

Definition at line 943 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.setGuidesLocked() - use Document.guidesConfig().setLocked() instead";
    if (!d->document) return;
    KisGuidesConfig config = d->document->guidesConfig();
    config.setLockGuides(locked);
    d->document->setGuidesConfig(config);
}

References d, krita::Document::Private::document, KisGuidesConfig::setLockGuides(), and warnScript.

◆ setGuidesVisible

void Document::setGuidesVisible ( bool visible )

slot

DEPRECATED - use guidesConfig() instead set guides visible on this document.

Parameters

visible whether or not the guides are visible.

Definition at line 934 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.setGuidesVisible() - use Document.guidesConfig().setVisible() instead";
    if (!d->document) return;
    KisGuidesConfig config = d->document->guidesConfig();
    config.setShowGuides(visible);
    d->document->setGuidesConfig(config);
}

References d, krita::Document::Private::document, KisGuidesConfig::setShowGuides(), and warnScript.

◆ setHeight

void Document::setHeight ( int value )

slot

setHeight resize the document to

Parameters

value height. This is a canvas resize, not a scale.

Definition at line 299 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
    resizeImage(d->document->image()->bounds().x(),
                d->document->image()->bounds().y(),
                d->document->image()->width(),
                value);
}

References d, krita::Document::Private::document, resizeImage(), and value().

◆ setHorizontalGuides

void Document::setHorizontalGuides ( const QList< qreal > & lines )

slot

DEPRECATED - use guidesConfig() instead replace all existing horizontal guides with the entries in the list.

Parameters

lines a list of floats containing the new guides.

Definition at line 902 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.setHorizontalGuides() - use Document.guidesConfig().setHorizontalGuides() instead";
    if (!d->document) return;
    KisGuidesConfig config = d->document->guidesConfig();
    const QTransform imageToDocument =
        QTransform::fromScale(1.0 / d->document->image()->xRes(), 1.0 / d->document->image()->yRes());
    QList<qreal> transformedLines;
    for (int i = 0; i< lines.size(); i++) {
        qreal line = lines[i];
        transformedLines.append(imageToDocument.map(QPointF(line, line)).x());
    }
    config.setHorizontalGuideLines(transformedLines);
    d->document->setGuidesConfig(config);
}

References d, krita::Document::Private::document, KisGuidesConfig::setHorizontalGuideLines(), and warnScript.

◆ setModified

void Document::setModified ( bool modified )

slot

setModified sets the modified status of the document

Parameters

modified if true, the document is considered modified and closing it will ask for saving.

Definition at line 958 of file Document.cpp.

{
    if (!d->document) return;
    d->document->setModified(modified);
}

References d, krita::Document::Private::document, and modified().

◆ setName

void Document::setName ( QString value )

slot

setName sets the name of the document to value. This is the title field in the documentInfo

Definition at line 316 of file Document.cpp.

{
    if (!d->document) return;
    d->document->documentInfo()->setAboutInfo("title", value);
}

References d, krita::Document::Private::document, and value().

◆ setOwnsDocument()

void Document::setOwnsDocument ( bool ownsDocument )

private

Definition at line 975 of file Document.cpp.

{
    d->ownsDocument = ownsDocument;
}

References d, and krita::Document::Private::ownsDocument.

◆ setPlayBackRange

void Document::setPlayBackRange	(	int	start,
		int	stop )

slot

set temporary playback range of document

Definition at line 1056 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
 
    const KisTimeSpan newTimeRange = KisTimeSpan::fromTimeWithDuration(start, (stop-start));
    d->document->image()->animationInterface()->setActivePlaybackRange(newTimeRange);
}

References d, krita::Document::Private::document, and KisTimeSpan::fromTimeWithDuration().

◆ setResolution

void Document::setResolution ( int value )

slot

setResolution set the resolution of the image; this does not scale the image

Parameters

value the resolution in pixels per inch

Definition at line 332 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
 
    KisFilterStrategy *strategy = KisFilterStrategyRegistry::instance()->get("Bicubic");
    KIS_SAFE_ASSERT_RECOVER_RETURN(strategy);
 
    image->scaleImage(image->size(), value / 72.0, value / 72.0, strategy);
    image->waitForDone();
}

References d, krita::Document::Private::document, KoGenericRegistry< T >::get(), KisFilterStrategyRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisImage::scaleImage(), KisImage::size(), value(), and KisImage::waitForDone().

◆ setSelection

void Document::setSelection ( Selection * value )

slot

setSelection set or replace the global selection

Parameters

value a valid selection object.

Definition at line 363 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
    if (value) {
        d->document->image()->undoAdapter()->addCommand(new KisSetGlobalSelectionCommand(d->document->image(), value->selection()));
    }
    else {
        d->document->image()->undoAdapter()->addCommand(new KisSetGlobalSelectionCommand(d->document->image(), nullptr));
    }
}

References d, krita::Document::Private::document, and value().

◆ setVerticalGuides

void Document::setVerticalGuides ( const QList< qreal > & lines )

slot

DEPRECATED - use guidesConfig() instead replace all existing horizontal guides with the entries in the list.

Parameters

lines a list of floats containing the new guides.

Definition at line 918 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.setVerticalGuides() - use Document.guidesConfig().setVerticalGuides() instead";
    if (!d->document) return;
    KisGuidesConfig config = d->document->guidesConfig();
    const QTransform imageToDocument =
        QTransform::fromScale(1.0 / d->document->image()->xRes(), 1.0 / d->document->image()->yRes());
    QList<qreal> transformedLines;
    for (int i = 0; i< lines.size(); i++) {
        qreal line = lines[i];
        transformedLines.append(imageToDocument.map(QPointF(line, line)).y());
    }
    config.setVerticalGuideLines(transformedLines);
    d->document->setGuidesConfig(config);
}

References d, krita::Document::Private::document, KisGuidesConfig::setVerticalGuideLines(), and warnScript.

◆ setWidth

void Document::setWidth ( int value )

slot

setWidth resize the document to

Parameters

value width. This is a canvas resize, not a scale.

Definition at line 384 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
    resizeImage(d->document->image()->bounds().x(),
                d->document->image()->bounds().y(),
                value,
                d->document->image()->height());
}

References d, krita::Document::Private::document, resizeImage(), and value().

◆ setXOffset

void Document::setXOffset ( int x )

slot

setXOffset sets the left edge of the canvas to x.

Definition at line 403 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
    resizeImage(x,
                d->document->image()->bounds().y(),
                d->document->image()->width(),
                d->document->image()->height());
}

References d, krita::Document::Private::document, and resizeImage().

◆ setXRes

void Document::setXRes ( double xRes ) const

slot

setXRes set the horizontal resolution of the image to xRes in pixels per inch

Definition at line 440 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
 
    KisFilterStrategy *strategy = KisFilterStrategyRegistry::instance()->get("Bicubic");
    KIS_SAFE_ASSERT_RECOVER_RETURN(strategy);
 
    image->scaleImage(image->size(), xRes / 72.0, image->yRes(), strategy);
    image->waitForDone();
}

References d, krita::Document::Private::document, KoGenericRegistry< T >::get(), KisFilterStrategyRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisImage::scaleImage(), KisImage::size(), KisImage::waitForDone(), xRes(), and KisImage::yRes().

◆ setYOffset

void Document::setYOffset ( int y )

slot

setYOffset sets the top edge of the canvas to y.

Definition at line 422 of file Document.cpp.

{
    if (!d->document) return;
    if (!d->document->image()) return;
    resizeImage(d->document->image()->bounds().x(),
                y,
                d->document->image()->width(),
                d->document->image()->height());
}

References d, krita::Document::Private::document, and resizeImage().

◆ setYRes

void Document::setYRes ( double yRes ) const

slot

setYRes set the vertical resolution of the image to yRes in pixels per inch

Definition at line 460 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
 
    KisFilterStrategy *strategy = KisFilterStrategyRegistry::instance()->get("Bicubic");
    KIS_SAFE_ASSERT_RECOVER_RETURN(strategy);
 
    image->scaleImage(image->size(), image->xRes(), yRes / 72.0, strategy);
    image->waitForDone();
}

References d, krita::Document::Private::document, KoGenericRegistry< T >::get(), KisFilterStrategyRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisImage::scaleImage(), KisImage::size(), KisImage::waitForDone(), KisImage::xRes(), and yRes().

◆ shearImage

void Document::shearImage	(	double	angleX,
		double	angleY )

slot

shearImage shear the whole image.

Parameters

angleX	the X-angle in degrees to shear by
angleY	the Y-angle in degrees to shear by

Definition at line 579 of file Document.cpp.

{
    if (!d->document) return;
    KisImageSP image = d->document->image();
    if (!image) return;
    image->shear(angleX, angleY);
    image->waitForDone();
}

References d, krita::Document::Private::document, KisImage::shear(), and KisImage::waitForDone().

◆ thumbnail

QImage Document::thumbnail	(	int	w,
		int	h ) const

slot

thumbnail create a thumbnail of the given dimensions.

If the requested size is too big a null QImage is created.

Returns: a QImage representing the layer contents.

Definition at line 807 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return QImage();
    return d->document->generatePreview(QSize(w, h)).toImage();
}

References d, and krita::Document::Private::document.

◆ topLevelNodes

QList< Node * > Document::topLevelNodes ( ) const

slot

toplevelNodes return a list with all top level nodes in the image graph

Definition at line 163 of file Document.cpp.

{
    if (!d->document) return QList<Node *>();
    Node n(d->document->image(), d->document->image()->rootLayer());
    return n.childNodes();
}

References Node::childNodes(), d, and krita::Document::Private::document.

◆ tryBarrierLock

bool Document::tryBarrierLock ( )

slot

Tries to lock the image without waiting for the jobs to finish.

Same as barrierLock(), but doesn't block execution of the calling thread until all the background jobs are finished. Instead, in case of presence of unfinished jobs in the queue, it just returns false

Returns: whether the lock has been acquired

Definition at line 833 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return false;
    return d->document->image()->tryBarrierLock();
}

References d, and krita::Document::Private::document.

◆ unlock

void Document::unlock ( )

slot

Unlocks the image and starts/resumes all the pending internal jobs. If the image has been locked for a non-readOnly access, then all the internal caches of the image (e.g. lod-planes) are reset and regeneration jobs are scheduled.

Definition at line 820 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return;
    d->document->image()->unlock();
}

References d, and krita::Document::Private::document.

◆ verticalGuides

QList< qreal > Document::verticalGuides ( ) const

slot

DEPRECATED - use guidesConfig() instead The vertical guide lines.

Returns: a list of vertical guides.

Definition at line 863 of file Document.cpp.

{
    warnScript << "DEPRECATED Document.verticalGuides() - use Document.guidesConfig().verticalGuides() instead";
    QList<qreal> lines;
    if (!d->document || !d->document->image()) return lines;
    const QTransform documentToImage =
        QTransform::fromScale(d->document->image()->xRes(), d->document->image()->yRes());
    QList<qreal> untransformedLines = d->document->guidesConfig().verticalGuideLines();
    for (int i = 0; i< untransformedLines.size(); i++) {
        qreal line = untransformedLines[i];
        lines.append(documentToImage.map(QPointF(line, line)).y());
    }
    return lines;
}

References d, krita::Document::Private::document, and warnScript.

◆ waitForDone

void Document::waitForDone ( )

slot

Wait for all the internal image jobs to complete and return without locking the image. This function is handy for tests or other synchronous actions, when one needs to wait for the result of his actions.

Definition at line 826 of file Document.cpp.

{
    if (!d->document || !d->document->image()) return;
    KisLayerUtils::forceAllDelayedNodesUpdate(d->document->image()->rootLayer());
    d->document->image()->waitForDone();
}

References d, krita::Document::Private::document, and KisLayerUtils::forceAllDelayedNodesUpdate().

◆ width

int Document::width ( ) const

slot

Returns: the width of the image in pixels.

Definition at line 376 of file Document.cpp.

{
    if (!d->document) return 0;
    KisImageSP image = d->document->image();
    if (!image) return 0;
    return image->width();
}

References d, krita::Document::Private::document, and KisImage::width().

◆ xOffset

int Document::xOffset ( ) const

slot

Returns: the left edge of the canvas in pixels.

Definition at line 395 of file Document.cpp.

{
    if (!d->document) return 0;
    KisImageSP image = d->document->image();
    if (!image) return 0;
    return image->bounds().x();
}

References KisImage::bounds(), d, and krita::Document::Private::document.

◆ xRes

double Document::xRes ( ) const

slot

Returns: xRes the horizontal resolution of the image in pixels per inch

Definition at line 433 of file Document.cpp.

{
    if (!d->document) return 0.0;
    if (!d->document->image()) return 0.0;
    return d->document->image()->xRes()*72.0;
}

References d, and krita::Document::Private::document.

◆ yOffset

int Document::yOffset ( ) const

slot

Returns: the top edge of the canvas in pixels.

Definition at line 414 of file Document.cpp.

{
    if (!d->document) return 0;
    KisImageSP image = d->document->image();
    if (!image) return 0;
    return image->bounds().y();
}

References KisImage::bounds(), d, and krita::Document::Private::document.

◆ yRes

double Document::yRes ( ) const

slot

Returns: yRes the vertical resolution of the image in pixels per inch

Definition at line 453 of file Document.cpp.

{
    if (!d->document) return 0.0;
    if (!d->document->image()) return 0.0;
    return d->document->image()->yRes()*72.0;
}

References d, and krita::Document::Private::document.

Friends And Related Symbol Documentation

◆ Filter

friend class Filter

friend

Definition at line 1056 of file Document.h.

◆ Krita

friend class Krita

friend

Definition at line 1054 of file Document.h.

◆ Shape

friend class Shape

friend

Freehand and shapes like ellipses and lines.

Definition at line 1059 of file Document.h.

◆ VectorLayer

friend class VectorLayer

friend

Definition at line 1058 of file Document.h.

◆ View

friend class View

friend

Assistance tools: guides, reference, etc.

Definition at line 1057 of file Document.h.

◆ Window

friend class Window

friend

Definition at line 1055 of file Document.h.

Member Data Documentation

◆ d

Private* const Document::d

private

Definition at line 1065 of file Document.h.

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

libs/libkis/Document.h
libs/libkis/Document.cpp

Public Slots

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Document()

◆ ~Document()

Member Function Documentation

◆ activeNode

◆ animationLength

◆ annotation

◆ annotationDescription

◆ annotationTypes

◆ audioLevel

◆ audioTracks

◆ autosave

◆ backgroundColor

◆ batchmode

◆ bounds

◆ clone

◆ close

◆ colorDepth

◆ colorModel

◆ colorProfile

◆ createCloneLayer

◆ createColorizeMask

◆ createFileLayer

◆ createFillLayer

◆ createFilterLayer

◆ createFilterMask [1/2]

◆ createFilterMask [2/2]

◆ createGroupLayer

◆ createNode

◆ createSelectionMask

◆ createTransformMask

◆ createTransparencyMask

◆ createVectorLayer

◆ crop

◆ currentTime

◆ document()

◆ documentInfo

◆ exportImage

◆ fileName

◆ flatten

◆ framesPerSecond

◆ fullClipRangeEndTime

◆ fullClipRangeStartTime

◆ gridConfig

◆ guidesConfig

◆ guidesLocked

◆ guidesVisible

◆ height

◆ horizontalGuides

◆ importAnimation

◆ lock

◆ modified

◆ name

◆ nodeByName

◆ nodeByUniqueID

◆ operator!=()

◆ operator==()

◆ pixelData

◆ playBackEndTime

◆ playBackStartTime

◆ projection

◆ refreshProjection

◆ removeAnnotation

◆ resizeImage

◆ resolution

◆ rootNode

◆ rotateImage

◆ save

◆ saveAs

◆ scaleImage

◆ selection

◆ setActiveNode

◆ setAnnotation

◆ setAudioLevel