KisNodePropertyListCommand Class Reference

The command for changing the property list of a layer. More...

#include <kis_node_property_list_command.h>

Inheritance diagram for KisNodePropertyListCommand:

Public Types
typedef KisBaseNode::PropertyList	PropertyList

Public Member Functions
bool	canAnnihilateWith (const KUndo2Command *other) const override
bool	canMergeWith (const KUndo2Command *command) const override
int	id () const override
	KisNodePropertyListCommand (KisNodeSP node, KisBaseNode::PropertyList newPropertyList)
bool	mergeWith (const KUndo2Command *command) override
void	redo () override
void	undo () override
Public Member Functions inherited from KisNodeCommand
	KisNodeCommand (const KUndo2MagicString &name, KisNodeSP node)
	~KisNodeCommand () override
Public Member Functions inherited from KUndo2Command
QString	actionText () const
const KUndo2Command *	child (int index) const
int	childCount () const
virtual QTime	endTime () const
KUndo2CommandExtraData *	extraData () const
bool	hasParent () const
virtual bool	isMerged () const
	KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)
	KUndo2Command (KUndo2Command *parent=0)
virtual QVector< KUndo2Command * >	mergeCommandsVector () const
virtual void	redoMergedCommands ()
void	setEndTime ()
virtual void	setEndTime (const QTime &time)
void	setExtraData (KUndo2CommandExtraData *data)
void	setText (const KUndo2MagicString &text)
void	setTime ()
virtual void	setTime (const QTime &time)
virtual void	setTimedID (int timedID)
KUndo2MagicString	text () const
virtual QTime	time () const
virtual int	timedId () const
virtual bool	timedMergeWith (KUndo2Command *other)
virtual void	undoMergedCommands ()
virtual	~KUndo2Command ()
Public Member Functions inherited from KisAsynchronouslyMergeableCommandInterface
virtual	~KisAsynchronouslyMergeableCommandInterface ()

Static Public Member Functions
static void	setNodePropertiesAutoUndo (KisNodeSP node, KisImageSP image, PropertyList proplist)

Private Member Functions
void	doUpdate (const KisBaseNode::PropertyList &oldPropertyList, const KisBaseNode::PropertyList &newPropertyList, const QRect &totalUpdateExtent)

Static Private Member Functions
static const QSet< QString > &	propsWithNoUpdates ()

Private Attributes
KisBaseNode::PropertyList	m_newPropertyList
KisBaseNode::PropertyList	m_oldPropertyList

Additional Inherited Members
Protected Attributes inherited from KisNodeCommand
KisNodeSP	m_node

Detailed Description

The command for changing the property list of a layer.

Definition at line 16 of file kis_node_property_list_command.h.

Member Typedef Documentation

PropertyList

typedef KisBaseNode::PropertyList KisNodePropertyListCommand::PropertyList

Definition at line 35 of file kis_node_property_list_command.h.

Constructor & Destructor Documentation

KisNodePropertyListCommand()

KisNodePropertyListCommand::KisNodePropertyListCommand	(	KisNodeSP	node,
		KisBaseNode::PropertyList	newPropertyList )

Constructor

Parameters

node	the layer to add
newPropertyList	the property list to which the node to be added

TODO instead of "Property Changes" check which property has been changed and display either lock/unlock, visible/hidden or "Property Changes" (this require new strings)

Definition at line 58 of file kis_node_property_list_command.cpp.

    : KisNodeCommand(kundo2_i18n("Property Changes"), node),
      m_newPropertyList(newPropertyList),
      m_oldPropertyList(node->sectionModelProperties())
{
}

Member Function Documentation

canAnnihilateWith()

bool KisNodePropertyListCommand::canAnnihilateWith ( const KUndo2Command * other ) const

overridevirtual

Attempts to merge this command with command and checks if the two commands compensate each other. If the function returns true, both commands are removed from the stack.

If this function returns true, calling this command's redo() followed by other redo() must have no effect.

The function itself shouldn't do any changes to the command, because after returning true, the command will be deleted as a "noop"

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also

id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 138 of file kis_node_property_list_command.cpp.

{
    const KisNodePropertyListCommand *other =
        dynamic_cast<const KisNodePropertyListCommand*>(command);
 
    return other && other->m_node == m_node &&
            changedProperties(m_oldPropertyList, other->m_newPropertyList).isEmpty();
}

References m_newPropertyList, KisNodeCommand::m_node, and m_oldPropertyList.

canMergeWith()

bool KisNodePropertyListCommand::canMergeWith ( const KUndo2Command * command ) const

overridevirtual

Returns

true if command can be merged with (*this) command using KUndo2Command::mergeWith() call.

WARNING: if canMergeWith() returned true, then mergeWith() must also return true. Otherwise KisSavedMacroCommand will be able to enter inconsistent state and assert.

Implements KisAsynchronouslyMergeableCommandInterface.

Definition at line 127 of file kis_node_property_list_command.cpp.

{
    const KisNodePropertyListCommand *other =
        dynamic_cast<const KisNodePropertyListCommand*>(command);
 
    return other && other->m_node == m_node &&
        (changedProperties(m_oldPropertyList, m_newPropertyList).isEmpty() ||
         changedProperties(m_oldPropertyList, m_newPropertyList) ==
             changedProperties(other->m_oldPropertyList, other->m_newPropertyList));
}

References m_newPropertyList, KisNodeCommand::m_node, and m_oldPropertyList.

doUpdate()

void KisNodePropertyListCommand::doUpdate ( const KisBaseNode::PropertyList & oldPropertyList, const KisBaseNode::PropertyList & newPropertyList, const QRect & totalUpdateExtent )

private

Sometimes the node might refuse to change the property, e.g. needs-update for colorize mask. In this case we should avoid issuing the update and set-modified call.

Definition at line 154 of file kis_node_property_list_command.cpp.

{
    if (oldPropertyList == newPropertyList) {
        return;
    }
 
    bool oldPassThroughValue = false;
    bool newPassThroughValue = false;
 
    bool oldVisibilityValue = false;
    bool newVisibilityValue = false;
 
    Q_FOREACH (const KisBaseNode::Property &prop, oldPropertyList) {
        if (prop.id == KisLayerPropertiesIcons::passThrough.id()) {
            oldPassThroughValue = prop.state.toBool();
        }
        if (prop.id == KisLayerPropertiesIcons::visible.id()) {
            oldVisibilityValue = prop.state.toBool();
        }
    }
 
    Q_FOREACH (const KisBaseNode::Property &prop, newPropertyList) {
        if (prop.id == KisLayerPropertiesIcons::passThrough.id()) {
            newPassThroughValue = prop.state.toBool();
        }
        if (prop.id == KisLayerPropertiesIcons::visible.id()) {
            newVisibilityValue = prop.state.toBool();
        }
    }
 
    if (oldPassThroughValue && !newPassThroughValue) {
        KisLayerSP layer(qobject_cast<KisLayer*>(m_node.data()));
        KisImageSP image = layer->image().toStrongRef();
        if (image) {
            image->refreshGraphAsync(layer);
        }
    } else if ((m_node->parent() && !oldPassThroughValue && newPassThroughValue) ||
               (oldPassThroughValue && newPassThroughValue &&
                !oldVisibilityValue && newVisibilityValue)) {
 
        KisLayerSP layer(qobject_cast<KisLayer*>(m_node->parent().data()));
        KisImageSP image = layer->image().toStrongRef();
        if (image) {
            image->refreshGraphAsync(layer);
        }
    } else if (checkOnionSkinChanged(oldPropertyList, newPropertyList)) {
        m_node->setDirtyDontResetAnimationCache(totalUpdateExtent);
    } else {
        m_node->setDirty(totalUpdateExtent); // TODO check if visibility was actually changed or not
    }
}

References checkOnionSkinChanged(), KisSharedPtr< T >::data(), KisWeakSharedPtr< T >::data(), KoID::id(), KisBaseNode::Property::id, KisBaseNode::image, KisNodeCommand::m_node, KisNode::parent, KisLayerPropertiesIcons::passThrough, KisImage::refreshGraphAsync(), KisNode::setDirty(), KisNode::setDirtyDontResetAnimationCache(), KisBaseNode::Property::state, KisWeakSharedPtr< T >::toStrongRef(), and KisLayerPropertiesIcons::visible.

id()

int KisNodePropertyListCommand::id ( ) const

overridevirtual

Returns the ID of this command.

A command ID is used in command compression. It must be an integer unique to this command's class, or -1 if the command doesn't support compression.

If the command supports compression this function must be overridden in the derived class to return the correct ID. The base implementation returns -1.

KUndo2QStack::push() will only try to merge two commands if they have the same ID, and the ID is not -1.

See also

mergeWith(), KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 98 of file kis_node_property_list_command.cpp.

{
    return KisCommandUtils::NodePropertyListCommandId;
}

References KisCommandUtils::NodePropertyListCommandId.

mergeWith()

bool KisNodePropertyListCommand::mergeWith ( const KUndo2Command * command )

overridevirtual

Attempts to merge this command with command. Returns true on success; otherwise returns false.

If this function returns true, calling this command's redo() must have the same effect as redoing both this command and command. Similarly, calling this command's undo() must have the same effect as undoing command and this command.

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also

id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 103 of file kis_node_property_list_command.cpp.

{
    const KisNodePropertyListCommand *other =
        dynamic_cast<const KisNodePropertyListCommand*>(command);
 
    if (other && other->m_node == m_node &&
        (changedProperties(m_oldPropertyList, m_newPropertyList).isEmpty() ||
         changedProperties(m_oldPropertyList, m_newPropertyList) ==
             changedProperties(other->m_oldPropertyList, other->m_newPropertyList))) {
 
        const QSet<QString> changedInTheMeantime =
            changedProperties(m_newPropertyList, other->m_oldPropertyList);
 
        KIS_SAFE_ASSERT_RECOVER_NOOP(changedInTheMeantime.isEmpty() ||
                                     (changedInTheMeantime.size() == 1 &&
                                      *changedInTheMeantime.begin() == KisLayerPropertiesIcons::colorOverlay.id()));
 
        m_newPropertyList = other->m_newPropertyList;
        return true;
    }
 
    return false;
}

References KisLayerPropertiesIcons::colorOverlay, KoID::id(), KIS_SAFE_ASSERT_RECOVER_NOOP, m_newPropertyList, KisNodeCommand::m_node, and m_oldPropertyList.

propsWithNoUpdates()

const QSet< QString > & KisNodePropertyListCommand::propsWithNoUpdates ( )

staticprivate

Definition at line 212 of file kis_node_property_list_command.cpp.

{
    static const QSet<QString> noUpdates {
        KisLayerPropertiesIcons::locked.id(),
        KisLayerPropertiesIcons::alphaLocked.id(),
        KisLayerPropertiesIcons::selectionActive.id(),
        KisLayerPropertiesIcons::colorLabelIndex.id(),
        KisLayerPropertiesIcons::colorizeNeedsUpdate.id(),
        KisLayerPropertiesIcons::openFileLayerFile.id(),
        KisLayerPropertiesIcons::layerError.id()
    };
    return noUpdates;
}

References KisLayerPropertiesIcons::alphaLocked, KisLayerPropertiesIcons::colorizeNeedsUpdate, KisLayerPropertiesIcons::colorLabelIndex, KoID::id(), KisLayerPropertiesIcons::layerError, KisLayerPropertiesIcons::locked, KisLayerPropertiesIcons::openFileLayerFile, and KisLayerPropertiesIcons::selectionActive.

redo()

void KisNodePropertyListCommand::redo ( )

overridevirtual

Applies a change to the document. This function must be implemented in the derived class. Calling KUndo2QStack::push(), KUndo2QStack::undo() or KUndo2QStack::redo() from this function leads to undefined behavior.

The default implementation calls redo() on all child commands.

See also

undo()

Reimplemented from KUndo2Command.

Definition at line 70 of file kis_node_property_list_command.cpp.

{
    const KisBaseNode::PropertyList propsBefore = m_node->sectionModelProperties();
    const QSet<QString> changed = changedProperties(propsBefore, m_newPropertyList);
    if (changed.isEmpty()) return;
 
    const QRect oldExtent = m_node->projectionPlane()->tightUserVisibleBounds();
    m_node->setSectionModelProperties(m_newPropertyList);
 
    if (!propsWithNoUpdates().contains(changed)) {
        doUpdate(propsBefore, m_node->sectionModelProperties(), oldExtent | m_node->projectionPlane()->tightUserVisibleBounds());
    }
}

References doUpdate(), m_newPropertyList, KisNodeCommand::m_node, KisNode::projectionPlane(), propsWithNoUpdates(), KisBaseNode::sectionModelProperties(), and KisBaseNode::setSectionModelProperties().

setNodePropertiesAutoUndo()

void KisNodePropertyListCommand::setNodePropertiesAutoUndo ( KisNodeSP node, KisImageSP image, PropertyList proplist )

static

HACK ALERT!

Here we start a fake legacy stroke, so that all the LoD planes would be invalidated. Ideally, we should refactor this method and avoid resetting LoD planes when node visibility changes, Instead there should be two commands executes: LoD agnostic one (which sets the properties themselves), and two LoD-specific update commands: one for lodN and another one for lod0.

Definition at line 226 of file kis_node_property_list_command.cpp.

{
    const QSet<QString> properties = changedProperties(node->sectionModelProperties(), proplist);
 
    const bool undo = !properties.isEmpty() &&
            properties != QSet<QString>{KisLayerPropertiesIcons::colorizeNeedsUpdate.id()} &&
            properties != QSet<QString>{KisLayerPropertiesIcons::openFileLayerFile.id()};
 
    QScopedPointer<KUndo2Command> cmd(new KisNodePropertyListCommand(node, proplist));
 
    if (undo) {
        image->undoAdapter()->addCommand(cmd.take());
    }
    else {
        struct SimpleLodResettingStroke : public KisSimpleStrokeStrategy {
            SimpleLodResettingStroke(KUndo2Command *cmd)
                : KisSimpleStrokeStrategy(QLatin1String("SimpleLodResettingStroke")),
                  m_cmd(cmd)
            {
                setClearsRedoOnStart(false);
                this->enableJob(JOB_INIT, true);
            }
 
            void initStrokeCallback() override {
                m_cmd->redo();
                // NOTE: we don't Q_EMIT imageModified signal here because this
                // branch is only taken for the stasis changes, that do not
                // change actual image representation.
            }
 
        private:
            QScopedPointer<KUndo2Command> m_cmd;
        };
 
        KisStrokeId strokeId = image->startStroke(new SimpleLodResettingStroke(cmd.take()));
        image->endStroke(strokeId);
    }
 
}

References KisUndoAdapter::addCommand(), KisLayerPropertiesIcons::colorizeNeedsUpdate, KisImage::endStroke(), KoID::id(), KisNodePropertyListCommand(), KisLayerPropertiesIcons::openFileLayerFile, KisBaseNode::sectionModelProperties(), KisImage::startStroke(), undo(), and KisImage::undoAdapter().

undo()

void KisNodePropertyListCommand::undo ( )

overridevirtual

Reverts a change to the document. After undo() is called, the state of the document should be the same as before redo() was called. This function must be implemented in the derived class. Calling KUndo2QStack::push(), KUndo2QStack::undo() or KUndo2QStack::redo() from this function leads to undefined behavior.

The default implementation calls undo() on all child commands in reverse order.

See also

redo()

Reimplemented from KUndo2Command.

Definition at line 84 of file kis_node_property_list_command.cpp.

{
    const KisBaseNode::PropertyList propsBefore = m_node->sectionModelProperties();
    const QSet<QString> changed = changedProperties(propsBefore, m_oldPropertyList);
    if (changed.isEmpty()) return;
 
    const QRect oldExtent = m_node->projectionPlane()->tightUserVisibleBounds();
    m_node->setSectionModelProperties(m_oldPropertyList);
 
    if (!propsWithNoUpdates().contains(changed)) {
        doUpdate(propsBefore, m_node->sectionModelProperties(), oldExtent | m_node->projectionPlane()->tightUserVisibleBounds());
    }
}

References doUpdate(), KisNodeCommand::m_node, m_oldPropertyList, KisNode::projectionPlane(), propsWithNoUpdates(), KisBaseNode::sectionModelProperties(), and KisBaseNode::setSectionModelProperties().

Member Data Documentation

m_newPropertyList

KisBaseNode::PropertyList KisNodePropertyListCommand::m_newPropertyList

private

Definition at line 43 of file kis_node_property_list_command.h.

m_oldPropertyList

KisBaseNode::PropertyList KisNodePropertyListCommand::m_oldPropertyList

private

Definition at line 44 of file kis_node_property_list_command.h.

---

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

• libs/image/commands/kis_node_property_list_command.h
• libs/image/commands/kis_node_property_list_command.cpp