KoViewConverter Class Reference

#include <KoViewConverter.h>

Inheritance diagram for KoViewConverter:

Public Member Functions
QTransform	documentToView () const
virtual QPointF	documentToView (const QPointF &documentPoint) const
virtual QRectF	documentToView (const QRectF &documentRect) const
virtual QSizeF	documentToView (const QSizeF &documentSize) const
virtual qreal	documentToViewX (qreal documentX) const
virtual qreal	documentToViewY (qreal documentY) const
	KoViewConverter ()
virtual KoViewTransformStillPoint	makeDocStillPoint (const QPointF &docPoint) const
	Creates a still point that links the docPoint of the image (in document pixels!) to the corresponding point on the screen (in the canvas widget).
virtual KoViewTransformStillPoint	makeWidgetStillPoint (const QPointF &viewPoint) const
	Creates a still point that links the viewPoint of the widget to the corresponding point of the image.
virtual void	setZoom (qreal zoom)
QTransform	viewToDocument () const
virtual QPointF	viewToDocument (const QPointF &viewPoint) const
virtual QRectF	viewToDocument (const QRectF &viewRect) const
virtual QSizeF	viewToDocument (const QSizeF &viewSize) const
virtual qreal	viewToDocumentX (qreal viewX) const
virtual qreal	viewToDocumentY (qreal viewY) const
virtual QTransform	viewToWidget () const
virtual QTransform	widgetToView () const
qreal	zoom () const
virtual void	zoom (qreal *zoomX, qreal *zoomY) const
virtual	~KoViewConverter ()

Private Attributes
qreal	m_zoomLevel

Detailed Description

The interface for view conversions.

All KoShape based objects are using a postscript-point (pt) based measurement system which requires a conversion to view coordinates (in pixel sizes) at the moment we are painting, and a conversion to the normalized coordinate system if we receive mouse events so we can figure out which KoShape object was touched.

The zoom level is expressed on a scale of 0.0 to 1.0 to infinite, where 1.0 is 100%

Definition at line 31 of file KoViewConverter.h.

Constructor & Destructor Documentation

KoViewConverter()

KoViewConverter::KoViewConverter

(

)

Definition at line 13 of file KoViewConverter.cpp.

    : m_zoomLevel(1.0)
{
}

~KoViewConverter()

virtual KoViewConverter::~KoViewConverter ( )

inlinevirtual

Definition at line 35 of file KoViewConverter.h.

{}

Member Function Documentation

documentToView() [1/4]

QTransform KoViewConverter::documentToView

(

)

const

Definition at line 111 of file KoViewConverter.cpp.

{
    qreal zoomX, zoomY;
    zoom(&zoomX, &zoomY);
    return QTransform::fromScale(zoomX, zoomY);
}

References zoom().

documentToView() [2/4]

QPointF KoViewConverter::documentToView ( const QPointF & documentPoint ) const

virtual

Convert a coordinate in pt to pixels.

Parameters

documentPoint

the point in the document coordinate system of a KoShape.

Reimplemented in KoZoomHandler.

Definition at line 18 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(m_zoomLevel, 1))
        return documentPoint;
    return QPointF(documentToViewX(documentPoint.x()), documentToViewY(documentPoint.y()));
}

References documentToViewX(), documentToViewY(), m_zoomLevel, and qFuzzyCompare().

documentToView() [3/4]

QRectF KoViewConverter::documentToView ( const QRectF & documentRect ) const

virtual

Convert a rectangle in pt to pixels.

Parameters

documentRect

the rect in the document coordinate system of a KoShape.

Reimplemented in KoZoomHandler.

Definition at line 32 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(m_zoomLevel, 1))
        return documentRect;
    return QRectF(documentToView(documentRect.topLeft()), documentToView(documentRect.size()));
}

References documentToView(), m_zoomLevel, and qFuzzyCompare().

documentToView() [4/4]

QSizeF KoViewConverter::documentToView ( const QSizeF & documentSize ) const

virtual

Convert a size in pt to pixels.

Parameters

documentSize

the size in pt.

Returns

the size in pixels.

Reimplemented in KoZoomHandler.

Definition at line 46 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(m_zoomLevel, 1))
        return documentSize;
    return QSizeF(documentToViewX(documentSize.width()), documentToViewY(documentSize.height()));
}

References documentToViewX(), documentToViewY(), m_zoomLevel, and qFuzzyCompare().

documentToViewX()

qreal KoViewConverter::documentToViewX ( qreal documentX ) const

virtual

Convert a single x coordinate in pt to pixels.

Parameters

documentX

the x coordinate in pt.

Returns

the x coordinate in pixels.

Reimplemented in KisImageViewConverter, and KoZoomHandler.

Definition at line 66 of file KoViewConverter.cpp.

{
    return documentX * m_zoomLevel;
}

References m_zoomLevel.

documentToViewY()

qreal KoViewConverter::documentToViewY ( qreal documentY ) const

virtual

Convert a single y coordinate in pt to pixels.

Parameters

documentY

the y coordinate in pt.

Returns

the y coordinate in pixels.

Reimplemented in KisImageViewConverter, and KoZoomHandler.

Definition at line 71 of file KoViewConverter.cpp.

{
    return documentY * m_zoomLevel;
}

References m_zoomLevel.

makeDocStillPoint()

KoViewTransformStillPoint KoViewConverter::makeDocStillPoint ( const QPointF & docPoint ) const

virtual

Creates a still point that links the docPoint of the image (in document pixels!) to the corresponding point on the screen (in the canvas widget).

The link is "baked" in KoViewTransformStillPoint object, hence intermediate transformations will not affect it.

Reimplemented in KisCoordinatesConverter.

Reimplemented in KisCoordinatesConverter.

Definition at line 106 of file KoViewConverter.cpp.

{
    return {docPoint, viewToWidget().map(documentToView(docPoint))};
}

makeWidgetStillPoint()

KoViewTransformStillPoint KoViewConverter::makeWidgetStillPoint ( const QPointF & viewPoint ) const

virtual

Creates a still point that links the viewPoint of the widget to the corresponding point of the image.

The link is "baked" in KoViewTransformStillPoint object, hence intermediate transformations will not affect it.

Reimplemented in KisCoordinatesConverter.

Reimplemented in KisCoordinatesConverter.

Definition at line 101 of file KoViewConverter.cpp.

{
    return { viewToDocument(widgetToView().map(viewPoint)), viewPoint };
}

References viewToDocument(), and widgetToView().

setZoom()

void KoViewConverter::setZoom ( qreal zoom )

virtual

Set the zoom level. 1.0 is 100%.

Reimplemented in KisCoordinatesConverter, and KoZoomHandler.

Definition at line 88 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(zoom, qreal(0.0)) || qFuzzyCompare(zoom, qreal(1.0))) {
        zoom = 1;
    }
    m_zoomLevel = zoom;
}

References m_zoomLevel, qFuzzyCompare(), and zoom().

viewToDocument() [1/4]

QTransform KoViewConverter::viewToDocument

(

)

const

Definition at line 118 of file KoViewConverter.cpp.

{
    qreal zoomX, zoomY;
    zoom(&zoomX, &zoomY);
    return QTransform::fromScale(1.0 / zoomX, 1.0 / zoomY);
}

References zoom().

viewToDocument() [2/4]

QPointF KoViewConverter::viewToDocument ( const QPointF & viewPoint ) const

virtual

Convert a coordinate in pixels to pt.

Parameters

viewPoint

the point in the coordinate system of the widget, or window.

Reimplemented in KoZoomHandler.

Definition at line 25 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(m_zoomLevel, 1))
        return viewPoint;
    return QPointF(viewToDocumentX(viewPoint.x()), viewToDocumentY(viewPoint.y()));
}

References m_zoomLevel, qFuzzyCompare(), viewToDocumentX(), and viewToDocumentY().

viewToDocument() [3/4]

QRectF KoViewConverter::viewToDocument ( const QRectF & viewRect ) const

virtual

Convert a rectangle in pixels to pt.

Parameters

viewRect

the rect in the coordinate system of the widget, or window.

Reimplemented in KoZoomHandler.

Definition at line 39 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(m_zoomLevel, 1))
        return viewRect;
    return QRectF(viewToDocument(viewRect.topLeft()), viewToDocument(viewRect.size()));
}

References m_zoomLevel, qFuzzyCompare(), and viewToDocument().

viewToDocument() [4/4]

QSizeF KoViewConverter::viewToDocument ( const QSizeF & viewSize ) const

virtual

Convert a size in pixels to pt.

Parameters

viewSize

the size in pixels.

Returns

the size in pt.

Reimplemented in KoZoomHandler.

Definition at line 53 of file KoViewConverter.cpp.

{
    if (qFuzzyCompare(m_zoomLevel, 1))
        return viewSize;
    return QSizeF(viewToDocumentX(viewSize.width()), viewToDocumentY(viewSize.height()));
}

References m_zoomLevel, qFuzzyCompare(), viewToDocumentX(), and viewToDocumentY().

viewToDocumentX()

qreal KoViewConverter::viewToDocumentX ( qreal viewX ) const

virtual

Convert a single x coordinate in pixels to pt.

Parameters

viewX

the x coordinate in pixels.

Returns

the x coordinate in pt.

Reimplemented in KisImageViewConverter, and KoZoomHandler.

Definition at line 76 of file KoViewConverter.cpp.

{
    return viewX / m_zoomLevel;
}

References m_zoomLevel.

viewToDocumentY()

qreal KoViewConverter::viewToDocumentY ( qreal viewY ) const

virtual

Convert a single y coordinate in pixels to pt.

Parameters

viewY

the y coordinate in pixels.

Returns

the y coordinate in pt.

Reimplemented in KisImageViewConverter, and KoZoomHandler.

Definition at line 81 of file KoViewConverter.cpp.

{
    return viewY / m_zoomLevel;
}

References m_zoomLevel.

viewToWidget()

QTransform KoViewConverter::viewToWidget ( ) const

virtual

Reimplemented in KisCoordinatesConverter.

Definition at line 125 of file KoViewConverter.cpp.

{
    return QTransform();
}

widgetToView()

QTransform KoViewConverter::widgetToView ( ) const

virtual

Reimplemented in KisCoordinatesConverter.

Definition at line 130 of file KoViewConverter.cpp.

{
    return QTransform();
}

zoom() [1/2]

qreal KoViewConverter::zoom

(

)

const

Return the current zoom level. 1.0 is 100%.

Definition at line 96 of file KoViewConverter.cpp.

{
    return m_zoomLevel;
}

References m_zoomLevel.

zoom() [2/2]

void KoViewConverter::zoom ( qreal * zoomX, qreal * zoomY ) const

virtual

Retrieve the zoom levels of the individual x and y axes.

Parameters

zoomX	a pointer to a qreal which will be modified to the horizontal zoom.
zoomY	a pointer to a qreal which will be modified to the vertical zoom.

Reimplemented in KoZoomHandler, KisImageViewConverter, and KoZoomHandler.

Definition at line 60 of file KoViewConverter.cpp.

{
    *zoomX = m_zoomLevel;
    *zoomY = m_zoomLevel;
}

References m_zoomLevel.

Member Data Documentation

m_zoomLevel

qreal KoViewConverter::m_zoomLevel

private

Definition at line 150 of file KoViewConverter.h.

---

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

• libs/flake/KoViewConverter.h
• libs/flake/KoViewConverter.cpp