SelectionDecorator Class Reference

#include <SelectionDecorator.h>

Public Member Functions
void	paint (QPainter &painter, const KoViewConverter &converter)
	SelectionDecorator (KoCanvasResourceProvider *resourceManager, KoColorDisplayRendererInterface *displayInterface)
void	setCurrentMeshGradientHandles (const KoShapeMeshGradientHandles::Handle &selectedHandle, const KoShapeMeshGradientHandles::Handle &hoveredHandle)
void	setDecorationThickness (int thickness)
void	setForceShapeOutlines (bool value)
void	setHandleRadius (int radius)
void	setSelection (KoSelection *selection)
void	setShowFillGradientHandles (bool value)
void	setShowFillMeshGradientHandles (bool value)
void	setShowStrokeFillGradientHandles (bool value)
	~SelectionDecorator ()

Private Member Functions
void	paintGradientHandles (KoShape *shape, KoFlake::FillVariant fillVariant, QPainter &painter, const KoViewConverter &converter)
void	paintMeshGradientHandles (KoShape *shape, KoFlake::FillVariant fillVariant, QPainter &painter, const KoViewConverter &converter)

Private Attributes
KoShapeMeshGradientHandles::Handle	m_currentHoveredMeshHandle
int	m_decorationThickness {1}
bool	m_forceShapeOutlines {false}
int	m_handleRadius {7}
KoFlake::AnchorPosition	m_hotPosition
KoColorDisplayRendererInterface *	m_rendererInterface {nullptr}
KoShapeMeshGradientHandles::Handle	m_selectedMeshHandle
KoSelection *	m_selection {nullptr}
bool	m_showFillGradientHandles {false}
bool	m_showFillMeshGradientHandles {false}
bool	m_showStrokeFillGradientHandles {false}

Detailed Description

The SelectionDecorator is used to paint extra user-interface items on top of a selection.

Definition at line 30 of file SelectionDecorator.h.

Constructor & Destructor Documentation

SelectionDecorator()

SelectionDecorator::SelectionDecorator	(	KoCanvasResourceProvider *	resourceManager,
		KoColorDisplayRendererInterface *	displayInterface )

Constructor.

Parameters

arrows	the direction that needs highlighting. (currently unused)
rotationHandles	if true; the rotation handles will be drawn
shearHandles	if true; the shearhandles will be drawn

Definition at line 35 of file SelectionDecorator.cpp.

    : m_hotPosition(KoFlake::Center)
    , m_rendererInterface(displayInterface)
    , m_handleRadius(7)
    , m_decorationThickness(1)
    , m_showFillGradientHandles(false)
    , m_showStrokeFillGradientHandles(false)
    , m_forceShapeOutlines(false)
{
    m_hotPosition =
        KoFlake::AnchorPosition(
            resourceManager->resource(KoFlake::HotPosition).toInt());
}

References KoFlake::HotPosition, m_hotPosition, and KoCanvasResourceProvider::resource().

~SelectionDecorator()

SelectionDecorator::~SelectionDecorator ( )

inline

Definition at line 40 of file SelectionDecorator.h.

{}

Member Function Documentation

paint()

void SelectionDecorator::paint	(	QPainter &	painter,
		const KoViewConverter &	converter )

paint the decorations.

Parameters

painter	the painter to paint to.
converter	to convert between internal and view coordinates.

Definition at line 86 of file SelectionDecorator.cpp.

{
    QList<KoShape*> selectedShapes = m_selection->selectedVisibleShapes();
    if (selectedShapes.isEmpty()) return;
 
    const KisHandlePalette palette = m_rendererInterface->handlePaletteForDisplayColorSpace();
 
    const bool haveOnlyOneEditableShape =
        m_selection->selectedEditableShapes().size() == 1 &&
        selectedShapes.size() == 1;
 
    bool editable = false;
    bool forceBoundingRubberLine = false;
 
    Q_FOREACH (KoShape *shape, KoShape::linearizeSubtree(selectedShapes)) {
        if (!haveOnlyOneEditableShape || !m_showStrokeFillGradientHandles) {
            KisHandlePainterHelper helper =
                KoShape::createHandlePainterHelperView(&painter, shape, converter, m_handleRadius, m_decorationThickness);
 
            helper.setHandleStyle(KisHandleStyle::secondarySelection(palette));
 
            if (!m_forceShapeOutlines) {
                helper.drawRubberLine(shape->outlineRect());
            } else {
                QList<QPolygonF> polys = shape->outline().toSubpathPolygons();
 
                if (polys.size() == 1) {
                    const QPolygonF poly1 = polys[0];
                    const QPolygonF poly2 = QPolygonF(polys[0].boundingRect());
                    const QPolygonF nonoverlap = poly2.subtracted(poly1);
 
                    forceBoundingRubberLine |= !nonoverlap.isEmpty();
                }
 
                Q_FOREACH (const QPolygonF &poly, polys) {
                    helper.drawRubberLine(poly);
                }
            }
        }
 
        if (shape->isShapeEditable()) {
            editable = true;
        }
    }
 
    const QRectF handleArea = m_selection->outlineRect();
 
    // draw extra rubber line around all the shapes
    if (selectedShapes.size() > 1 || forceBoundingRubberLine) {
        KisHandlePainterHelper helper =
            KoShape::createHandlePainterHelperView(&painter, m_selection, converter, m_handleRadius, m_decorationThickness);
 
        helper.setHandleStyle(KisHandleStyle::primarySelection(palette));
        helper.drawRubberLine(handleArea);
    }
 
    // if we have no editable shape selected there
    // is no need drawing the selection handles
    if (editable) {
        KisHandlePainterHelper helper =
            KoShape::createHandlePainterHelperView(&painter, m_selection, converter, m_handleRadius, m_decorationThickness);
        helper.setHandleStyle(KisHandleStyle::primarySelection(palette));
 
        QPolygonF outline = handleArea;
 
        {
            helper.drawHandleRect(outline.value(0));
            helper.drawHandleRect(outline.value(1));
            helper.drawHandleRect(outline.value(2));
            helper.drawHandleRect(outline.value(3));
            helper.drawHandleRect(0.5 * (outline.value(0) + outline.value(1)));
            helper.drawHandleRect(0.5 * (outline.value(1) + outline.value(2)));
            helper.drawHandleRect(0.5 * (outline.value(2) + outline.value(3)));
            helper.drawHandleRect(0.5 * (outline.value(3) + outline.value(0)));
 
            QPointF hotPos = KoFlake::anchorToPoint(m_hotPosition, handleArea);
            helper.setHandleStyle(KisHandleStyle::highlightedPrimaryHandles(palette));
            helper.drawHandleRect(hotPos);
        }
    }
 
    if (haveOnlyOneEditableShape) {
        KoShape *shape = selectedShapes.first();
 
        if (m_showFillGradientHandles) {
            paintGradientHandles(shape, KoFlake::Fill, painter, converter);
        } else if (m_showStrokeFillGradientHandles) {
            paintGradientHandles(shape, KoFlake::StrokeFill, painter, converter);
        }
 
        // paint meshgradient handles
        if(m_showFillMeshGradientHandles) {
            paintMeshGradientHandles(shape, KoFlake::Fill, painter, converter);
        }
    }
 
}

References KoFlake::anchorToPoint(), KoShape::createHandlePainterHelperView(), KisHandlePainterHelper::drawHandleRect(), KisHandlePainterHelper::drawRubberLine(), KoFlake::Fill, KoColorDisplayRendererInterface::handlePaletteForDisplayColorSpace(), KisHandleStyle::highlightedPrimaryHandles(), KoShape::isShapeEditable(), KoShape::linearizeSubtree(), m_decorationThickness, m_forceShapeOutlines, m_handleRadius, m_hotPosition, m_rendererInterface, m_selection, m_showFillGradientHandles, m_showFillMeshGradientHandles, m_showStrokeFillGradientHandles, KoShape::outline(), KoShape::outlineRect(), KoSelection::outlineRect(), paintGradientHandles(), paintMeshGradientHandles(), palette, KisHandleStyle::primarySelection(), KisHandleStyle::secondarySelection(), KoSelection::selectedEditableShapes(), KoSelection::selectedVisibleShapes(), KisHandlePainterHelper::setHandleStyle(), and KoFlake::StrokeFill.

paintGradientHandles()

void SelectionDecorator::paintGradientHandles ( KoShape * shape, KoFlake::FillVariant fillVariant, QPainter & painter, const KoViewConverter & converter )

private

Definition at line 184 of file SelectionDecorator.cpp.

{
    KoShapeGradientHandles gradientHandles(fillVariant, shape);
    QVector<KoShapeGradientHandles::Handle> handles = gradientHandles.handles();
    const KisHandlePalette palette = m_rendererInterface->handlePaletteForDisplayColorSpace();
 
    KisHandlePainterHelper helper =
        KoShape::createHandlePainterHelperView(&painter, shape, converter, m_handleRadius, m_decorationThickness);
 
    const QTransform t = shape->absoluteTransformation().inverted();
 
    if (gradientHandles.type() == QGradient::LinearGradient) {
        KIS_SAFE_ASSERT_RECOVER_NOOP(handles.size() == 2);
 
        if (handles.size() == 2) {
            helper.setHandleStyle(KisHandleStyle::gradientArrows(palette));
            helper.drawGradientArrow(t.map(handles[0].pos), t.map(handles[1].pos), 1.5 * m_handleRadius);
        }
    }
 
    helper.setHandleStyle(KisHandleStyle::gradientHandles(palette));
 
    Q_FOREACH (const KoShapeGradientHandles::Handle &h, handles) {
        if (h.type == KoShapeGradientHandles::Handle::RadialCenter) {
            helper.drawGradientCrossHandle(t.map(h.pos), 1.2 * m_handleRadius);
        } else {
            helper.drawGradientHandle(t.map(h.pos), 1.2 * m_handleRadius);
        }
    }
}

References KoShape::absoluteTransformation(), KoShape::createHandlePainterHelperView(), KisHandlePainterHelper::drawGradientArrow(), KisHandlePainterHelper::drawGradientCrossHandle(), KisHandlePainterHelper::drawGradientHandle(), KisHandleStyle::gradientArrows(), KisHandleStyle::gradientHandles(), KoColorDisplayRendererInterface::handlePaletteForDisplayColorSpace(), KoShapeGradientHandles::handles(), KIS_SAFE_ASSERT_RECOVER_NOOP, m_decorationThickness, m_handleRadius, m_rendererInterface, palette, KoShapeGradientHandles::Handle::RadialCenter, KisHandlePainterHelper::setHandleStyle(), and KoShapeGradientHandles::type().

paintMeshGradientHandles()

void SelectionDecorator::paintMeshGradientHandles ( KoShape * shape, KoFlake::FillVariant fillVariant, QPainter & painter, const KoViewConverter & converter )

private

Definition at line 215 of file SelectionDecorator.cpp.

{
    KoShapeMeshGradientHandles gradientHandles(fillVariant, shape);
    const KisHandlePalette palette = m_rendererInterface->handlePaletteForDisplayColorSpace();
 
    KisHandlePainterHelper helper =
        KoShape::createHandlePainterHelperView(&painter, shape, converter, m_handleRadius, m_decorationThickness);
    helper.setHandleStyle(KisHandleStyle::secondarySelection(palette));
 
    helper.drawPath(gradientHandles.path());
 
    // invert them, because we draw in logical coordinates.
    const QTransform t = shape->absoluteTransformation().inverted();
    const QVector<KoShapeMeshGradientHandles::Handle> cornerHandles = gradientHandles.handles();
    for (const auto& corner: cornerHandles) {
        const QPointF point = t.map(corner.pos);
        if (corner.type == KoShapeMeshGradientHandles::Handle::BezierHandle) {
            helper.drawConnectionLine(gradientHandles.getAttachedCorner(corner), point);
            helper.drawHandleSmallCircle(point);
        } else if (corner.type == KoShapeMeshGradientHandles::Handle::Corner) {
            helper.drawHandleCircle(point);
        }
    }
 
    helper.setHandleStyle(KisHandleStyle::highlightedPrimaryHandlesWithSolidOutline(palette));
 
    // highlight the selected handle (only corner)
    if (m_selectedMeshHandle.type == KoShapeMeshGradientHandles::Handle::Corner) {
        helper.drawHandleRect(t.map(gradientHandles.getHandle(m_selectedMeshHandle.getPosition()).pos));
    }
 
    // highlight the path which is being hovered/moved
    if (m_currentHoveredMeshHandle.type != KoShapeMeshGradientHandles::Handle::None) {
        QVector<QPainterPath> paths = gradientHandles.getConnectedPath(m_currentHoveredMeshHandle);
        for (const auto &path: paths) {
            helper.drawPath(path);
        }
    }
}

References KoShape::absoluteTransformation(), KoShapeMeshGradientHandles::Handle::BezierHandle, KoShapeMeshGradientHandles::Handle::Corner, KoShape::createHandlePainterHelperView(), KisHandlePainterHelper::drawConnectionLine(), KisHandlePainterHelper::drawHandleCircle(), KisHandlePainterHelper::drawHandleRect(), KisHandlePainterHelper::drawHandleSmallCircle(), KisHandlePainterHelper::drawPath(), KoShapeMeshGradientHandles::getAttachedCorner(), KoShapeMeshGradientHandles::getConnectedPath(), KoShapeMeshGradientHandles::getHandle(), KoShapeMeshGradientHandles::Handle::getPosition(), KoColorDisplayRendererInterface::handlePaletteForDisplayColorSpace(), KoShapeMeshGradientHandles::handles(), KisHandleStyle::highlightedPrimaryHandlesWithSolidOutline(), m_currentHoveredMeshHandle, m_decorationThickness, m_handleRadius, m_rendererInterface, m_selectedMeshHandle, KoShapeMeshGradientHandles::Handle::None, palette, KoShapeMeshGradientHandles::path(), KoShapeMeshGradientHandles::Handle::pos, KisHandleStyle::secondarySelection(), KisHandlePainterHelper::setHandleStyle(), and KoShapeMeshGradientHandles::Handle::type.

setCurrentMeshGradientHandles()

void SelectionDecorator::setCurrentMeshGradientHandles	(	const KoShapeMeshGradientHandles::Handle &	selectedHandle,
		const KoShapeMeshGradientHandles::Handle &	hoveredHandle )

Definition at line 79 of file SelectionDecorator.cpp.

{
    m_selectedMeshHandle = selectedHandle;
    m_currentHoveredMeshHandle = hoveredHandle;
}

References m_currentHoveredMeshHandle, and m_selectedMeshHandle.

setDecorationThickness()

void SelectionDecorator::setDecorationThickness

(

int

thickness

)

set the thickness of decoration lines, used for HiDPI support.

Parameters

thickness

– the new thickness

Definition at line 59 of file SelectionDecorator.cpp.

{
    m_decorationThickness = thickness;
}

References m_decorationThickness.

setForceShapeOutlines()

void SelectionDecorator::setForceShapeOutlines

(

bool

value

)

Definition at line 258 of file SelectionDecorator.cpp.

{
    m_forceShapeOutlines = value;
}

References m_forceShapeOutlines, and value().

setHandleRadius()

void SelectionDecorator::setHandleRadius

(

int

radius

)

set the radius of the selection handles

Parameters

radius

the new handle radius

Definition at line 54 of file SelectionDecorator.cpp.

{
    m_handleRadius = radius;
}

References m_handleRadius.

setSelection()

void SelectionDecorator::setSelection

(

KoSelection *

selection

)

set the selection that is to be painted.

Parameters

selection

the current selection.

Definition at line 49 of file SelectionDecorator.cpp.

{
    m_selection = selection;
}

References m_selection.

setShowFillGradientHandles()

void SelectionDecorator::setShowFillGradientHandles

(

bool

value

)

Set true if you want to render gradient handles on the canvas. Default value: false

Definition at line 64 of file SelectionDecorator.cpp.

{
    m_showFillGradientHandles = value;
}

References m_showFillGradientHandles, and value().

setShowFillMeshGradientHandles()

void SelectionDecorator::setShowFillMeshGradientHandles

(

bool

value

)

Definition at line 74 of file SelectionDecorator.cpp.

{
    m_showFillMeshGradientHandles = value;
}

References m_showFillMeshGradientHandles, and value().

setShowStrokeFillGradientHandles()

void SelectionDecorator::setShowStrokeFillGradientHandles

(

bool

value

)

Set true if you want to render gradient handles on the canvas. Default value: false

Definition at line 69 of file SelectionDecorator.cpp.

{
    m_showStrokeFillGradientHandles = value;
}

References m_showStrokeFillGradientHandles, and value().

Member Data Documentation

m_currentHoveredMeshHandle

KoShapeMeshGradientHandles::Handle SelectionDecorator::m_currentHoveredMeshHandle

private

Definition at line 94 of file SelectionDecorator.h.

m_decorationThickness

int SelectionDecorator::m_decorationThickness {1}

private

Definition at line 97 of file SelectionDecorator.h.

{1};

m_forceShapeOutlines

bool SelectionDecorator::m_forceShapeOutlines {false}

private

Definition at line 101 of file SelectionDecorator.h.

{false};

m_handleRadius

int SelectionDecorator::m_handleRadius {7}

private

Definition at line 96 of file SelectionDecorator.h.

{7};

m_hotPosition

KoFlake::AnchorPosition SelectionDecorator::m_hotPosition

private

Definition at line 91 of file SelectionDecorator.h.

m_rendererInterface

KoColorDisplayRendererInterface* SelectionDecorator::m_rendererInterface {nullptr}

private

Definition at line 93 of file SelectionDecorator.h.

{nullptr};

m_selectedMeshHandle

KoShapeMeshGradientHandles::Handle SelectionDecorator::m_selectedMeshHandle

private

Definition at line 95 of file SelectionDecorator.h.

m_selection

KoSelection* SelectionDecorator::m_selection {nullptr}

private

Definition at line 92 of file SelectionDecorator.h.

{nullptr};

m_showFillGradientHandles

bool SelectionDecorator::m_showFillGradientHandles {false}

private

Definition at line 98 of file SelectionDecorator.h.

{false};

m_showFillMeshGradientHandles

bool SelectionDecorator::m_showFillMeshGradientHandles {false}

private

Definition at line 100 of file SelectionDecorator.h.

{false};

m_showStrokeFillGradientHandles

bool SelectionDecorator::m_showStrokeFillGradientHandles {false}

private

Definition at line 99 of file SelectionDecorator.h.

{false};

---

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

• plugins/tools/defaulttool/defaulttool/SelectionDecorator.h
• plugins/tools/defaulttool/defaulttool/SelectionDecorator.cpp