#include <kis_constrained_rect.h>

Inheritance diagram for KisConstrainedRect:

Public Types
enum	HandleType { None = 0 , UpperLeft , UpperRight , LowerLeft , LowerRight , Upper , Lower , Left , Right , Inside , Creation }

Signals
void	sigLockValuesChanged ()

void	sigValuesChanged ()

Public Member Functions
bool	canGrow () const

bool	centered () const

QPointF	handleSnapPoint (HandleType handle, const QPointF &cursorPos)

bool	heightLocked () const

	KisConstrainedRect ()

void	moveHandle (HandleType handle, const QPoint &offset, const QRect &oldRect)

void	normalize ()

qreal	ratio () const

bool	ratioLocked () const

QRect	rect () const

void	setCanGrow (bool value)

void	setCentered (bool value)

void	setCropRect (const QRect &cropRect)

void	setHeight (int value)

void	setHeightLocked (bool value)

void	setOffset (const QPoint &offset)

void	setRatio (qreal value)

void	setRatioLocked (bool value)

void	setRectInitial (const QRect &rect)

void	setWidth (int value)

void	setWidthLocked (bool value)

bool	widthLocked () const

	~KisConstrainedRect () override

Private Member Functions
void	assignNewSize (const QSize &newSize)

int	heightFromWidthUnsignedRatio (int width, qreal ratio, int oldHeight) const

void	storeRatioSafe (const QSize &newSize)

int	widthFromHeightUnsignedRatio (int height, qreal ratio, int oldWidth) const

Private Attributes
bool	m_canGrow {true}

bool	m_centered {false}

QRect	m_cropRect

bool	m_heightLocked {false}

qreal	m_ratio {1.0}

bool	m_ratioLocked {false}

QRect	m_rect

bool	m_widthLocked {false}

Detailed Description

Definition at line 15 of file kis_constrained_rect.h.

Member Enumeration Documentation

◆ HandleType

enum KisConstrainedRect::HandleType

Enumerator
None
UpperLeft
UpperRight
LowerLeft
LowerRight
Upper
Lower
Left
Right
Inside
Creation

Definition at line 20 of file kis_constrained_rect.h.

                    {
        None = 0,
        UpperLeft,
        UpperRight,
        LowerLeft,
        LowerRight,
        Upper,
        Lower,
        Left,
        Right,
        Inside,
        Creation
    };

Constructor & Destructor Documentation

◆ KisConstrainedRect()

KisConstrainedRect::KisConstrainedRect ( )

Definition at line 14 of file kis_constrained_rect.cpp.

15{

16}

◆ ~KisConstrainedRect()

KisConstrainedRect::~KisConstrainedRect ( )

override

Definition at line 18 of file kis_constrained_rect.cpp.

19{

20}

Member Function Documentation

◆ assignNewSize()

void KisConstrainedRect::assignNewSize ( const QSize & newSize )

private

Definition at line 361 of file kis_constrained_rect.cpp.

{
    if (!m_centered) {
        m_rect.setSize(newSize);
    } else {
        QSize sizeDiff = newSize - m_rect.size();
        m_rect.translate(-qRound(sizeDiff.width() / 2.0), -qRound(sizeDiff.height() / 2.0));
        m_rect.setSize(newSize);
    }
 
    if (!m_canGrow) {
        m_rect &= m_cropRect;
    }
 
    Q_EMIT sigValuesChanged();
}

References m_canGrow, m_centered, m_cropRect, m_rect, and sigValuesChanged().

◆ canGrow()

bool KisConstrainedRect::canGrow ( ) const

Definition at line 43 of file kis_constrained_rect.cpp.

                                       {
    return m_canGrow;
}

References m_canGrow.

◆ centered()

bool KisConstrainedRect::centered ( ) const

Definition at line 36 of file kis_constrained_rect.cpp.

                                        {
    return m_centered;
}

References m_centered.

◆ handleSnapPoint()

QPointF KisConstrainedRect::handleSnapPoint	(	HandleType	handle,
		const QPointF &	cursorPos )

Definition at line 231 of file kis_constrained_rect.cpp.

{
    QPointF snapPoint = cursorPos;
 
    switch (handle) {
    case UpperLeft:
        snapPoint = m_rect.topLeft();
        break;
    case UpperRight:
        snapPoint = m_rect.topRight() + QPointF(1, 0);
        break;
    case Creation:
        break;
    case LowerRight:
        snapPoint = m_rect.bottomRight() + QPointF(1, 1);
        break;
    case LowerLeft:
        snapPoint = m_rect.bottomLeft() + QPointF(0, 1);
        break;
    case Upper:
        snapPoint.ry() = m_rect.y();
        break;
    case Right:
        snapPoint.rx() = m_rect.right() + 1;
        break;
    case Lower:
        snapPoint.ry() = m_rect.bottom() + 1;
        break;
    case Left:
        snapPoint.rx() = m_rect.x();
        break;
    case Inside:
        break;
    case None: // should never happen
        break;
    }
 
    return snapPoint;
}

References Creation, Inside, Left, Lower, LowerLeft, LowerRight, m_rect, None, Right, Upper, UpperLeft, and UpperRight.

◆ heightFromWidthUnsignedRatio()

int KisConstrainedRect::heightFromWidthUnsignedRatio	(	int	width,
		qreal	ratio,
		int	oldHeight ) const

private

Definition at line 389 of file kis_constrained_rect.cpp.

{
    int newHeight = qRound(width / ratio);
    return KisAlgebra2D::copysign(newHeight, oldHeight);
}

References KisAlgebra2D::copysign(), and ratio().

◆ heightLocked()

bool KisConstrainedRect::heightLocked ( ) const

Definition at line 398 of file kis_constrained_rect.cpp.

                                            {
    return m_heightLocked;
}

References m_heightLocked.

◆ moveHandle()

void KisConstrainedRect::moveHandle	(	HandleType	handle,
		const QPoint &	offset,
		const QRect &	oldRect )

Definition at line 58 of file kis_constrained_rect.cpp.

{
    const QSize oldSize = oldRect.size();
    QSize newSize = oldSize;
    QPoint newOffset = oldRect.topLeft();
 
    int xSizeCoeff = 1;
    int ySizeCoeff = 1;
 
    qreal xOffsetFromSizeChange = 1.0;
    qreal yOffsetFromSizeChange = 1.0;
 
    int baseSizeCoeff = 1;
 
    bool useMoveOnly = false;
 
    switch (handle) {
    case UpperLeft:
        xSizeCoeff = -1;
        ySizeCoeff = -1;
        xOffsetFromSizeChange = -1.0;
        yOffsetFromSizeChange = -1.0;
        break;
    case UpperRight:
        xSizeCoeff =  1;
        ySizeCoeff = -1;
        xOffsetFromSizeChange =  0.0;
        yOffsetFromSizeChange = -1.0;
        break;
    case Creation:
        baseSizeCoeff = 0;
        Q_FALLTHROUGH();
    case LowerRight:
        xSizeCoeff =  1;
        ySizeCoeff =  1;
        xOffsetFromSizeChange =  0.0;
        yOffsetFromSizeChange =  0.0;
        break;
    case LowerLeft:
        xSizeCoeff = -1;
        ySizeCoeff =  1;
        xOffsetFromSizeChange = -1.0;
        yOffsetFromSizeChange =  0.0;
        break;
    case Upper:
        xSizeCoeff =  0;
        ySizeCoeff = -1;
        xOffsetFromSizeChange = -0.5;
        yOffsetFromSizeChange = -1.0;
        break;
    case Right:
        xSizeCoeff =  1;
        ySizeCoeff =  0;
        xOffsetFromSizeChange =  0.0;
        yOffsetFromSizeChange = -0.5;
        break;
    case Lower:
        xSizeCoeff =  0;
        ySizeCoeff =  1;
        xOffsetFromSizeChange = -0.5;
        yOffsetFromSizeChange =  0.0;
        break;
    case Left:
        xSizeCoeff = -1;
        ySizeCoeff =  0;
        xOffsetFromSizeChange = -1.0;
        yOffsetFromSizeChange = -0.5;
        break;
    case Inside:
        useMoveOnly = true;
        break;
    case None: // should never happen
        break;
    }
 
    if (!useMoveOnly) {
        const int centeringSizeCoeff = m_centered ? 2 : 1;
        if (m_centered) {
            xOffsetFromSizeChange = -0.5;
            yOffsetFromSizeChange = -0.5;
        }
 
 
        QSize sizeDiff(offset.x() * xSizeCoeff * centeringSizeCoeff,
                       offset.y() * ySizeCoeff * centeringSizeCoeff);
 
        QSize tempSize = baseSizeCoeff * oldSize + sizeDiff;
        bool widthPreferable = qAbs(tempSize.width()) > qAbs(tempSize.height() * m_ratio);
 
        if (ratioLocked()) {
            if ((widthPreferable && xSizeCoeff != 0) || ySizeCoeff == 0) {
                newSize.setWidth(tempSize.width());
                newSize.setHeight(heightFromWidthUnsignedRatio(newSize.width(), m_ratio, tempSize.height()));
            } else if ((!widthPreferable && ySizeCoeff != 0) || xSizeCoeff == 0) {
                newSize.setHeight(tempSize.height());
                newSize.setWidth(widthFromHeightUnsignedRatio(newSize.height(), m_ratio, tempSize.width()));
            }
 
            // see https://bugs.kde.org/show_bug.cgi?id=432036
            if (!m_canGrow && qAbs(newSize.width()) > m_cropRect.width()) {
                newSize.setWidth(m_cropRect.width());
                newSize.setHeight(heightFromWidthUnsignedRatio(newSize.width(), m_ratio, newSize.height()));
            }
            if (!m_canGrow && qAbs(newSize.height()) > m_cropRect.height()) {
                newSize.setHeight(m_cropRect.height());
                newSize.setWidth(widthFromHeightUnsignedRatio(newSize.height(), m_ratio, newSize.width()));
            }
        } else if (widthLocked() && heightLocked()) {
            newSize.setWidth(KisAlgebra2D::copysign(newSize.width(), tempSize.width()));
            newSize.setHeight(KisAlgebra2D::copysign(newSize.height(), tempSize.height()));
        } else if (widthLocked()) {
            newSize.setWidth(KisAlgebra2D::copysign(newSize.width(), tempSize.width()));
            newSize.setHeight(tempSize.height());
            storeRatioSafe(newSize);
        } else if (heightLocked()) {
            newSize.setHeight(KisAlgebra2D::copysign(newSize.height(), tempSize.height()));
            newSize.setWidth(tempSize.width());
            storeRatioSafe(newSize);
        } else {
            newSize = baseSizeCoeff * oldSize + sizeDiff;
            storeRatioSafe(newSize);
        }
 
        QSize realSizeDiff = newSize - baseSizeCoeff * oldSize;
        QPoint offsetDiff(realSizeDiff.width() * xOffsetFromSizeChange,
                          realSizeDiff.height() * yOffsetFromSizeChange);
 
        newOffset = oldRect.topLeft() + offsetDiff;
    } else {
        newOffset = oldRect.topLeft() + offset;
    }
 
    QPoint prevOffset = newOffset;
 
    if (!m_canGrow) {
        if (newOffset.x() + newSize.width() > m_cropRect.width()) {
            newOffset.setX(m_cropRect.width() - newSize.width());
        }
 
        if (newOffset.y() + newSize.height() > m_cropRect.height()) {
            newOffset.setY(m_cropRect.height() - newSize.height());
        }
        if (newOffset.x() < m_cropRect.x()) {
            newOffset.setX(m_cropRect.x());
        }
        if (newOffset.y() < m_cropRect.y()) {
            newOffset.setY(m_cropRect.y());
        }
    }
 
    if (!m_ratioLocked && !useMoveOnly) {
        newOffset = prevOffset;
    }
 
    m_rect = QRect(newOffset, newSize);
 
    if (!m_canGrow) {
        m_rect &= m_cropRect;
 
        if (ratioLocked() && m_rect.height()) {
            qreal newRatio = m_rect.width() / (qreal)(m_rect.height());
 
            if (newRatio > m_ratio) {
                m_rect.setWidth(widthFromHeightUnsignedRatio(m_rect.height(), m_ratio, m_rect.width()));
            } else {
                m_rect.setHeight(heightFromWidthUnsignedRatio(m_rect.width(), m_ratio, m_rect.height()));
            }
        }
    }
 
    Q_EMIT sigValuesChanged();
}

References KisAlgebra2D::copysign(), Creation, heightFromWidthUnsignedRatio(), heightLocked(), Inside, Left, Lower, LowerLeft, LowerRight, m_canGrow, m_centered, m_cropRect, m_ratio, m_ratioLocked, m_rect, None, ratioLocked(), Right, sigValuesChanged(), storeRatioSafe(), Upper, UpperLeft, UpperRight, widthFromHeightUnsignedRatio(), and widthLocked().

◆ normalize()

void KisConstrainedRect::normalize ( )

Definition at line 271 of file kis_constrained_rect.cpp.

{
    setRectInitial(m_rect.normalized());
}

References m_rect, and setRectInitial().

◆ ratio()

qreal KisConstrainedRect::ratio ( ) const

Definition at line 54 of file kis_constrained_rect.cpp.

                                      {
    return qAbs(m_ratio);
}

References m_ratio.

◆ ratioLocked()

bool KisConstrainedRect::ratioLocked ( ) const

Definition at line 401 of file kis_constrained_rect.cpp.

                                           {
    return m_ratioLocked;
}

References m_ratioLocked.

◆ rect()

QRect KisConstrainedRect::rect ( ) const

Definition at line 50 of file kis_constrained_rect.cpp.

                                     {
    return m_rect.normalized();
}

References m_rect.

◆ setCanGrow()

void KisConstrainedRect::setCanGrow ( bool value )

Definition at line 46 of file kis_constrained_rect.cpp.

                                              {
    m_canGrow = value;
}

References m_canGrow, and value().

◆ setCentered()

void KisConstrainedRect::setCentered ( bool value )

Definition at line 39 of file kis_constrained_rect.cpp.

                                               {
    m_centered = value;
}

References m_centered, and value().

◆ setCropRect()

void KisConstrainedRect::setCropRect ( const QRect & cropRect )

Definition at line 31 of file kis_constrained_rect.cpp.

{
    m_cropRect = cropRect;
}

References m_cropRect.

◆ setHeight()

void KisConstrainedRect::setHeight ( int value )

Definition at line 343 of file kis_constrained_rect.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(value >= 0);
 
    const QSize oldSize = m_rect.size();
    QSize newSize = oldSize;
 
    if (ratioLocked()) {
        newSize.setHeight(value);
        newSize.setWidth(newSize.height() * m_ratio);
    } else {
        newSize.setHeight(value);
        storeRatioSafe(newSize);
    }
 
    assignNewSize(newSize);
}

References assignNewSize(), KIS_ASSERT_RECOVER_RETURN, m_ratio, m_rect, ratioLocked(), storeRatioSafe(), and value().

◆ setHeightLocked()

void KisConstrainedRect::setHeightLocked ( bool value )

Definition at line 412 of file kis_constrained_rect.cpp.

                                                   {
    m_heightLocked = value;
    m_ratioLocked &= !(m_widthLocked || m_heightLocked);
 
    Q_EMIT sigLockValuesChanged();
}

References m_heightLocked, m_ratioLocked, m_widthLocked, sigLockValuesChanged(), and value().

◆ setOffset()

void KisConstrainedRect::setOffset ( const QPoint & offset )

Definition at line 276 of file kis_constrained_rect.cpp.

{
    QRect newRect = m_rect;
    newRect.moveTo(offset);
 
    if (!m_canGrow) {
        newRect &= m_cropRect;
    }
 
    if (!newRect.isEmpty()) {
        m_rect = newRect;
    }
 
    Q_EMIT sigValuesChanged();
}

References m_canGrow, m_cropRect, m_rect, and sigValuesChanged().

◆ setRatio()

void KisConstrainedRect::setRatio ( qreal value )

Definition at line 292 of file kis_constrained_rect.cpp.

                                             {
    KIS_ASSERT_RECOVER_RETURN(value >= 0);
 
    const qreal eps = 1e-7;
    const qreal invEps = 1.0 / eps;
 
    if (value < eps || value > invEps) {
        Q_EMIT sigValuesChanged();
        return;
    }
 
    const QSize oldSize = m_rect.size();
    QSize newSize = oldSize;
 
    if (widthLocked() && heightLocked()) {
        setHeightLocked(false);
    }
 
    m_ratio = value;
 
    if (!widthLocked() && !heightLocked()) {
        int area = oldSize.width() * oldSize.height();
        newSize.setWidth(qRound(std::sqrt(area * m_ratio)));
        newSize.setHeight(qRound(newSize.width() / m_ratio));
    } else if (widthLocked()) {
        newSize.setHeight(newSize.width() / m_ratio);
    } else if (heightLocked()) {
        newSize.setWidth(newSize.height() * m_ratio);
    }
 
    assignNewSize(newSize);
}

References assignNewSize(), eps, heightLocked(), KIS_ASSERT_RECOVER_RETURN, m_ratio, m_rect, setHeightLocked(), sigValuesChanged(), value(), and widthLocked().

◆ setRatioLocked()

void KisConstrainedRect::setRatioLocked ( bool value )

Definition at line 419 of file kis_constrained_rect.cpp.

                                                  {
    m_ratioLocked = value;
 
    m_widthLocked &= !m_ratioLocked;
    m_heightLocked &= !m_ratioLocked;
 
    Q_EMIT sigLockValuesChanged();
}

References m_heightLocked, m_ratioLocked, m_widthLocked, sigLockValuesChanged(), and value().

◆ setRectInitial()

void KisConstrainedRect::setRectInitial ( const QRect & rect )

Definition at line 22 of file kis_constrained_rect.cpp.

{
    m_rect = rect;
    if (!ratioLocked()) {
        storeRatioSafe(m_rect.size());
    }
    Q_EMIT sigValuesChanged();
}

References m_rect, ratioLocked(), rect(), sigValuesChanged(), and storeRatioSafe().

◆ setWidth()

void KisConstrainedRect::setWidth ( int value )

Definition at line 325 of file kis_constrained_rect.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(value >= 0);
 
    const QSize oldSize = m_rect.size();
    QSize newSize = oldSize;
 
    if (ratioLocked()) {
        newSize.setWidth(value);
        newSize.setHeight(newSize.width() / m_ratio);
    } else {
        newSize.setWidth(value);
        storeRatioSafe(newSize);
    }
 
    assignNewSize(newSize);
}

References assignNewSize(), KIS_ASSERT_RECOVER_RETURN, m_ratio, m_rect, ratioLocked(), storeRatioSafe(), and value().

◆ setWidthLocked()

void KisConstrainedRect::setWidthLocked ( bool value )

Definition at line 405 of file kis_constrained_rect.cpp.

                                                  {
    m_widthLocked = value;
    m_ratioLocked &= !(m_widthLocked || m_heightLocked);
 
    Q_EMIT sigLockValuesChanged();
}

References m_heightLocked, m_ratioLocked, m_widthLocked, sigLockValuesChanged(), and value().

◆ sigLockValuesChanged

void KisConstrainedRect::sigLockValuesChanged ( )

signal

◆ sigValuesChanged

void KisConstrainedRect::sigValuesChanged ( )

signal

◆ storeRatioSafe()

void KisConstrainedRect::storeRatioSafe ( const QSize & newSize )

private

Definition at line 378 of file kis_constrained_rect.cpp.

{
    m_ratio = qAbs(qreal(newSize.width()) / newSize.height());
}

References m_ratio.

◆ widthFromHeightUnsignedRatio()

int KisConstrainedRect::widthFromHeightUnsignedRatio	(	int	height,
		qreal	ratio,
		int	oldWidth ) const

private

Definition at line 383 of file kis_constrained_rect.cpp.

{
    int newWidth = qRound(height * ratio);
    return KisAlgebra2D::copysign(newWidth, oldWidth);
}

References KisAlgebra2D::copysign(), and ratio().

◆ widthLocked()

bool KisConstrainedRect::widthLocked ( ) const

Definition at line 395 of file kis_constrained_rect.cpp.

                                           {
    return m_widthLocked;
}

References m_widthLocked.

Member Data Documentation

◆ m_canGrow

bool KisConstrainedRect::m_canGrow {true}

private

Definition at line 83 of file kis_constrained_rect.h.

83{true};

◆ m_centered

bool KisConstrainedRect::m_centered {false}

private

Definition at line 82 of file kis_constrained_rect.h.

82{false};

◆ m_cropRect

QRect KisConstrainedRect::m_cropRect

private

Definition at line 91 of file kis_constrained_rect.h.

◆ m_heightLocked

bool KisConstrainedRect::m_heightLocked {false}

private

Definition at line 88 of file kis_constrained_rect.h.

88{false};

◆ m_ratio

qreal KisConstrainedRect::m_ratio {1.0}

private

Definition at line 85 of file kis_constrained_rect.h.

85{1.0};

◆ m_ratioLocked

bool KisConstrainedRect::m_ratioLocked {false}

private

Definition at line 89 of file kis_constrained_rect.h.

89{false};

◆ m_rect

QRect KisConstrainedRect::m_rect

private

Definition at line 84 of file kis_constrained_rect.h.

◆ m_widthLocked

bool KisConstrainedRect::m_widthLocked {false}

private

Definition at line 87 of file kis_constrained_rect.h.

87{false};

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

plugins/tools/tool_crop/kis_constrained_rect.h
plugins/tools/tool_crop/kis_constrained_rect.cpp

Public Types

Signals

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HandleType

Constructor & Destructor Documentation

◆ KisConstrainedRect()

◆ ~KisConstrainedRect()

Member Function Documentation

◆ assignNewSize()

◆ canGrow()

◆ centered()

◆ handleSnapPoint()

◆ heightFromWidthUnsignedRatio()

◆ heightLocked()

◆ moveHandle()

◆ normalize()

◆ ratio()

◆ ratioLocked()

◆ rect()

◆ setCanGrow()

◆ setCentered()

◆ setCropRect()

◆ setHeight()

◆ setHeightLocked()

◆ setOffset()

◆ setRatio()

◆ setRatioLocked()

◆ setRectInitial()

◆ setWidth()

◆ setWidthLocked()

◆ sigLockValuesChanged

◆ sigValuesChanged

◆ storeRatioSafe()

◆ widthFromHeightUnsignedRatio()

◆ widthLocked()

Member Data Documentation

◆ m_canGrow

◆ m_centered

◆ m_cropRect

◆ m_heightLocked

◆ m_ratio

◆ m_ratioLocked

◆ m_rect

◆ m_widthLocked