The KisMirrorAxisConfig class stores configuration for the KisMirrorAxis canvas decoration. Contents are saved to/loaded from KRA documents. More...

#include <KisMirrorAxisConfig.h>

Inheritance diagram for KisMirrorAxisConfig:

Public Member Functions
QPointF	axisPosition () const

float	handleSize () const

bool	hideHorizontalDecoration () const

bool	hideVerticalDecoration () const

float	horizontalHandlePosition () const

bool	isDefault () const
	Check whether the config object was changed, or is the class default.

	KisMirrorAxisConfig ()

	KisMirrorAxisConfig (const KisMirrorAxisConfig &rhs)

bool	loadFromXml (const QDomElement &parent)
	loadFromXml() function for KisKraLoader

bool	lockHorizontal () const

bool	lockVertical () const

bool	mirrorHorizontal () const

bool	mirrorVertical () const

KisMirrorAxisConfig &	operator= (const KisMirrorAxisConfig &rhs)

bool	operator== (const KisMirrorAxisConfig &rhs) const

bool	operator== (const Private &rhs)

	Private ()

QDomElement	saveToXml (QDomDocument &doc, const QString &tag) const
	saveToXml() function for KisKraSaver

void	setAxisPosition (QPointF position)

void	setHandleSize (float size)

void	setHideHorizontalDecoration (bool state)

void	setHideVerticalDecoration (bool state)

void	setHorizontalHandlePosition (float position)

void	setLockHorizontal (bool state)

void	setLockVertical (bool state)

void	setMirrorHorizontal (bool state)

void	setMirrorVertical (bool state)

void	setVerticalHandlePosition (float position)

float	verticalHandlePosition () const

	~KisMirrorAxisConfig ()

Public Attributes
QPointF	axisPosition

float	handleSize

bool	hideHorizontalDecoration

bool	hideVerticalDecoration

float	horizontalHandlePosition

bool	lockHorizontal

bool	lockVertical

bool	mirrorHorizontal

bool	mirrorVertical

float	verticalHandlePosition

Private Attributes
const QScopedPointer< Private >	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

The KisMirrorAxisConfig class stores configuration for the KisMirrorAxis canvas decoration. Contents are saved to/loaded from KRA documents.

Definition at line 13 of file KisMirrorAxisConfig.cpp.

Constructor & Destructor Documentation

◆ KisMirrorAxisConfig() [1/2]

KisMirrorAxisConfig::KisMirrorAxisConfig ( )

Definition at line 57 of file KisMirrorAxisConfig.cpp.

    : QObject()
    , d(new Private())
{
 
}

◆ ~KisMirrorAxisConfig()

KisMirrorAxisConfig::~KisMirrorAxisConfig ( )

Definition at line 64 of file KisMirrorAxisConfig.cpp.

{
 
}

◆ KisMirrorAxisConfig() [2/2]

KisMirrorAxisConfig::KisMirrorAxisConfig ( const KisMirrorAxisConfig & rhs )

Definition at line 69 of file KisMirrorAxisConfig.cpp.

    : QObject()
    , d(new Private(*rhs.d))
{
 
}

Member Function Documentation

◆ axisPosition()

QPointF KisMirrorAxisConfig::axisPosition ( ) const

◆ handleSize()

float KisMirrorAxisConfig::handleSize ( ) const

◆ hideHorizontalDecoration()

bool KisMirrorAxisConfig::hideHorizontalDecoration ( ) const

◆ hideVerticalDecoration()

bool KisMirrorAxisConfig::hideVerticalDecoration ( ) const

◆ horizontalHandlePosition()

float KisMirrorAxisConfig::horizontalHandlePosition ( ) const

◆ isDefault()

bool KisMirrorAxisConfig::isDefault ( ) const

Check whether the config object was changed, or is the class default.

Returns: true, if the object is default; false, if the config was changed

Definition at line 235 of file KisMirrorAxisConfig.cpp.

{
    KisMirrorAxisConfig defaultConfig;
    return *this == defaultConfig;
}

◆ loadFromXml()

bool KisMirrorAxisConfig::loadFromXml ( const QDomElement & parent )

loadFromXml() function for KisKraLoader

Parameters

parent element

Returns

Definition at line 214 of file KisMirrorAxisConfig.cpp.

{
    bool result = true;
 
    result &= KisDomUtils::loadValue(parent, "mirrorHorizontal", &d->mirrorHorizontal);
    result &= KisDomUtils::loadValue(parent, "mirrorVertical", &d->mirrorVertical);
    result &= KisDomUtils::loadValue(parent, "lockHorizontal", &d->lockHorizontal);
    result &= KisDomUtils::loadValue(parent, "lockVertical", &d->lockVertical);
 
    result &= KisDomUtils::loadValue(parent, "hideHorizontalDecoration", &d->hideHorizontalDecoration);
    result &= KisDomUtils::loadValue(parent, "hideVerticalDecoration", &d->hideVerticalDecoration);
 
    result &= KisDomUtils::loadValue(parent, "handleSize", &d->handleSize);
 
    result &= KisDomUtils::loadValue(parent, "horizontalHandlePosition", &d->horizontalHandlePosition);
    result &= KisDomUtils::loadValue(parent, "verticalHandlePosition", &d->verticalHandlePosition);
    result &= KisDomUtils::loadValue(parent, "axisPosition", &d->axisPosition);
 
    return result;
}

References d, and KisDomUtils::loadValue().

◆ lockHorizontal()

bool KisMirrorAxisConfig::lockHorizontal ( ) const

◆ lockVertical()

bool KisMirrorAxisConfig::lockVertical ( ) const

◆ mirrorHorizontal()

bool KisMirrorAxisConfig::mirrorHorizontal ( ) const

◆ mirrorVertical()

bool KisMirrorAxisConfig::mirrorVertical ( ) const

◆ operator=()

KisMirrorAxisConfig & KisMirrorAxisConfig::operator= ( const KisMirrorAxisConfig & rhs )

Definition at line 76 of file KisMirrorAxisConfig.cpp.

{
    if (&rhs != this) {
        *d = *rhs.d;
    }
 
    return *this;
}

References d.

◆ operator==() [1/2]

bool KisMirrorAxisConfig::operator== ( const KisMirrorAxisConfig & rhs ) const

Definition at line 85 of file KisMirrorAxisConfig.cpp.

{
    KIS_ASSERT(d);
    KIS_ASSERT(rhs.d);
 
    return *d == *rhs.d;
}

References d, and KIS_ASSERT.

◆ operator==() [2/2]

bool KisMirrorAxisConfig::operator== ( const Private & rhs )

inline

Definition at line 29 of file KisMirrorAxisConfig.cpp.

                                        {
        return mirrorHorizontal == rhs.mirrorHorizontal &&
                mirrorVertical == rhs.mirrorVertical &&
                lockHorizontal == rhs.lockHorizontal &&
                lockVertical == rhs.lockVertical &&
                hideHorizontalDecoration == rhs.hideHorizontalDecoration &&
                hideVerticalDecoration == rhs.hideVerticalDecoration &&
                handleSize == rhs.handleSize &&
                horizontalHandlePosition == rhs.horizontalHandlePosition &&
                verticalHandlePosition == rhs.verticalHandlePosition &&
                axisPosition == rhs.axisPosition;
    }

◆ Private()

KisMirrorAxisConfig::Private ( )

inline

Definition at line 16 of file KisMirrorAxisConfig.cpp.

        : mirrorHorizontal(false)
        , mirrorVertical(false)
        , lockHorizontal(false)
        , lockVertical(false)
        , hideVerticalDecoration(false)
        , hideHorizontalDecoration(false)
        , handleSize(32.f)
        , horizontalHandlePosition(64.f)
        , verticalHandlePosition(64.f)
        , axisPosition(QPointF(0.f,0.f))
    {}

◆ saveToXml()

QDomElement KisMirrorAxisConfig::saveToXml	(	QDomDocument &	doc,
		const QString &	tag ) const

saveToXml() function for KisKraSaver

Parameters

doc
tag

Returns

Definition at line 193 of file KisMirrorAxisConfig.cpp.

{
    QDomElement mirrorAxisElement = doc.createElement(tag);
    KisDomUtils::saveValue(&mirrorAxisElement, "mirrorHorizontal", d->mirrorHorizontal);
    KisDomUtils::saveValue(&mirrorAxisElement, "mirrorVertical", d->mirrorVertical);
    KisDomUtils::saveValue(&mirrorAxisElement, "lockHorizontal", d->lockHorizontal);
    KisDomUtils::saveValue(&mirrorAxisElement, "lockVertical", d->lockVertical);
 
    KisDomUtils::saveValue(&mirrorAxisElement, "hideHorizontalDecoration", d->hideHorizontalDecoration);
    KisDomUtils::saveValue(&mirrorAxisElement, "hideVerticalDecoration", d->hideVerticalDecoration);
 
    KisDomUtils::saveValue(&mirrorAxisElement, "handleSize", d->handleSize);
 
    KisDomUtils::saveValue(&mirrorAxisElement, "horizontalHandlePosition", d->horizontalHandlePosition);
    KisDomUtils::saveValue(&mirrorAxisElement, "verticalHandlePosition", d->verticalHandlePosition);
 
    KisDomUtils::saveValue(&mirrorAxisElement, "axisPosition", d->axisPosition);
 
    return mirrorAxisElement;
}

References d, and KisDomUtils::saveValue().

◆ setAxisPosition()

void KisMirrorAxisConfig::setAxisPosition ( QPointF position )

Definition at line 188 of file KisMirrorAxisConfig.cpp.

{
    d->axisPosition = position;
}

References d.

◆ setHandleSize()

void KisMirrorAxisConfig::setHandleSize ( float size )

Definition at line 158 of file KisMirrorAxisConfig.cpp.

{
    d->handleSize = size;
}

References d.

◆ setHideHorizontalDecoration()

void KisMirrorAxisConfig::setHideHorizontalDecoration ( bool state )

Definition at line 148 of file KisMirrorAxisConfig.cpp.

{
    d->hideHorizontalDecoration = state;
}

References d.

◆ setHideVerticalDecoration()

void KisMirrorAxisConfig::setHideVerticalDecoration ( bool state )

Definition at line 138 of file KisMirrorAxisConfig.cpp.

{
    d->hideVerticalDecoration = state;
}

References d.

◆ setHorizontalHandlePosition()

void KisMirrorAxisConfig::setHorizontalHandlePosition ( float position )

Definition at line 168 of file KisMirrorAxisConfig.cpp.

{
    d->horizontalHandlePosition = position;
}

References d.

◆ setLockHorizontal()

void KisMirrorAxisConfig::setLockHorizontal ( bool state )

Definition at line 118 of file KisMirrorAxisConfig.cpp.

{
    d->lockHorizontal = state;
}

References d.

◆ setLockVertical()

void KisMirrorAxisConfig::setLockVertical ( bool state )

Definition at line 128 of file KisMirrorAxisConfig.cpp.

{
    d->lockVertical = state;
}

References d.

◆ setMirrorHorizontal()

void KisMirrorAxisConfig::setMirrorHorizontal ( bool state )

Definition at line 98 of file KisMirrorAxisConfig.cpp.

{
    d->mirrorHorizontal = state;
}

References d.

◆ setMirrorVertical()

void KisMirrorAxisConfig::setMirrorVertical ( bool state )

Definition at line 108 of file KisMirrorAxisConfig.cpp.

{
    d->mirrorVertical = state;
}

References d.

◆ setVerticalHandlePosition()

void KisMirrorAxisConfig::setVerticalHandlePosition ( float position )

Definition at line 178 of file KisMirrorAxisConfig.cpp.

{
    d->verticalHandlePosition = position;
}

References d.

◆ verticalHandlePosition()

float KisMirrorAxisConfig::verticalHandlePosition ( ) const

Member Data Documentation

◆ axisPosition

QPointF KisMirrorAxisConfig::axisPosition

Definition at line 53 of file KisMirrorAxisConfig.cpp.

◆ d

const QScopedPointer<Private> KisMirrorAxisConfig::d

private

Definition at line 89 of file KisMirrorAxisConfig.h.

◆ handleSize

float KisMirrorAxisConfig::handleSize

Definition at line 49 of file KisMirrorAxisConfig.cpp.

◆ hideHorizontalDecoration

bool KisMirrorAxisConfig::hideHorizontalDecoration

Definition at line 47 of file KisMirrorAxisConfig.cpp.

◆ hideVerticalDecoration

bool KisMirrorAxisConfig::hideVerticalDecoration

Definition at line 46 of file KisMirrorAxisConfig.cpp.

◆ horizontalHandlePosition

float KisMirrorAxisConfig::horizontalHandlePosition

Definition at line 50 of file KisMirrorAxisConfig.cpp.

◆ lockHorizontal

bool KisMirrorAxisConfig::lockHorizontal

Definition at line 44 of file KisMirrorAxisConfig.cpp.

◆ lockVertical

bool KisMirrorAxisConfig::lockVertical

Definition at line 45 of file KisMirrorAxisConfig.cpp.

◆ mirrorHorizontal

bool KisMirrorAxisConfig::mirrorHorizontal

Definition at line 42 of file KisMirrorAxisConfig.cpp.

◆ mirrorVertical

bool KisMirrorAxisConfig::mirrorVertical

Definition at line 43 of file KisMirrorAxisConfig.cpp.

◆ verticalHandlePosition

float KisMirrorAxisConfig::verticalHandlePosition

Definition at line 51 of file KisMirrorAxisConfig.cpp.

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

libs/ui/canvas/KisMirrorAxisConfig.cpp
libs/ui/canvas/KisMirrorAxisConfig.h

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisMirrorAxisConfig() [1/2]

◆ ~KisMirrorAxisConfig()

◆ KisMirrorAxisConfig() [2/2]

Member Function Documentation

◆ axisPosition()

◆ handleSize()

◆ hideHorizontalDecoration()

◆ hideVerticalDecoration()

◆ horizontalHandlePosition()

◆ isDefault()

◆ loadFromXml()

◆ lockHorizontal()

◆ lockVertical()

◆ mirrorHorizontal()

◆ mirrorVertical()

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ Private()

◆ saveToXml()

◆ setAxisPosition()

◆ setHandleSize()

◆ setHideHorizontalDecoration()

◆ setHideVerticalDecoration()

◆ setHorizontalHandlePosition()

◆ setLockHorizontal()

◆ setLockVertical()

◆ setMirrorHorizontal()

◆ setMirrorVertical()

◆ setVerticalHandlePosition()

◆ verticalHandlePosition()

Member Data Documentation

◆ axisPosition

◆ d

◆ handleSize

◆ hideHorizontalDecoration

◆ hideVerticalDecoration

◆ horizontalHandlePosition

◆ lockHorizontal

◆ lockVertical

◆ mirrorHorizontal

◆ mirrorVertical

◆ verticalHandlePosition