KoUnit Class Reference

#include <KoUnit.h>

Inheritance diagram for KoUnit:

Public Types
enum	ListOption { ListAll = 0 , HidePixel = 1 , HideMask = HidePixel }
	Used to control the scope of the unit types listed in the UI. More...
enum	Type {   Millimeter = 0 , Point , Inch , Centimeter ,   Decimeter , Pica , Cicero , Pixel ,   TypeCount }

Public Member Functions
void	adjustByPixelTransform (const QTransform &t)
qreal	fromUserValue (const QString &value, bool *ok=0) const
qreal	fromUserValue (qreal value) const
int	indexInListForUi (ListOptions listOptions=ListAll) const
	KoUnit (Type unit=Point, qreal factor=1.0)
KoUnit &	operator= (Type unit)
bool	operator== (const KoUnit &other) const
void	setFactor (qreal factor)
QString	symbol () const
	Get the symbol string of the unit.
QString	toString () const
QString	toUserStringValue (qreal ptValue) const
qreal	toUserValue (qreal ptValue, bool rounding=true) const
qreal	toUserValuePrecise (const qreal ptValue) const
qreal	toUserValueRounded (const qreal value) const
KoUnit::Type	type () const

Static Public Member Functions
static qreal	approxTransformScale (const QTransform &t)
static qreal	convertFromUnitToUnit (const qreal value, const KoUnit &fromUnit, const KoUnit &toUnit, qreal factor=1.0)
static KoUnit	fromListForUi (int index, ListOptions listOptions=ListAll, qreal factor=1.0)
static KoUnit	fromSymbol (const QString &symbol, bool *ok=0)
static QStringList	listOfUnitNameForUi (ListOptions listOptions=ListAll)
	Returns the list of unit types for the UI, controlled with the given listOptions.
static qreal	parseAngle (const QString &value, qreal defaultVal=0.0)
	parse an angle to its value in degrees
static qreal	parseValue (const QString &value, qreal defaultVal=0.0)
	parse common Krita and Odf values, like "10cm", "5mm" to pt
static QString	unitDescription (KoUnit::Type type)
	Get the description string of the given unit.

Private Attributes
qreal	m_pixelConversion
Type	m_type

Detailed Description

Krita stores everything in pt (using "qreal") internally. When displaying a value to the user, the value is converted to the user's unit of choice, and rounded to a reasonable precision to avoid 0.999999

For implementing the selection of a unit type in the UI use the *ForUi() methods. They ensure the same order of the unit types in all places, with the order not bound to the order in the enum (so ABI-compatible extension is possible) and with the order and scope of listed types controlled by the ListOptions parameter.

Definition at line 70 of file KoUnit.h.

Member Enumeration Documentation

ListOption

enum KoUnit::ListOption

Used to control the scope of the unit types listed in the UI.

Enumerator
ListAll
HidePixel
HideMask

Definition at line 87 of file KoUnit.h.

                    {
        ListAll = 0,
        HidePixel = 1,
        HideMask = HidePixel
    };

Type

enum KoUnit::Type

Length units supported by Krita.

Enumerator
Millimeter
Point	Postscript point, 1/72th of an Inco.
Inch
Centimeter
Decimeter
Pica
Cicero
Pixel
TypeCount

Definition at line 74 of file KoUnit.h.

              {
        Millimeter = 0,
        Point,  
        Inch,
        Centimeter,
        Decimeter,
        Pica,
        Cicero,
        Pixel,
        TypeCount 
    };

Constructor & Destructor Documentation

KoUnit()

KoUnit::KoUnit ( Type unit = Point, qreal factor = 1.0 )

inlineexplicit

Construction requires initialization. The factor is for variable factor units like pixel

Definition at line 103 of file KoUnit.h.

                                                           {
        m_type = unit;
        m_pixelConversion = factor;
    }

Member Function Documentation

adjustByPixelTransform()

void KoUnit::adjustByPixelTransform

(

const QTransform &

t

)

Adjust the unit by pixel transformation applied to the describing object. It multiplies the pixel coefficient by the average scale of the matrix.

Definition at line 392 of file KoUnit.cpp.

{
    m_pixelConversion *= approxTransformScale(t);
}

References approxTransformScale(), and m_pixelConversion.

approxTransformScale()

qreal KoUnit::approxTransformScale ( const QTransform & t )

static

Get an approximate scale of a unit vector that was converted by the transformation.

Please note that exact values are guaranteed only for combinations of Translate, Rotation and Uniform Scale matrices. For combinations having shears and perspective the value will be average for the point near CS origin.

Definition at line 387 of file KoUnit.cpp.

{
    return std::sqrt(qAbs(t.determinant()));
}

convertFromUnitToUnit()

qreal KoUnit::convertFromUnitToUnit ( const qreal value, const KoUnit & fromUnit, const KoUnit & toUnit, qreal factor = 1.0 )

static

convert the given value directly from one unit to another

Definition at line 295 of file KoUnit.cpp.

{
    qreal pt;
    switch (fromUnit.type()) {
    case Millimeter:
        pt = MM_TO_POINT(value);
        break;
    case Centimeter:
        pt = CM_TO_POINT(value);
        break;
    case Decimeter:
        pt = DM_TO_POINT(value);
        break;
    case Inch:
        pt = INCH_TO_POINT(value);
        break;
    case Pica:
        pt = PI_TO_POINT(value);
        break;
    case Cicero:
        pt = CC_TO_POINT(value);
        break;
    case Pixel:
        pt = value / factor;
        break;
    case Point:
    default:
        pt = value;
    }
 
    switch (toUnit.type()) {
    case Millimeter:
        return POINT_TO_MM(pt);
    case Centimeter:
        return POINT_TO_CM(pt);
    case Decimeter:
        return POINT_TO_DM(pt);
    case Inch:
        return POINT_TO_INCH(pt);
    case Pica:
        return POINT_TO_PI(pt);
    case Cicero:
        return POINT_TO_CC(pt);
    case Pixel:
        return pt * factor;
    case Point:
    default:
        return pt;
    }
 
}

References CC_TO_POINT(), Centimeter, Cicero, CM_TO_POINT(), Decimeter, DM_TO_POINT(), Inch, INCH_TO_POINT(), Millimeter, MM_TO_POINT(), PI_TO_POINT(), Pica, Pixel, Point, POINT_TO_CC(), POINT_TO_CM(), POINT_TO_DM(), POINT_TO_INCH(), POINT_TO_MM(), POINT_TO_PI(), type(), and value().

fromListForUi()

KoUnit KoUnit::fromListForUi ( int index, ListOptions listOptions = ListAll, qreal factor = 1.0 )

static

Returns a KoUnit instance with the type at the index of the UI list with the given listOptions.

Definition at line 80 of file KoUnit.cpp.

{
    KoUnit::Type type = KoUnit::Point;
 
    if ((0 <= index) && (index < KoUnit::TypeCount)) {
        // iterate through all enums and skip the Pixel enum if needed
        for (int i = 0; i < KoUnit::TypeCount; ++i) {
            if ((listOptions&HidePixel) && (typesInUi[i] == Pixel)) {
                ++index;
                continue;
            }
            if (i == index) {
                type = typesInUi[i];
                break;
            }
        }
    }
 
    return KoUnit(type, factor);
}

References HidePixel, KoUnit(), Pixel, Point, type(), TypeCount, and typesInUi.

fromSymbol()

KoUnit KoUnit::fromSymbol ( const QString & symbol, bool * ok = 0 )

static

Convert a unit symbol string into a KoUnit

Parameters

symbol	symbol to convert
ok	if set, it will be true if the unit was known, false if unknown

Definition at line 271 of file KoUnit.cpp.

{
    Type result = Point;
 
    if (symbol == QLatin1String("inch") /*compat*/) {
        result = Inch;
        if (ok)
            *ok = true;
    } else {
        if (ok)
            *ok = false;
 
        for (int i = 0; i < TypeCount; ++i) {
            if (symbol == QLatin1String(unitNameList[i])) {
                result = static_cast<Type>(i);
                if (ok)
                    *ok = true;
            }
        }
    }
 
    return KoUnit(result);
}

References Inch, KoUnit(), Point, symbol(), TypeCount, and unitNameList.

fromUserValue() [1/2]

qreal KoUnit::fromUserValue	(	const QString &	value,
		bool *	ok = 0 ) const

This method is the one to use to read a value from a dialog

Parameters

value	value entered by the user
ok	if set, the pointed bool is set to true if the value could be converted to a qreal, and to false otherwise.

Returns

the value converted to points for internal use

Definition at line 224 of file KoUnit.cpp.

{
    return fromUserValue(QLocale().toDouble(value, ok));
}

References fromUserValue(), toDouble(), and value().

fromUserValue() [2/2]

qreal KoUnit::fromUserValue

(

qreal

value

)

const

This method is the one to use to read a value from a dialog

Returns

the value converted to points for internal use

Definition at line 201 of file KoUnit.cpp.

{
    switch (m_type) {
    case Millimeter:
        return MM_TO_POINT(value);
    case Centimeter:
        return CM_TO_POINT(value);
    case Decimeter:
        return DM_TO_POINT(value);
    case Inch:
        return INCH_TO_POINT(value);
    case Pica:
        return PI_TO_POINT(value);
    case Cicero:
        return CC_TO_POINT(value);
    case Pixel:
        return value / m_pixelConversion;
    case Point:
    default:
        return value;
    }
}

References CC_TO_POINT(), Centimeter, Cicero, CM_TO_POINT(), Decimeter, DM_TO_POINT(), Inch, INCH_TO_POINT(), m_pixelConversion, m_type, Millimeter, MM_TO_POINT(), PI_TO_POINT(), Pica, Pixel, Point, and value().

indexInListForUi()

int KoUnit::indexInListForUi

(

ListOptions

listOptions = ListAll

)

const

Get the index of this unit in the list of unit types for the UI, if it is controlled with the given listOptions.

Definition at line 101 of file KoUnit.cpp.

{
    if ((listOptions&HidePixel) && (m_type == Pixel)) {
        return -1;
    }
 
    int result = -1;
 
    int skipped = 0;
    for (int i = 0; i < KoUnit::TypeCount; ++i) {
        if ((listOptions&HidePixel) && (typesInUi[i] == Pixel)) {
            ++skipped;
            continue;
        }
        if (typesInUi[i] == m_type) {
            result = i - skipped;
            break;
        }
    }
 
    return result;
}

References HidePixel, m_type, Pixel, TypeCount, and typesInUi.

listOfUnitNameForUi()

QStringList KoUnit::listOfUnitNameForUi ( ListOptions listOptions = ListAll )

static

Returns the list of unit types for the UI, controlled with the given listOptions.

Definition at line 69 of file KoUnit.cpp.

{
    QStringList lst;
    for (int i = 0; i < KoUnit::TypeCount; ++i) {
        const Type type = typesInUi[i];
        if ((type != Pixel) || ((listOptions & HideMask) == ListAll))
            lst.append(unitDescription(type));
    }
    return lst;
}

References HideMask, ListAll, Pixel, type(), TypeCount, typesInUi, and unitDescription().

operator=()

KoUnit & KoUnit::operator= ( Type unit )

inline

Definition at line 108 of file KoUnit.h.

                                 {
        m_type = unit; m_pixelConversion = 1.0; return *this;
    }

operator==()

bool KoUnit::operator== ( const KoUnit & other ) const

inline

Definition at line 112 of file KoUnit.h.

                                               {
        return m_type == other.m_type &&
            (m_type != Pixel ||
             qFuzzyCompare(m_pixelConversion, other.m_pixelConversion));
    }

References m_pixelConversion, m_type, and qFuzzyCompare().

parseAngle()

qreal KoUnit::parseAngle ( const QString & value, qreal defaultVal = 0.0 )

static

parse an angle to its value in degrees

Definition at line 352 of file KoUnit.cpp.

{
    if (_value.isEmpty())
        return defaultVal;
 
    QString value(_value.simplified());
    value.remove(QLatin1Char(' '));
 
    int firstLetter = -1;
    for (int i = 0; i < value.length(); ++i) {
        if (value.at(i).isLetter()) {
            if (value.at(i) == QLatin1Char('e'))
                continue;
            firstLetter = i;
            break;
        }
    }
 
    if (firstLetter == -1)
        return value.toDouble();
 
    const QString type = value.mid(firstLetter);
    value.truncate(firstLetter);
    const qreal val = value.toDouble();
 
    if (type == QLatin1String("deg"))
        return val;
    else if (type == QLatin1String("rad"))
        return val * 180 / M_PI;
    else if (type == QLatin1String("grad"))
        return val * 0.9;
 
    return defaultVal;
}

References M_PI, type(), and value().

parseValue()

qreal KoUnit::parseValue ( const QString & value, qreal defaultVal = 0.0 )

static

parse common Krita and Odf values, like "10cm", "5mm" to pt

Definition at line 229 of file KoUnit.cpp.

{
    if (_value.isEmpty())
        return defaultVal;
 
    QString value(_value.simplified());
    value.remove(QLatin1Char(' '));
 
    int firstLetter = -1;
    for (int i = 0; i < value.length(); ++i) {
        if (value.at(i).isLetter()) {
            if (value.at(i) == QLatin1Char('e'))
                continue;
            firstLetter = i;
            break;
        }
    }
 
    if (firstLetter == -1)
        return value.toDouble();
 
    const QString symbol = value.mid(firstLetter);
    value.truncate(firstLetter);
    const qreal val = value.toDouble();
 
    if (symbol == QLatin1String("pt"))
        return val;
 
    bool ok;
    KoUnit u = KoUnit::fromSymbol(symbol, &ok);
    if (ok)
        return u.fromUserValue(val);
 
    if (symbol == QLatin1String("m"))
        return DM_TO_POINT(val * 10.0);
    else if (symbol == QLatin1String("km"))
        return DM_TO_POINT(val * 10000.0);
 
    // TODO : add support for mi/ft ?
    return defaultVal;
}

References DM_TO_POINT(), fromSymbol(), symbol(), u, and value().

setFactor()

void KoUnit::setFactor ( qreal factor )

inline

Definition at line 122 of file KoUnit.h.

                                 {
        m_pixelConversion = factor;
    }

symbol()

QString KoUnit::symbol

(

)

const

Get the symbol string of the unit.

Definition at line 347 of file KoUnit.cpp.

{
    return QLatin1String(unitNameList[m_type]);
}

References m_type, and unitNameList.

toString()

QString KoUnit::toString ( ) const

inline

Definition at line 189 of file KoUnit.h.

                             {
        return symbol();
    }

toUserStringValue()

QString KoUnit::toUserStringValue

(

qreal

ptValue

)

const

This method is the one to use to display a value in a dialog

Returns

the value ptValue converted the unit and rounded, ready to be displayed

Definition at line 196 of file KoUnit.cpp.

{
    return QLocale().toString(toUserValue(ptValue));
}

References toUserValue().

toUserValue()

qreal KoUnit::toUserValue	(	qreal	ptValue,
		bool	rounding = true ) const

Convert the value ptValue with or with rounding as indicated by rounding. This method is a proxy to toUserValuePrecise and toUserValueRounded.

Returns

the value ptValue converted to unit

Definition at line 186 of file KoUnit.cpp.

{
    if (rounding) {
        return toUserValueRounded(ptValue);
    }
    else {
        return toUserValuePrecise(ptValue);
    }
}

References toUserValuePrecise(), and toUserValueRounded().

toUserValuePrecise()

qreal KoUnit::toUserValuePrecise

(

const qreal

ptValue

)

const

Convert the value ptValue to the unit (without rounding) This method is meant to be used in complex calculations.

Returns

the converted value

Definition at line 161 of file KoUnit.cpp.

{
    switch (m_type) {
    case Millimeter:
        return POINT_TO_MM(ptValue);
    case Centimeter:
        return POINT_TO_CM(ptValue);
    case Decimeter:
        return POINT_TO_DM(ptValue);
    case Inch:
        return POINT_TO_INCH(ptValue);
    case Pica:
        return POINT_TO_PI(ptValue);
    case Cicero:
        return POINT_TO_CC(ptValue);
    case Pixel:
        return ptValue * m_pixelConversion;
    case Point:
    default:
        return ptValue;
    }
}

References Centimeter, Cicero, Decimeter, Inch, m_pixelConversion, m_type, Millimeter, Pica, Pixel, Point, POINT_TO_CC(), POINT_TO_CM(), POINT_TO_DM(), POINT_TO_INCH(), POINT_TO_MM(), and POINT_TO_PI().

toUserValueRounded()

qreal KoUnit::toUserValueRounded

(

const qreal

value

)

const

Convert the value ptValue to the unit and round it. This method is meant to be used to display a value in a dialog.

Returns

the converted and rounded value

Definition at line 126 of file KoUnit.cpp.

{
    qreal userValue = toUserValuePrecise(value);
    qreal rounding = 1.0;
 
    switch (m_type) {
    case Pixel:
        return userValue; // no rounding for Pixel value
    case Millimeter:
        rounding = MM_ROUNDING;
        break;
    case Centimeter:
        rounding = CM_ROUNDING;
        break;
    case Decimeter:
        rounding = DM_ROUNDING;
        break;
    case Inch:
        rounding = IN_ROUNDING;
        break;
    case Pica:
        rounding = PI_ROUNDING;
        break;
    case Cicero:
        rounding = CC_ROUNDING;
        break;
    case Point:
    default:
        rounding = PT_ROUNDING;
    }
 
 
    return floor(userValue * rounding) / rounding;
}

References CC_ROUNDING, Centimeter, Cicero, CM_ROUNDING, Decimeter, DM_ROUNDING, IN_ROUNDING, Inch, m_type, Millimeter, MM_ROUNDING, PI_ROUNDING, Pica, Pixel, Point, PT_ROUNDING, toUserValuePrecise(), and value().

type()

KoUnit::Type KoUnit::type ( ) const

inline

Definition at line 118 of file KoUnit.h.

                            {
        return m_type;
    }

unitDescription()

QString KoUnit::unitDescription ( KoUnit::Type type )

static

Get the description string of the given unit.

Definition at line 32 of file KoUnit.cpp.

{
    switch (type) {
    case KoUnit::Millimeter:
        return i18n("Millimeters (mm)");
    case KoUnit::Centimeter:
        return i18n("Centimeters (cm)");
    case KoUnit::Decimeter:
        return i18n("Decimeters (dm)");
    case KoUnit::Inch:
        return i18n("Inches (in)");
    case KoUnit::Pica:
        return i18n("Pica (pi)");
    case KoUnit::Cicero:
        return i18n("Cicero (cc)");
    case KoUnit::Point:
        return i18n("Points (pt)");
    case KoUnit::Pixel:
        return i18n("Pixels (px)");
    default:
        return i18n("Unsupported unit");
    }
}

References Centimeter, Cicero, Decimeter, Inch, Millimeter, Pica, Pixel, Point, and type().

Member Data Documentation

m_pixelConversion

qreal KoUnit::m_pixelConversion

private

Definition at line 213 of file KoUnit.h.

m_type

Type KoUnit::m_type

private

Definition at line 212 of file KoUnit.h.

---

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

• libs/global/KoUnit.h
• libs/global/KoUnit.cpp