#include <KisChangeImageHdrMetadataCommand.h>

Inheritance diagram for KisChangeImageHdrMetadataCommand:

Public Member Functions
int	id () const override

	KisChangeImageHdrMetadataCommand (KisImageWSP image, std::optional< double > referenceWhite, std::optional< KisRelativeContentLightLevelInformation > clli, std::optional< KisColorVolumeInformation > cvi, 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
std::optional< KisRelativeContentLightLevelInformation >	m_clli

std::optional< KisColorVolumeInformation >	m_cvi

KisImageWSP	m_image

std::optional< KisRelativeContentLightLevelInformation >	m_oldClli

std::optional< KisColorVolumeInformation >	m_oldCvi

std::optional< double >	m_oldReferenceWhite

std::optional< double >	m_referenceWhite

Detailed Description

Definition at line 15 of file KisChangeImageHdrMetadataCommand.h.

Constructor & Destructor Documentation

◆ KisChangeImageHdrMetadataCommand()

KisChangeImageHdrMetadataCommand::KisChangeImageHdrMetadataCommand	(	KisImageWSP	image,
		std::optional< double >	referenceWhite,
		std::optional< KisRelativeContentLightLevelInformation >	clli,
		std::optional< KisColorVolumeInformation >	cvi,
		KUndo2Command *	parent = nullptr )

Definition at line 10 of file KisChangeImageHdrMetadataCommand.cpp.

    : KUndo2Command(kundo2_i18n("Set HDR Metadata"), parent)
    , m_image(image)
    , m_referenceWhite(referenceWhite)
    , m_clli(clli)
    , m_cvi(cvi)
{
    KisImageSP img = m_image.toStrongRef();
    if (img) {
        m_oldReferenceWhite = img->hdrReferenceWhiteLightLevel();
        m_oldClli = img->relativeContentLightLevelInformation();
        m_oldCvi = img->colorVolumeInformation();
    }
}

References KisImage::colorVolumeInformation(), KisImage::hdrReferenceWhiteLightLevel(), m_image, m_oldClli, m_oldCvi, m_oldReferenceWhite, KisImage::relativeContentLightLevelInformation(), and KisWeakSharedPtr< T >::toStrongRef().

Member Function Documentation

◆ id()

int KisChangeImageHdrMetadataCommand::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 50 of file KisChangeImageHdrMetadataCommand.cpp.

{
    return KisCommandUtils::ChangeImageHdrMetadataId;
}

References KisCommandUtils::ChangeImageHdrMetadataId.

◆ mergeWith()

bool KisChangeImageHdrMetadataCommand::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 55 of file KisChangeImageHdrMetadataCommand.cpp.

{
    const KisChangeImageHdrMetadataCommand *other = dynamic_cast<const KisChangeImageHdrMetadataCommand *>(otherCommand);
    if (!other || other->m_image != m_image) return false;
 
    m_referenceWhite = other->m_referenceWhite;
    m_clli = other->m_clli;
    m_cvi = other->m_cvi;
 
    return true;
}

References m_clli, m_cvi, m_image, and m_referenceWhite.

◆ redo()

void KisChangeImageHdrMetadataCommand::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 30 of file KisChangeImageHdrMetadataCommand.cpp.

{
    KisImageSP img = m_image.toStrongRef();
    if (!img) return;
 
    img->setHdrReferenceWhiteLightLevel(m_referenceWhite);
    img->setRelativeContentLightLevelInformation(m_clli);
    img->setColorVolumeInformation(m_cvi);
}

References m_clli, m_cvi, m_image, m_referenceWhite, KisImage::setColorVolumeInformation(), KisImage::setHdrReferenceWhiteLightLevel(), KisImage::setRelativeContentLightLevelInformation(), and KisWeakSharedPtr< T >::toStrongRef().

◆ undo()

void KisChangeImageHdrMetadataCommand::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 40 of file KisChangeImageHdrMetadataCommand.cpp.

{
    KisImageSP img = m_image.toStrongRef();
    if (!img) return;
 
    img->setHdrReferenceWhiteLightLevel(m_oldReferenceWhite);
    img->setRelativeContentLightLevelInformation(m_oldClli);
    img->setColorVolumeInformation(m_oldCvi);
}