The undo / redo command for distributing shapes. More...

#include <KoShapeDistributeCommand.h>

Inheritance diagram for KoShapeDistributeCommand:

Public Types
enum	Distribute { HorizontalCenterDistribution , HorizontalGapsDistribution , HorizontalLeftDistribution , HorizontalRightDistribution , VerticalCenterDistribution , VerticalGapsDistribution , VerticalBottomDistribution , VerticalTopDistribution }
	The different options to distribute with this command. More...

Public Member Functions
qreal	getAvailableSpace (KoShape first, KoShape last, qreal extent, const QRectF &boundingRect)

	KoShapeDistributeCommand (const QList< KoShape * > &shapes, Distribute distribute, const QRectF &boundingRect, KUndo2Command *parent=0)

	Private ()

void	redo () override
	redo the command

void	undo () override
	revert the actions done in redo

	~KoShapeDistributeCommand () override

	~Private ()

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 int	id () const

virtual bool	isMerged () const

	KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)

	KUndo2Command (KUndo2Command *parent=0)

virtual QVector< KUndo2Command * >	mergeCommandsVector () const

virtual bool	mergeWith (const KUndo2Command *other)

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 Attributes
KoShapeMoveCommand *	command

Distribute	distribute

Private Attributes
Private *const	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 undo / redo command for distributing shapes.

Definition at line 16 of file KoShapeDistributeCommand.cpp.

Member Enumeration Documentation

◆ Distribute

enum KoShapeDistributeCommand::Distribute

The different options to distribute with this command.

Enumerator
HorizontalCenterDistribution	Horizontal centered.
HorizontalGapsDistribution	Horizontal Gaps.
HorizontalLeftDistribution	Horizontal Left.
HorizontalRightDistribution	Horizontal Right.
VerticalCenterDistribution	Vertical centered.
VerticalGapsDistribution	Vertical Gaps.
VerticalBottomDistribution	Vertical bottom.
VerticalTopDistribution	Vertical top.

Definition at line 24 of file KoShapeDistributeCommand.h.

                    {
        HorizontalCenterDistribution,   
        HorizontalGapsDistribution,     
        HorizontalLeftDistribution,     
        HorizontalRightDistribution,    
        VerticalCenterDistribution,     
        VerticalGapsDistribution,       
        VerticalBottomDistribution,     
        VerticalTopDistribution         
    };

Constructor & Destructor Documentation

◆ ~Private()

KoShapeDistributeCommand::~Private ( )

inline

Definition at line 20 of file KoShapeDistributeCommand.cpp.

               {
        delete command;
    }

◆ KoShapeDistributeCommand()

KoShapeDistributeCommand::KoShapeDistributeCommand	(	const QList< KoShape * > &	shapes,
		Distribute	distribute,
		const QRectF &	boundingRect,
		KUndo2Command *	parent = 0 )

Command to align a set of shapes in a rect

Parameters

shapes	a set of all the shapes that should be distributed
distribute	the distribution type
boundingRect	the rect the shapes will be distributed in
parent	the parent command used for macro commands

Definition at line 30 of file KoShapeDistributeCommand.cpp.

        : KUndo2Command(parent),
        d(new Private())
{
    d->distribute = distribute;
    QMap<qreal, KoShape*> sortedPos;
    QRectF bRect;
    qreal extent = 0.0;
    // sort by position and calculate sum of objects width/height
    Q_FOREACH (KoShape *shape, shapes) {
        bRect = shape->absoluteOutlineRect();
        switch (d->distribute) {
        case HorizontalCenterDistribution:
            sortedPos[bRect.center().x()] = shape;
            break;
        case HorizontalGapsDistribution:
        case HorizontalLeftDistribution:
            sortedPos[bRect.left()] = shape;
            extent += bRect.width();
            break;
        case HorizontalRightDistribution:
            sortedPos[bRect.right()] = shape;
            break;
        case VerticalCenterDistribution:
            sortedPos[bRect.center().y()] = shape;
            break;
        case VerticalGapsDistribution:
        case VerticalBottomDistribution:
            sortedPos[bRect.bottom()] = shape;
            extent += bRect.height();
            break;
        case VerticalTopDistribution:
            sortedPos[bRect.top()] = shape;
            break;
        }
    }
    KoShape* first = sortedPos.begin().value();
    KoShape* last = (--sortedPos.end()).value();
 
    // determine the available space to distribute
    qreal space = d->getAvailableSpace(first, last, extent, boundingRect);
    qreal pos = 0.0, step = space / qreal(shapes.count() - 1);
 
    QList<QPointF> previousPositions;
    QList<QPointF> newPositions;
    QPointF position;
    QPointF delta;
    QMapIterator<qreal, KoShape*> it(sortedPos);
    while (it.hasNext()) {
        it.next();
        position = it.value()->absolutePosition();
        previousPositions  << position;
 
        bRect = it.value()->absoluteOutlineRect();
        switch (d->distribute)        {
        case HorizontalCenterDistribution:
            delta = QPointF(boundingRect.x() + first->absoluteOutlineRect().width() / 2 + pos - bRect.width() / 2, bRect.y()) - bRect.topLeft();
            break;
        case HorizontalGapsDistribution:
            delta = QPointF(boundingRect.left() + pos, bRect.y()) - bRect.topLeft();
            pos += bRect.width();
            break;
        case HorizontalLeftDistribution:
            delta = QPointF(boundingRect.left() + pos, bRect.y()) - bRect.topLeft();
            break;
        case HorizontalRightDistribution:
            delta = QPointF(boundingRect.left() + first->absoluteOutlineRect().width() + pos - bRect.width(), bRect.y()) - bRect.topLeft();
            break;
        case VerticalCenterDistribution:
            delta = QPointF(bRect.x(), boundingRect.y() + first->absoluteOutlineRect().height() / 2 + pos - bRect.height() / 2) - bRect.topLeft();
            break;
        case VerticalGapsDistribution:
            delta = QPointF(bRect.x(), boundingRect.top() + pos) - bRect.topLeft();
            pos += bRect.height();
            break;
        case VerticalBottomDistribution:
            delta = QPointF(bRect.x(), boundingRect.top() + first->absoluteOutlineRect().height() + pos - bRect.height()) - bRect.topLeft();
            break;
        case VerticalTopDistribution:
            delta = QPointF(bRect.x(), boundingRect.top() + pos) - bRect.topLeft();
            break;
        };
        newPositions  << position + delta;
        pos += step;
    }
    d->command = new KoShapeMoveCommand(sortedPos.values(), previousPositions, newPositions);
 
    setText(kundo2_i18n("Distribute shapes"));
}

References KoShape::absoluteOutlineRect(), d, distribute, HorizontalCenterDistribution, HorizontalGapsDistribution, HorizontalLeftDistribution, HorizontalRightDistribution, kundo2_i18n(), KUndo2Command::setText(), value(), VerticalBottomDistribution, VerticalCenterDistribution, VerticalGapsDistribution, and VerticalTopDistribution.

◆ ~KoShapeDistributeCommand()

KoShapeDistributeCommand::~KoShapeDistributeCommand ( )

override

Definition at line 120 of file KoShapeDistributeCommand.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ getAvailableSpace()

qreal KoShapeDistributeCommand::getAvailableSpace	(	KoShape *	first,
		KoShape *	last,
		qreal	extent,
		const QRectF &	boundingRect )

◆ Private()

KoShapeDistributeCommand::Private ( )

inline

Definition at line 19 of file KoShapeDistributeCommand.cpp.

19: command(0) {}

◆ redo()

void KoShapeDistributeCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 125 of file KoShapeDistributeCommand.cpp.

{
    KUndo2Command::redo();
    d->command->redo();
}

References d, and KUndo2Command::redo().

◆ undo()

void KoShapeDistributeCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 131 of file KoShapeDistributeCommand.cpp.

{
    KUndo2Command::undo();
    d->command->undo();
}

References d, and KUndo2Command::undo().

Member Data Documentation

◆ command

KoShapeMoveCommand* KoShapeDistributeCommand::command

Definition at line 27 of file KoShapeDistributeCommand.cpp.

◆ d

Private* const KoShapeDistributeCommand::d

private

Definition at line 51 of file KoShapeDistributeCommand.h.

◆ distribute

Distribute KoShapeDistributeCommand::distribute

Definition at line 26 of file KoShapeDistributeCommand.cpp.

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

libs/flake/commands/KoShapeDistributeCommand.cpp
libs/flake/commands/KoShapeDistributeCommand.h

Public Types

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members