#include <KisSimpleModifyTransformMaskCommand.h>

Inheritance diagram for KisSimpleModifyTransformMaskCommand:

Public Member Functions
int	id () const override

	KisSimpleModifyTransformMaskCommand (KisTransformMaskSP mask, KisTransformMaskParamsInterfaceSP newParams, QWeakPointer< boost::none_t > updatesBlockerCookie=QWeakPointer< boost::none_t >(), KUndo2Command *parent=nullptr)

bool	mergeWith (const KUndo2Command *other) override

void	redo () override

void	undo () override

Public Member Functions inherited from KUndo2Command
QString	actionText () const

virtual bool	canAnnihilateWith (const KUndo2Command *other) 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 ()

Private Attributes
bool	m_isInitialized {false}

KisTransformMaskSP	m_mask

KisTransformMaskParamsInterfaceSP	m_newParams

KisTransformMaskParamsInterfaceSP	m_oldParams

std::vector< std::unique_ptr< KUndo2Command > >	m_undoCommands

QWeakPointer< boost::none_t >	m_updatesBlockerCookie

Detailed Description

Definition at line 17 of file KisSimpleModifyTransformMaskCommand.h.

Constructor & Destructor Documentation

◆ KisSimpleModifyTransformMaskCommand()

KisSimpleModifyTransformMaskCommand::KisSimpleModifyTransformMaskCommand	(	KisTransformMaskSP	mask,
		KisTransformMaskParamsInterfaceSP	newParams,
		QWeakPointer< boost::none_t >	updatesBlockerCookie = QWeakPointer<boost::none_t>(),
		KUndo2Command *	parent = nullptr )

Definition at line 13 of file KisSimpleModifyTransformMaskCommand.cpp.

    : KUndo2Command(parent),
      m_mask(mask),
      m_oldParams(m_mask->transformParams()),
      m_newParams(newParams),
      m_updatesBlockerCookie(updatesBlockerCookie)
{
}

Member Function Documentation

◆ id()

int KisSimpleModifyTransformMaskCommand::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 25 of file KisSimpleModifyTransformMaskCommand.cpp.

{
    return KisCommandUtils::ChangeTransformMaskCommand;
}

References KisCommandUtils::ChangeTransformMaskCommand.

◆ mergeWith()

bool KisSimpleModifyTransformMaskCommand::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 30 of file KisSimpleModifyTransformMaskCommand.cpp.

{
    const KisSimpleModifyTransformMaskCommand *otherCommandConst =
            dynamic_cast<const KisSimpleModifyTransformMaskCommand*>(other);
 
    bool retval = false;
 
    if (otherCommandConst &&
            otherCommandConst->m_mask == m_mask &&
            otherCommandConst->m_oldParams == m_newParams) {
 
        KisSimpleModifyTransformMaskCommand *otherCommand =
                const_cast<KisSimpleModifyTransformMaskCommand*>(otherCommandConst);
 
        m_newParams = otherCommand->m_newParams;
        std::move(otherCommand->m_undoCommands.begin(), otherCommand->m_undoCommands.end(),
                  std::back_inserter(m_undoCommands));
 
        retval = true;
    }
 
    return retval;
}

References m_mask, m_newParams, m_oldParams, and m_undoCommands.

◆ redo()

void KisSimpleModifyTransformMaskCommand::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 54 of file KisSimpleModifyTransformMaskCommand.cpp.

{
    if (!m_isInitialized) {
        std::unique_ptr<KUndo2Command> parent(new KUndo2Command);
        m_mask->setTransformParamsWithUndo(m_newParams, parent.get());
        m_undoCommands.emplace_back(parent.release());
        m_isInitialized = true;
    }
 
    KUndo2Command::redo();
    std::for_each(m_undoCommands.begin(), m_undoCommands.end(), std::mem_fn(&KUndo2Command::redo));
 
    if (!m_updatesBlockerCookie) {
        m_mask->threadSafeForceStaticImageUpdate();
    }
}

References m_isInitialized, m_mask, m_newParams, m_undoCommands, m_updatesBlockerCookie, KUndo2Command::redo(), KisTransformMask::setTransformParamsWithUndo(), and KisTransformMask::threadSafeForceStaticImageUpdate().

◆ undo()

void KisSimpleModifyTransformMaskCommand::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 71 of file KisSimpleModifyTransformMaskCommand.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(m_isInitialized);
 
    std::for_each(m_undoCommands.begin(), m_undoCommands.end(), std::mem_fn(&KUndo2Command::undo));
    KUndo2Command::undo();
 
    if (!m_updatesBlockerCookie) {
        m_mask->threadSafeForceStaticImageUpdate();
    }
}