#include <kis_base_node.h>

Inheritance diagram for KisBaseNode:

Classes
struct	Property

Public Types
typedef QList< Property >	PropertyList

Signals
void	keyframeChannelAdded (KisKeyframeChannel *channel)

void	opacityChanged (quint8 value)

Public Member Functions
virtual bool	accept (KisNodeVisitor &)

virtual void	accept (KisProcessingVisitor &visitor, KisUndoAdapter *undoAdapter)

bool	belongsToIsolatedGroup () const

bool	check (const KoProperties &properties) const

bool	collapsed () const

int	colorLabelIndex () const

virtual KisPaintDeviceSP	colorSampleSourceDevice () const

virtual const KoColorSpace *	colorSpace () const =0

virtual const KoCompositeOp *	compositeOp () const =0

const QString &	compositeOpId () const

QImage	createPreferredThumbnail (qint32 w, qint32 h, Qt::AspectRatioMode aspectRatioMode=Qt::IgnoreAspectRatio)

QImage	createPreferredThumbnailForFrame (qint32 w, qint32 h, int time, Qt::AspectRatioMode aspectRatioMode=Qt::IgnoreAspectRatio)

virtual QImage	createThumbnail (qint32 w, qint32 h, Qt::AspectRatioMode aspectRatioMode=Qt::IgnoreAspectRatio, KisThumbnailBoundsMode boundsMode=KisThumbnailBoundsMode::Precise)

virtual QImage	createThumbnailForFrame (qint32 w, qint32 h, int time, Qt::AspectRatioMode aspectRatioMode=Qt::IgnoreAspectRatio, KisThumbnailBoundsMode boundsMode=KisThumbnailBoundsMode::Precise)

void	enableAnimation ()

virtual QRect	exactBounds () const

virtual QRect	extent () const

KisKeyframeChannel *	getKeyframeChannel (const QString &id) const

KisKeyframeChannel *	getKeyframeChannel (const QString &id, bool create)

bool	hasEditablePaintDevice () const

virtual QIcon	icon () const

KisImageWSP	image () const

bool	isAnimated () const

bool	isEditable (bool checkVisibility=true) const

virtual bool	isFakeNode () const

bool	isIsolatedRoot () const

bool	isPinnedToTimeline () const

QMap< QString, KisKeyframeChannel * >	keyframeChannels () const

	KisBaseNode (const KisBaseNode &rhs)

	KisBaseNode (KisImageWSP image)

void	mergeNodeProperties (const KoProperties &properties)

QString	name () const

const KoProperties &	nodeProperties () const

quint8	opacity () const

virtual KisPaintDeviceSP	original () const =0

virtual KisPaintDeviceSP	paintDevice () const =0

quint8	percentOpacity () const

KisThumbnailBoundsMode	preferredThumbnailBoundsMode () const

	Private (const Private &rhs)

	Private (KisImageWSP p_image)

virtual KisPaintDeviceSP	projection () const =0

virtual PropertyList	sectionModelProperties () const

void	setCollapsed (bool collapsed)

void	setColorLabelIndex (int index)

void	setCompositeOpId (const QString &compositeOpId)

virtual void	setImage (KisImageWSP image)

void	setName (const QString &name)

void	setNodeProperty (const QString &name, const QVariant &value)

void	setOpacity (quint8 val)

void	setPercentOpacity (quint8 val)

void	setPinnedToTimeline (bool pinned)

void	setPreferredThumbnailBoundsMode (KisThumbnailBoundsMode value) const

virtual void	setSectionModelProperties (const PropertyList &properties)

virtual void	setUserLocked (bool l)

void	setUuid (const QUuid &id)

virtual void	setVisible (bool visible, bool loading=false)

virtual void	setX (qint32)

virtual void	setY (qint32)

virtual bool	supportsKeyframeChannel (const QString &id)

bool	supportsLodMoves () const

virtual bool	supportsLodPainting () const

virtual int	thumbnailSeqNo () const

virtual void	updateSettings ()

bool	userLocked () const

QUuid	uuid () const

virtual bool	visible (bool recursive=false) const

virtual qint32	x () const

virtual qint32	y () const

	~KisBaseNode () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Public Attributes
bool	animated {false}

bool	collapsed {false}

QString	compositeOp

KisBaseNode::Property	hack_visible

QUuid	id

KisImageWSP	image

QMap< QString, KisKeyframeChannel * >	keyframeChannels

KisAnimatedOpacityProperty	opacityProperty

bool	pinnedToTimeline {false}

KoProperties	properties

bool	supportsLodMoves {false}

KisThumbnailBoundsMode	thumbnailBoundsMode { KisThumbnailBoundsMode::Precise }

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Protected Member Functions
virtual void	addKeyframeChannel (KisKeyframeChannel *channel)

virtual void	baseNodeChangedCallback ()

virtual void	baseNodeCollapsedChangedCallback ()

virtual void	baseNodeInvalidateAllFramesCallback ()

virtual void	notifyParentVisibilityChanged (bool value)

virtual KisBaseNodeSP	parentCallback () const

virtual KisKeyframeChannel *	requestKeyframeChannel (const QString &id)

void	setSupportsLodMoves (bool value)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Private Attributes
Private *const	m_d

Detailed Description

A KisBaseNode is the base class for all components of an image: nodes, layers masks, selections. A node has a number of properties, can be represented as a thumbnail and knows what to do when it gets a certain paint device to process. A KisBaseNode does not know anything about its peers. You should not directly inherit from a KisBaseNode; inherit from KisNode instead.

Definition at line 25 of file kis_base_node.cpp.

Member Typedef Documentation

◆ PropertyList

typedef QList<Property> KisBaseNode::PropertyList

Return this type for PropertiesRole.

Definition at line 103 of file kis_base_node.h.

Constructor & Destructor Documentation

◆ KisBaseNode() [1/2]

KisBaseNode::KisBaseNode ( KisImageWSP image )

Create a new, empty base node. The node is unnamed, unlocked visible and unlinked.

Be cautious! These two calls are vital to warm-up KoProperties. We use it and its QMap in a threaded environment. This is not officially supported by Qt, but our environment guarantees, that there will be the only writer and several readers. Whilst the value of the QMap is boolean and there are no implicit-sharing calls provocated, it is safe to work with it in such an environment.

Definition at line 66 of file kis_base_node.cpp.

    : m_d(new Private(image))
{
    setVisible(true, true);
    setUserLocked(false);
    setCollapsed(false);
    setSupportsLodMoves(true);
 
    m_d->compositeOp = COMPOSITE_OVER;
 
    connect(&m_d->opacityProperty, SIGNAL(changed(quint8)), this, SIGNAL(opacityChanged(quint8)));
}

References COMPOSITE_OVER, m_d, opacityChanged(), setCollapsed(), setSupportsLodMoves(), setUserLocked(), and setVisible().

◆ KisBaseNode() [2/2]

KisBaseNode::KisBaseNode ( const KisBaseNode & rhs )

Create a copy of this node.

Definition at line 89 of file kis_base_node.cpp.

    : QObject()
    , KisShared()
    , m_d(new Private(*rhs.m_d))
{
    if (rhs.m_d->opacityProperty.hasChannel()) {
        m_d->opacityProperty.transferKeyframeData(rhs.m_d->opacityProperty);
        m_d->keyframeChannels.insert(m_d->opacityProperty.channel()->id(), m_d->opacityProperty.channel());
    }
 
    connect(&m_d->opacityProperty, SIGNAL(changed(quint8)), this, SIGNAL(opacityChanged(quint8)));
}

References m_d, and opacityChanged().

◆ ~KisBaseNode()

KisBaseNode::~KisBaseNode ( )

override

Delete this node

Definition at line 102 of file kis_base_node.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

◆ accept() [1/2]

virtual bool KisBaseNode::accept ( KisNodeVisitor & )

inlinevirtual

Accept the KisNodeVisitor (for the Visitor design pattern), should call the correct function on the KisNodeVisitor for this node type, so you need to override it for all leaf classes in the node inheritance hierarchy.

return false if the visitor could not successfully act on this node instance.

Reimplemented in KisGeneratorLayer, KisAdjustmentLayer, KisCloneLayer, KisShapeLayer, KisReferenceImagesLayer, KisFileLayer, KisDecorationsWrapperLayer, KisFilterMask, KisGroupLayer, KisNode, KisPaintLayer, KisSelectionMask, KisTransformMask, KisTransparencyMask, and KisColorizeMask.

Definition at line 297 of file kis_base_node.h.

                                          {
        return false;
    }

◆ accept() [2/2]

virtual void KisBaseNode::accept	(	KisProcessingVisitor &	visitor,
		KisUndoAdapter *	undoAdapter )

inlinevirtual

Accept the KisNodeVisitor (for the Visitor design pattern), should call the correct function on the KisProcessingVisitor for this node type, so you need to override it for all leaf classes in the node inheritance hierarchy.

The processing visitor differs from node visitor in the way that it accepts undo adapter, that allows the processing to be multithreaded

Reimplemented in KisGeneratorLayer, KisAdjustmentLayer, KisCloneLayer, KisFilterMask, KisGroupLayer, KisNode, KisPaintLayer, KisSelectionMask, KisTransformMask, KisTransparencyMask, KisColorizeMask, KisShapeLayer, KisReferenceImagesLayer, KisFileLayer, and KisDecorationsWrapperLayer.

Definition at line 311 of file kis_base_node.h.

                                                                                    {
        Q_UNUSED(visitor);
        Q_UNUSED(undoAdapter);
    }

◆ addKeyframeChannel()

void KisBaseNode::addKeyframeChannel ( KisKeyframeChannel * channel )

protectedvirtual

Add a keyframe channel for this node. The channel will be added to the common hash table which will be available to the UI.

WARNING: the channel object NOT become owned by the node! The caller must ensure manually that the lifetime of the object coincide with the lifetime of the node.

Reimplemented in KisNode.

Definition at line 462 of file kis_base_node.cpp.

{
    m_d->keyframeChannels.insert(channel->id(), channel);
    Q_EMIT keyframeChannelAdded(channel);
}

References KisKeyframeChannel::id(), keyframeChannelAdded(), and m_d.

◆ baseNodeChangedCallback()

virtual void KisBaseNode::baseNodeChangedCallback ( )

inlineprotectedvirtual

This callback is called when some meta state of the base node that can be interesting to the UI has changed. E.g. visibility, lockness, opacity, compositeOp and etc. This signal is forwarded by the KisNode and KisNodeGraphListener to the model in KisLayerBox, so it can update its controls when information changes.

Reimplemented in KisMask, and KisNode.

Definition at line 585 of file kis_base_node.h.

585 {

586 }

◆ baseNodeCollapsedChangedCallback()

virtual void KisBaseNode::baseNodeCollapsedChangedCallback ( )

inlineprotectedvirtual

This callback is called when collapsed state of the base node has changed. This signal is forwarded by the KisNode and KisNodeGraphListener to the model in KisLayerBox, so it can update its controls when information changes.

Reimplemented in KisNode.

Definition at line 594 of file kis_base_node.h.

594 {

595 }

◆ baseNodeInvalidateAllFramesCallback()

virtual void KisBaseNode::baseNodeInvalidateAllFramesCallback ( )

inlineprotectedvirtual

Reimplemented in KisNode.

Definition at line 598 of file kis_base_node.h.

598 {

599 }

◆ belongsToIsolatedGroup()

bool KisBaseNode::belongsToIsolatedGroup ( ) const

Return whether or not the given node is isolated.

Definition at line 272 of file kis_base_node.cpp.

{
    if (!m_d->image) {
        return false;
    }
 
    const KisBaseNode* element = this;
 
    while (element) {
        if (element->isIsolatedRoot()) {
            return true;
        } else {
            element = element->parentCallback().data();
        }
    }
 
    return false;
}

References KisSharedPtr< T >::data(), isIsolatedRoot(), m_d, and parentCallback().

◆ check()

bool KisBaseNode::check ( const KoProperties & properties ) const

Compare the given properties list with the properties of this node.

Returns: false only if the same property exists in both lists but with a different value. Properties that are not in both lists are disregarded.

Definition at line 184 of file kis_base_node.cpp.

{
    QMapIterator<QString, QVariant> iter = properties.propertyIterator();
    while (iter.hasNext()) {
        iter.next();
        if (m_d->properties.contains(iter.key())) {
            if (m_d->properties.value(iter.key()) != iter.value())
                return false;
        }
    }
    return true;
}

References m_d, properties, and KoProperties::propertyIterator().

◆ collapsed()

bool KisBaseNode::collapsed ( ) const

returns the collapsed state of this node

◆ colorLabelIndex()

int KisBaseNode::colorLabelIndex ( ) const

See also: setColorLabelIndex

Definition at line 361 of file kis_base_node.cpp.

{
    return m_d->properties.intProperty(KisLayerPropertiesIcons::colorLabelIndex.id(), 0);
}

References KisLayerPropertiesIcons::colorLabelIndex, and m_d.

◆ colorSampleSourceDevice()

KisPaintDeviceSP KisBaseNode::colorSampleSourceDevice ( ) const

virtual

Returns: a special device from where the color sampler tool should sample color when in layer-only mode. For most of the nodes just shortcuts to projection() device. TODO: can it be null?

Reimplemented in KisColorizeMask.

Definition at line 107 of file kis_base_node.cpp.

{
    return projection();
}

References projection().

◆ colorSpace()

virtual const KoColorSpace * KisBaseNode::colorSpace ( ) const

pure virtual

Implemented in KisCloneLayer, KisGroupLayer, KisLayer, KisMask, and KisColorizeMask.

◆ compositeOp()

virtual const KoCompositeOp * KisBaseNode::compositeOp ( ) const

pure virtual

Return the composite op associated with this layer.

Implemented in KisLayer, and KisMask.

◆ compositeOpId()

const QString & KisBaseNode::compositeOpId ( ) const

Definition at line 133 of file kis_base_node.cpp.

{
    return m_d->compositeOp;
}

References m_d.

◆ createPreferredThumbnail()

QImage KisBaseNode::createPreferredThumbnail	(	qint32	w,
		qint32	h,
		Qt::AspectRatioMode	aspectRatioMode = Qt::IgnoreAspectRatio )

Create a thumbnail in the currently preferred bounds mode

See also: preferredThumbnailBoundsMode()

Definition at line 213 of file kis_base_node.cpp.

{
    return createThumbnail(w, h, aspectRatioMode, m_d->thumbnailBoundsMode);
}

References createThumbnail(), and m_d.

◆ createPreferredThumbnailForFrame()

QImage KisBaseNode::createPreferredThumbnailForFrame	(	qint32	w,
		qint32	h,
		int	time,
		Qt::AspectRatioMode	aspectRatioMode = Qt::IgnoreAspectRatio )

Definition at line 239 of file kis_base_node.cpp.

{
    return createThumbnailForFrame(w, h, time, aspectRatioMode, m_d->thumbnailBoundsMode);
}

References createThumbnailForFrame(), and m_d.

◆ createThumbnail()

QImage KisBaseNode::createThumbnail	(	qint32	w,
		qint32	h,
		Qt::AspectRatioMode	aspectRatioMode = Qt::IgnoreAspectRatio,
		KisThumbnailBoundsMode	boundsMode = KisThumbnailBoundsMode::Precise )

virtual

Returns: a thumbnail in requested size. The thumbnail is a rgba QImage and may have transparent parts. Returns a fully transparent QImage of the requested size if the current node type cannot generate a thumbnail. If the requested size is too big, return a null QImage.

Reimplemented in KisLayer, KisMask, and KisSelectionBasedLayer.

Definition at line 198 of file kis_base_node.cpp.

{
    Q_UNUSED(aspectRatioMode);
    Q_UNUSED(boundsMode);
 
    try {
        QImage image(w, h, QImage::Format_ARGB32);
        image.fill(0);
        return image;
    } catch (const std::bad_alloc&) {
        return QImage();
    }
 
}

References image.

◆ createThumbnailForFrame()

QImage KisBaseNode::createThumbnailForFrame	(	qint32	w,
		qint32	h,
		int	time,
		Qt::AspectRatioMode	aspectRatioMode = Qt::IgnoreAspectRatio,
		KisThumbnailBoundsMode	boundsMode = KisThumbnailBoundsMode::Precise )

virtual

Returns: a thumbnail in requested size for the defined timestamp. The thumbnail is a rgba Image and may have transparent parts. Returns a fully transparent QImage of the requested size if the current node type cannot generate a thumbnail. If the requested size is too big, return a null QImage.

Reimplemented in KisLayer.

Definition at line 233 of file kis_base_node.cpp.

{
    Q_UNUSED(time);
    return createThumbnail(w, h, aspectRatioMode, boundsMode);
}

References createThumbnail().

◆ enableAnimation()

void KisBaseNode::enableAnimation ( )

Definition at line 456 of file kis_base_node.cpp.

{
    m_d->animated = true;
    baseNodeChangedCallback();
}

References baseNodeChangedCallback(), and m_d.

◆ exactBounds()

virtual QRect KisBaseNode::exactBounds ( ) const

inlinevirtual

Returns the exact bounds of where the actual data resides in this node.

Reimplemented in KisCloneLayer, KisFilterMask, KisGroupLayer, KisLayer, KisMask, KisPaintLayer, KisSelectionBasedLayer, KisSelectionMask, KisTransformMask, KisTransparencyMask, and KisColorizeMask.

Definition at line 481 of file kis_base_node.h.

                                      {
        return QRect();
    }

◆ extent()

virtual QRect KisBaseNode::extent ( ) const

inlinevirtual

Returns an approximation of where the bounds on actual data are in this node.

Reimplemented in KisCloneLayer, KisFilterMask, KisGroupLayer, KisLayer, KisMask, KisPaintLayer, KisSelectionBasedLayer, KisSelectionMask, KisTransformMask, KisTransparencyMask, and KisColorizeMask.

Definition at line 473 of file kis_base_node.h.

                                 {
        return QRect();
    }

◆ getKeyframeChannel() [1/2]

KisKeyframeChannel * KisBaseNode::getKeyframeChannel ( const QString & id ) const

Definition at line 414 of file kis_base_node.cpp.

{
    QMap<QString, KisKeyframeChannel*>::const_iterator i = m_d->keyframeChannels.constFind(id);
    if (i == m_d->keyframeChannels.constEnd()) {
        return 0;
    }
    return i.value();
}

References m_d.

◆ getKeyframeChannel() [2/2]

KisKeyframeChannel * KisBaseNode::getKeyframeChannel	(	const QString &	id,
		bool	create )

Get the keyframe channel with given id. If the channel does not yet exist and the node supports the requested channel, it will be created if create is true.

Parameters

id	internal name for channel
create	attempt to create the channel if it does not exist yet

Returns: keyframe channel with the id, or null if not found

Definition at line 436 of file kis_base_node.cpp.

{
    KisKeyframeChannel *channel = getKeyframeChannel(id);
 
    if (!channel && create) {
        channel = requestKeyframeChannel(id);
 
        if (channel) {
            addKeyframeChannel(channel);
        }
    }
 
    return channel;
}

References addKeyframeChannel(), getKeyframeChannel(), and requestKeyframeChannel().

◆ hasEditablePaintDevice()

bool KisBaseNode::hasEditablePaintDevice ( ) const

Returns: true if the node is editable and has a paintDevice() which can be used for accessing pixels. It is an equivalent to (isEditable() && paintDevice())

Definition at line 330 of file kis_base_node.cpp.

{
    return paintDevice() && isEditable();
}

References isEditable(), and paintDevice().

◆ icon()

virtual QIcon KisBaseNode::icon ( ) const

inlinevirtual

Returns: the icon used to represent the node type, for instance in the layerbox and in the menu.

Reimplemented in KisGeneratorLayer, KisAdjustmentLayer, KisCloneLayer, KisEffectMask, KisExternalLayer, KisFilterMask, KisGroupLayer, KisPaintLayer, KisSelectionMask, KisTransformMask, KisTransparencyMask, KisColorizeMask, KisShapeLayer, and KisFileLayer.

Definition at line 230 of file kis_base_node.h.

                               {
        return QIcon();
    }

◆ image()

KisImageWSP KisBaseNode::image ( ) const

◆ isAnimated()

bool KisBaseNode::isAnimated ( ) const

Definition at line 451 of file kis_base_node.cpp.

{
    return m_d->animated;
}

References m_d.

◆ isEditable()

bool KisBaseNode::isEditable ( bool checkVisibility = true ) const

Returns: true if the node can be edited:

if checkVisibility is true, then the node is only editable if it is visible and not locked. if checkVisibility is false, then the node is editable if it's not locked.

Definition at line 311 of file kis_base_node.cpp.

{
    bool editable = true;
    if (checkVisibility) {
        editable = ((visible(false) || belongsToIsolatedGroup()) && !userLocked());
    }
    else {
        editable = (!userLocked());
    }
 
    if (editable) {
        KisBaseNodeSP parentNode = parentCallback();
        if (parentNode && parentNode != this) {
            editable = parentNode->isEditable(checkVisibility);
        }
    }
    return editable;
}

References belongsToIsolatedGroup(), parentCallback(), userLocked(), and visible().

◆ isFakeNode()

bool KisBaseNode::isFakeNode ( ) const

virtual

Fake node is not present in the layer stack and is not used for normal projection rendering algorithms.

Reimplemented in KisReferenceImagesLayer, and KisDecorationsWrapperLayer.

Definition at line 398 of file kis_base_node.cpp.

{
    return false;
}

◆ isIsolatedRoot()

bool KisBaseNode::isIsolatedRoot ( ) const

Return whether or not the given node is the root of isolation.

Definition at line 291 of file kis_base_node.cpp.

{
    if (!m_d->image) {
        return false;
    }
 
    const KisBaseNode* isolatedRoot = m_d->image->isolationRootNode().data();
 
    return (this == isolatedRoot);
}

References m_d.

◆ isPinnedToTimeline()

bool KisBaseNode::isPinnedToTimeline ( ) const

Returns: If true, node will be visible on animation timeline even when inactive.

Definition at line 423 of file kis_base_node.cpp.

{
    return m_d->pinnedToTimeline;
}

References m_d.

◆ keyframeChannelAdded

void KisBaseNode::keyframeChannelAdded ( KisKeyframeChannel * channel )

signal

◆ keyframeChannels()

QMap< QString, KisKeyframeChannel * > KisBaseNode::keyframeChannels ( ) const

Return the keyframe channels associated with this node

Returns: list of keyframe channels

◆ mergeNodeProperties()

void KisBaseNode::mergeNodeProperties ( const KoProperties & properties )

Merge the specified properties with the properties of this layer. Wherever these properties overlap, the value of the node properties is changed. No properties on the node are deleted. If there are new properties in this list, they will be added on the node.

Definition at line 173 of file kis_base_node.cpp.

{
    QMapIterator<QString, QVariant> iter = properties.propertyIterator();
    while (iter.hasNext()) {
        iter.next();
        m_d->properties.setProperty(iter.key(), iter.value());
    }
    baseNodeChangedCallback();
    baseNodeInvalidateAllFramesCallback();
}

References baseNodeChangedCallback(), baseNodeInvalidateAllFramesCallback(), m_d, properties, and KoProperties::propertyIterator().

◆ name()

QString KisBaseNode::name ( ) const

inline

return the name of this node. This is the same as the QObject::objectName.

Definition at line 212 of file kis_base_node.h.

                         {
        return objectName();
    }

◆ nodeProperties()

const KoProperties & KisBaseNode::nodeProperties ( ) const

Return all the properties of this layer as a KoProperties-based serializable key-value list.

Definition at line 162 of file kis_base_node.cpp.

{
    return m_d->properties;
}

References m_d.

◆ notifyParentVisibilityChanged()

virtual void KisBaseNode::notifyParentVisibilityChanged ( bool value )

inlineprotectedvirtual

Reimplemented in KisCloneLayer, and KisNode.

Definition at line 573 of file kis_base_node.h.

                                                           {
        Q_UNUSED(value);
    }

References value().

◆ opacity()

quint8 KisBaseNode::opacity ( ) const

Return the opacity of this layer, scaled to a range between 0 and 255. XXX: Allow true float opacity

Definition at line 112 of file kis_base_node.cpp.

{
    return m_d->opacityProperty.get();
}

References m_d.

◆ opacityChanged

void KisBaseNode::opacityChanged ( quint8 value )

signal

◆ original()

virtual KisPaintDeviceSP KisBaseNode::original ( ) const

pure virtual

Returns: the rendered representation of a node before the effect masks have had their go at it. Can be 0.

Implemented in KisCloneLayer, KisGroupLayer, KisMask, KisPaintLayer, KisSelectionBasedLayer, KisShapeLayer, KisFileLayer, KisDecorationsWrapperLayer, and KisLayer.

◆ paintDevice()

virtual KisPaintDeviceSP KisBaseNode::paintDevice ( ) const

pure virtual

Return the paintdevice you can use to change pixels on. For a paint layer these will be paint pixels, for an adjustment layer or a mask the selection paint device.

Returns: the paint device to paint on. Can be 0 if the actual node type does not support painting.

Implemented in KisCloneLayer, KisGroupLayer, KisMask, KisPaintLayer, KisSelectionBasedLayer, KisTransformMask, KisColorizeMask, KisShapeLayer, KisFileLayer, and KisDecorationsWrapperLayer.

◆ parentCallback()

virtual KisBaseNodeSP KisBaseNode::parentCallback ( ) const

inlineprotectedvirtual

FIXME: This method is a workaround for getting parent node on a level of KisBaseNode. In fact, KisBaseNode should inherit KisNode (in terms of current Krita) to be able to traverse the node stack

Reimplemented in KisNode.

Definition at line 569 of file kis_base_node.h.

                                                 {
        return KisBaseNodeSP();
    }

◆ percentOpacity()

quint8 KisBaseNode::percentOpacity ( ) const

return the 8-bit opacity of this layer scaled to the range 0-100

XXX: Allow true float opacity

Definition at line 123 of file kis_base_node.cpp.

{
    return int(float(opacity() * 100) / 255 + 0.5);
}

References opacity().

◆ preferredThumbnailBoundsMode()

KisThumbnailBoundsMode KisBaseNode::preferredThumbnailBoundsMode ( ) const

Returns: the currently preferred bounds mode for the thumbnails (whether to use exactBounds() or extent())

Some layers with huge areas of empty pixels may take too much time to generate a thumbnail (because of slow exactBounds() calculation).

If thumbnail generator notices a slowdown it switches the layer's thumbnail generation into Coarse mode, which will force thumbnails to be genrated from extent() of the device instead.

Definition at line 218 of file kis_base_node.cpp.

{
    return m_d->thumbnailBoundsMode;
}

References m_d.

◆ Private() [1/2]

KisBaseNode::Private ( const Private & rhs )

inline

Definition at line 48 of file kis_base_node.cpp.

        : compositeOp(rhs.compositeOp),
          id(QUuid::createUuid()),
          opacityProperty(new KisDefaultBounds(rhs.image), &properties, OPACITY_OPAQUE_U8),
          collapsed(rhs.collapsed),
          supportsLodMoves(rhs.supportsLodMoves),
          animated(rhs.animated),
          pinnedToTimeline(rhs.pinnedToTimeline),
          image(rhs.image)
    {
        QMapIterator<QString, QVariant> iter = rhs.properties.propertyIterator();
        while (iter.hasNext()) {
            iter.next();
            properties.setProperty(iter.key(), iter.value());
        }
    }

References KoProperties::setProperty().

◆ Private() [2/2]

KisBaseNode::Private ( KisImageWSP p_image )

inline

Definition at line 41 of file kis_base_node.cpp.

        : id(QUuid::createUuid())
        , opacityProperty(new KisDefaultBounds(p_image), &properties, OPACITY_OPAQUE_U8)
        , image(p_image)
    {
    }

◆ projection()

virtual KisPaintDeviceSP KisBaseNode::projection ( ) const

pure virtual

Returns: the fully rendered representation of this layer: its rendered original and its effect masks. Can be 0.

Implemented in KisLayer, and KisMask.

◆ requestKeyframeChannel()

KisKeyframeChannel * KisBaseNode::requestKeyframeChannel ( const QString & id )

protectedvirtual

Attempt to create the requested channel. Used internally by getKeyframeChannel. Subclasses should implement this method to catch any new channel types they support.

Parameters

id	channel to create

Returns: newly created channel or null

Reimplemented in KisMask, KisPaintLayer, KisSelectionBasedLayer, and KisTransformMask.

Definition at line 468 of file kis_base_node.cpp.

{
    if (id == KisKeyframeChannel::Opacity.id()) {
        Q_ASSERT(!m_d->opacityProperty.hasChannel());
 
        KisPaintDeviceSP device = original();
        KisNode* node = dynamic_cast<KisNode*>(this);
 
        if (device && node) {
            m_d->opacityProperty.makeAnimated(node);
            return m_d->opacityProperty.channel();
        }
    }
 
    return 0;
}

References m_d, KisKeyframeChannel::Opacity, and original().

◆ sectionModelProperties()

KisBaseNode::PropertyList KisBaseNode::sectionModelProperties ( ) const

virtual

Return a the properties of this base node (locked, visible etc, with the right icons for their representation and their state.

Subclasses can extend this list with new properties, like opacity for layers or visualized for masks.

The order of properties is, unfortunately, for now, important, so take care which properties superclasses of your class define.

KisBaseNode defines visible = 0, locked = 1 KisLayer defines opacity = 2, compositeOp = 3 KisMask defines active = 2 (KisMask does not inherit kislayer)

Reimplemented in KisGeneratorLayer, KisAdjustmentLayer, KisCloneLayer, KisGroupLayer, KisLayer, KisPaintLayer, KisSelectionMask, KisColorizeMask, KisShapeLayer, and KisFileLayer.

Definition at line 147 of file kis_base_node.cpp.

{
    KisBaseNode::PropertyList l;
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::visible, visible(), m_d->hack_visible.isInStasis, m_d->hack_visible.stateInStasis);
    l << KisLayerPropertiesIcons::getProperty(KisLayerPropertiesIcons::locked, userLocked());
    return l;
}

References KisLayerPropertiesIcons::getProperty(), KisLayerPropertiesIcons::locked, m_d, userLocked(), visible(), and KisLayerPropertiesIcons::visible.

◆ setCollapsed()

void KisBaseNode::setCollapsed ( bool collapsed )

Sets the state of the node to the value of

Parameters

collapsed

Definition at line 335 of file kis_base_node.cpp.

{
    const bool oldCollapsed = m_d->collapsed;
 
    m_d->collapsed = collapsed;
 
    if (oldCollapsed != collapsed) {
        baseNodeCollapsedChangedCallback();
    }
}

References baseNodeCollapsedChangedCallback(), collapsed, and m_d.

◆ setColorLabelIndex()

void KisBaseNode::setColorLabelIndex ( int index )

Sets a color label index associated to the layer. The actual color of the label and the number of available colors is defined by Krita GUI configuration.

Definition at line 351 of file kis_base_node.cpp.

{
    const int currentLabel = colorLabelIndex();
 
    if (currentLabel == index) return;
 
    m_d->properties.setProperty(KisLayerPropertiesIcons::colorLabelIndex.id(), index);
    baseNodeChangedCallback();
}

References baseNodeChangedCallback(), colorLabelIndex(), KisLayerPropertiesIcons::colorLabelIndex, and m_d.

◆ setCompositeOpId()

void KisBaseNode::setCompositeOpId ( const QString & compositeOpId )

Set a new composite op for this layer. The layer will be marked dirty.

Definition at line 138 of file kis_base_node.cpp.

{
    if (m_d->compositeOp == compositeOp) return;
 
    m_d->compositeOp = compositeOp;
    baseNodeChangedCallback();
    baseNodeInvalidateAllFramesCallback();
}

References baseNodeChangedCallback(), baseNodeInvalidateAllFramesCallback(), compositeOp, and m_d.

◆ setImage()

void KisBaseNode::setImage ( KisImageWSP image )

virtual

Reimplemented in KisCloneLayer, KisGroupLayer, KisLayer, KisMask, KisPaintLayer, KisSelectionBasedLayer, KisTransformMask, KisColorizeMask, KisShapeLayer, KisFileLayer, KisDecorationsWrapperLayer, and KisNode.

Definition at line 387 of file kis_base_node.cpp.

{
    m_d->image = image;
    m_d->opacityProperty.updateDefaultBounds(new KisDefaultBounds(image));
}

References image, and m_d.

◆ setName()

void KisBaseNode::setName ( const QString & name )

inline

set the QObject::objectName. This is also the user-visible name of the layer. The reason for this is that we want to see the layer name also when debugging.

Definition at line 221 of file kis_base_node.h.

                                      {
        setObjectName(name);
        baseNodeChangedCallback();
    }

◆ setNodeProperty()

void KisBaseNode::setNodeProperty	(	const QString &	name,
		const QVariant &	value )

Set a node property.

Parameters

name	name of the property to be set.
value	value to set the property to.

Definition at line 167 of file kis_base_node.cpp.

{
    m_d->properties.setProperty(name, value);
    baseNodeChangedCallback();
}

References baseNodeChangedCallback(), m_d, name(), and value().

◆ setOpacity()

void KisBaseNode::setOpacity ( quint8 val )

Set the opacity for this layer. The range is between 0 and 255. The layer will be marked dirty.

XXX: Allow true float opacity

Definition at line 117 of file kis_base_node.cpp.

{
    m_d->opacityProperty.set(val);
    baseNodeChangedCallback();
}

References baseNodeChangedCallback(), and m_d.

◆ setPercentOpacity()

void KisBaseNode::setPercentOpacity ( quint8 val )

Set the opacity of this layer with a number between 0 and 100; the number will be scaled to between 0 and 255. XXX: Allow true float opacity

Definition at line 128 of file kis_base_node.cpp.

{
    setOpacity(int(float(val * 255) / 100 + 0.5));
}

References setOpacity().

◆ setPinnedToTimeline()

void KisBaseNode::setPinnedToTimeline ( bool pinned )

Set whether node should be visible on animation timeline even when inactive.

Definition at line 428 of file kis_base_node.cpp.

{
   if (pinned == m_d->pinnedToTimeline) return;
 
   m_d->pinnedToTimeline = pinned;
   baseNodeChangedCallback();
}

References baseNodeChangedCallback(), and m_d.

◆ setPreferredThumbnailBoundsMode()

void KisBaseNode::setPreferredThumbnailBoundsMode ( KisThumbnailBoundsMode value ) const

Set preferred bounds mode for the layer thumbnails

See also: preferredThumbnailBoundsMode()

Definition at line 223 of file kis_base_node.cpp.

{
    m_d->thumbnailBoundsMode = value;
}

References m_d, and value().

◆ setSectionModelProperties()

void KisBaseNode::setSectionModelProperties ( const PropertyList & properties )

virtual

Change the section model properties.

Reimplemented in KisGroupLayer, KisLayer, KisPaintLayer, KisSelectionMask, KisColorizeMask, KisShapeLayer, and KisFileLayer.

Definition at line 155 of file kis_base_node.cpp.

{
    setVisible(properties.at(0).state.toBool());
    m_d->hack_visible = properties.at(0);
    setUserLocked(properties.at(1).state.toBool());
}

References m_d, properties, setUserLocked(), and setVisible().

◆ setSupportsLodMoves()

void KisBaseNode::setSupportsLodMoves ( bool value )

protected

Definition at line 403 of file kis_base_node.cpp.

{
    m_d->supportsLodMoves = value;
}

References m_d, and value().

◆ setUserLocked()

void KisBaseNode::setUserLocked ( bool l )

virtual

Set the locked status of this node. Locked nodes cannot be edited.

Reimplemented in KisShapeLayer.

Definition at line 302 of file kis_base_node.cpp.

{
    const bool isLocked = m_d->properties.boolProperty(KisLayerPropertiesIcons::locked.id(), true);
    if (isLocked == locked) return;
 
    m_d->properties.setProperty(KisLayerPropertiesIcons::locked.id(), locked);
    baseNodeChangedCallback();
}

References baseNodeChangedCallback(), KisLayerPropertiesIcons::locked, and m_d.

◆ setUuid()

void KisBaseNode::setUuid ( const QUuid & id )

Set the uuid of node. This should only be used when loading existing node and in constructor.

Definition at line 371 of file kis_base_node.cpp.

{
    m_d->id = id;
    baseNodeChangedCallback();
}

References baseNodeChangedCallback(), id, and m_d.

◆ setVisible()

void KisBaseNode::setVisible	(	bool	visible,
		bool	loading = false )

virtual

Set the visible status of this node. Visible nodes are active in the graph (except for selections masks which can be active while hidden), that is to say, they are taken into account when merging. Invisible nodes play no role in the final image , but will be modified when modifying all layers, for instance when cropping.

Toggling the visibility of a node will not automatically lead to recomposition.

Parameters

visible	the new visibility state
isLoading	if true, the property is set during loading.

Reimplemented in KisSelectionMask, and KisShapeLayer.

Definition at line 253 of file kis_base_node.cpp.

{
    const bool isVisible = m_d->properties.boolProperty(KisLayerPropertiesIcons::visible.id(), true);
    if (!loading && isVisible == visible) return;
 
    m_d->properties.setProperty(KisLayerPropertiesIcons::visible.id(), visible);
    notifyParentVisibilityChanged(visible);
 
    if (!loading) {
        baseNodeChangedCallback();
        baseNodeInvalidateAllFramesCallback();
    }
}

References baseNodeChangedCallback(), baseNodeInvalidateAllFramesCallback(), m_d, notifyParentVisibilityChanged(), visible(), and KisLayerPropertiesIcons::visible.

◆ setX()

virtual void KisBaseNode::setX ( qint32 )

inlinevirtual

Set the x offset of this layer in the image place. Re-implement this where it makes sense, by default it does nothing. It should not move child nodes.

Reimplemented in KisGeneratorLayer, KisGroupLayer, KisLayer, KisMask, KisSelectionBasedLayer, KisTransformMask, KisColorizeMask, KisCloneLayer, and KisShapeLayer.

Definition at line 451 of file kis_base_node.h.

451 {

452 }

◆ setY()

virtual void KisBaseNode::setY ( qint32 )

inlinevirtual

Set the y offset of this layer in the image place. Re-implement this where it makes sense, by default it does nothing. It should not move child nodes.

Reimplemented in KisGeneratorLayer, KisGroupLayer, KisLayer, KisMask, KisSelectionBasedLayer, KisTransformMask, KisColorizeMask, KisCloneLayer, and KisShapeLayer.

Definition at line 466 of file kis_base_node.h.

466 {

467 }

◆ supportsKeyframeChannel()

bool KisBaseNode::supportsKeyframeChannel ( const QString & id )

virtual

Ideally, this function would be used to query for keyframe support before trying to create channels. The ability to query would help in cases such as animation curves where you might want to ask which channels it supports before allowing the user to add.

Parameters

id	queried channel

Returns: bool whether it supports said channel or not.

Reimplemented in KisMask, KisPaintLayer, KisSelectionBasedLayer, and KisTransformMask.

Definition at line 485 of file kis_base_node.cpp.

{
    if (id == KisKeyframeChannel::Opacity.id() && original()) {
        return true;
    }
 
    return false;
}

References KisKeyframeChannel::Opacity, and original().

◆ supportsLodMoves()

bool KisBaseNode::supportsLodMoves ( ) const

Returns true if the offset of the node can be changed in a LodN stroke. Currently, all the nodes except shape layers support that.

◆ supportsLodPainting()

bool KisBaseNode::supportsLodPainting ( ) const

virtual

Returns true if the node can be painted via KisPaintDevice. Notable exceptions are selection-based layers and masks.

Reimplemented in KisMask, and KisSelectionBasedLayer.

Definition at line 382 of file kis_base_node.cpp.

{
    return true;
}

◆ thumbnailSeqNo()

int KisBaseNode::thumbnailSeqNo ( ) const

virtual

Returns: a sequence number of the thumbnail of the node. Every time the layer changes, the sequence number increases.

Reimplemented in KisLayer, KisMask, and KisSelectionBasedLayer.

Definition at line 228 of file kis_base_node.cpp.

{
    return -1;
}

◆ updateSettings()

virtual void KisBaseNode::updateSettings ( )

inlinevirtual

Ask this node to re-read the pertinent settings from the krita configuration.

Definition at line 372 of file kis_base_node.h.

372 {

373 }

◆ userLocked()

bool KisBaseNode::userLocked ( ) const

Return the locked status of this node. Locked nodes cannot be edited.

Definition at line 267 of file kis_base_node.cpp.

{
    return m_d->properties.boolProperty(KisLayerPropertiesIcons::locked.id(), false);
}

References KisLayerPropertiesIcons::locked, and m_d.

◆ uuid()

QUuid KisBaseNode::uuid ( ) const

Returns: unique id, which is now used by clone layers.

Definition at line 366 of file kis_base_node.cpp.

{
    return m_d->id;
}

References m_d.

◆ visible()

bool KisBaseNode::visible ( bool recursive = false ) const

virtual

Returns: true if this node is visible (i.e, active (except for selection masks where visible and active properties are different)) in the graph

Parameters

bool	recursive if true, check whether all parents of this node are visible as well.

Reimplemented in KisShapeLayer.

Definition at line 244 of file kis_base_node.cpp.

{
    bool isVisible = m_d->properties.boolProperty(KisLayerPropertiesIcons::visible.id(), true);
    KisBaseNodeSP parentNode = parentCallback();
 
    return recursive && isVisible && parentNode ?
        parentNode->visible(recursive) : isVisible;
}

References m_d, parentCallback(), and KisLayerPropertiesIcons::visible.

◆ x()

virtual qint32 KisBaseNode::x ( ) const

inlinevirtual

Returns: the x-offset of this layer in the image plane.

Reimplemented in KisCloneLayer, KisGroupLayer, KisLayer, KisMask, KisSelectionBasedLayer, KisTransformMask, KisColorizeMask, and KisShapeLayer.

Definition at line 442 of file kis_base_node.h.

                             {
        return 0;
    }

◆ y()

virtual qint32 KisBaseNode::y ( ) const

inlinevirtual

Returns: the y-offset of this layer in the image plane.

Reimplemented in KisCloneLayer, KisGroupLayer, KisLayer, KisMask, KisSelectionBasedLayer, KisTransformMask, KisColorizeMask, and KisShapeLayer.

Definition at line 457 of file kis_base_node.h.

                             {
        return 0;
    }

Member Data Documentation

◆ animated

bool KisBaseNode::animated {false}

Definition at line 36 of file kis_base_node.cpp.

36{false};

◆ collapsed

bool KisBaseNode::collapsed {false}

Definition at line 34 of file kis_base_node.cpp.

34{false};

◆ compositeOp

QString KisBaseNode::compositeOp

Definition at line 27 of file kis_base_node.cpp.

◆ hack_visible

KisBaseNode::Property KisBaseNode::hack_visible

Definition at line 29 of file kis_base_node.cpp.

◆ id

QUuid KisBaseNode::id

Definition at line 30 of file kis_base_node.cpp.

◆ image

KisImageWSP KisBaseNode::image

Definition at line 38 of file kis_base_node.cpp.

◆ keyframeChannels

QMap< QString, KisKeyframeChannel * > KisBaseNode::keyframeChannels

Definition at line 31 of file kis_base_node.cpp.

◆ m_d

Private* const KisBaseNode::m_d

private

Definition at line 638 of file kis_base_node.h.

◆ opacityProperty

KisAnimatedOpacityProperty KisBaseNode::opacityProperty

Definition at line 32 of file kis_base_node.cpp.

◆ pinnedToTimeline

bool KisBaseNode::pinnedToTimeline {false}

Definition at line 37 of file kis_base_node.cpp.

37{false};

◆ properties

KoProperties KisBaseNode::properties

Definition at line 28 of file kis_base_node.cpp.

◆ supportsLodMoves

bool KisBaseNode::supportsLodMoves {false}

Definition at line 35 of file kis_base_node.cpp.

35{false};

◆ thumbnailBoundsMode

KisThumbnailBoundsMode KisBaseNode::thumbnailBoundsMode { KisThumbnailBoundsMode::Precise }

Definition at line 39 of file kis_base_node.cpp.

39{ KisThumbnailBoundsMode::Precise };

KisThumbnailBoundsMode::Precise

@ Precise

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

libs/image/kis_base_node.cpp
libs/image/kis_base_node.h

Classes

Public Types

Signals

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ PropertyList

Constructor & Destructor Documentation

◆ KisBaseNode() [1/2]

◆ KisBaseNode() [2/2]

◆ ~KisBaseNode()

Member Function Documentation

◆ accept() [1/2]

◆ accept() [2/2]

◆ addKeyframeChannel()

◆ baseNodeChangedCallback()

◆ baseNodeCollapsedChangedCallback()

◆ baseNodeInvalidateAllFramesCallback()

◆ belongsToIsolatedGroup()

◆ check()

◆ collapsed()

◆ colorLabelIndex()

◆ colorSampleSourceDevice()

◆ colorSpace()

◆ compositeOp()

◆ compositeOpId()

◆ createPreferredThumbnail()

◆ createPreferredThumbnailForFrame()

◆ createThumbnail()

◆ createThumbnailForFrame()

◆ enableAnimation()

◆ exactBounds()

◆ extent()

◆ getKeyframeChannel() [1/2]

◆ getKeyframeChannel() [2/2]

◆ hasEditablePaintDevice()

◆ icon()

◆ image()

◆ isAnimated()

◆ isEditable()

◆ isFakeNode()

◆ isIsolatedRoot()

◆ isPinnedToTimeline()

◆ keyframeChannelAdded

◆ keyframeChannels()

◆ mergeNodeProperties()

◆ name()

◆ nodeProperties()

◆ notifyParentVisibilityChanged()

◆ opacity()

◆ opacityChanged

◆ original()

◆ paintDevice()

◆ parentCallback()

◆ percentOpacity()

◆ preferredThumbnailBoundsMode()

◆ Private() [1/2]

◆ Private() [2/2]

◆ projection()

◆ requestKeyframeChannel()

◆ sectionModelProperties()

◆ setCollapsed()

◆ setColorLabelIndex()

◆ setCompositeOpId()

◆ setImage()

◆ setName()

◆ setNodeProperty()

◆ setOpacity()

◆ setPercentOpacity()

◆ setPinnedToTimeline()

◆ setPreferredThumbnailBoundsMode()

◆ setSectionModelProperties()

◆ setSupportsLodMoves()

◆ setUserLocked()

◆ setUuid()

◆ setVisible()

◆ setX()