EnhancedPathNamedParameter Class Reference

A named parameter, one that refers to a variable of the path. More...

#include <EnhancedPathParameter.h>

Inheritance diagram for EnhancedPathNamedParameter:

Public Member Functions
	EnhancedPathNamedParameter (const QString &identifier, EnhancedPathShape *parent)
	Constructs named parameter from given identifier string.
	EnhancedPathNamedParameter (Identifier identifier, EnhancedPathShape *parent)
	Constructs named parameter from given identifier.
qreal	evaluate () override
	evaluates the parameter using the given path
QString	toString () const override
	returns string representation of the parameter
Public Member Functions inherited from EnhancedPathParameter
	EnhancedPathParameter (EnhancedPathShape *parent)
virtual void	modify (qreal value)
	modifies the parameter if possible, using the new value
virtual	~EnhancedPathParameter ()

Static Public Member Functions
static Identifier	identifierFromString (const QString &text)
	Returns identifier type from given string.

Private Attributes
Identifier	m_identifier
	the identifier type

Additional Inherited Members
Protected Member Functions inherited from EnhancedPathParameter
EnhancedPathShape *	parent ()

Detailed Description

A named parameter, one that refers to a variable of the path.

Definition at line 63 of file EnhancedPathParameter.h.

Constructor & Destructor Documentation

EnhancedPathNamedParameter() [1/2]

EnhancedPathNamedParameter::EnhancedPathNamedParameter	(	Identifier	identifier,
		EnhancedPathShape *	parent )

Constructs named parameter from given identifier.

Definition at line 72 of file EnhancedPathParameter.cpp.

    : EnhancedPathParameter(parent)
    , m_identifier(identifier)
{
}

EnhancedPathNamedParameter() [2/2]

EnhancedPathNamedParameter::EnhancedPathNamedParameter	(	const QString &	identifier,
		EnhancedPathShape *	parent )

Constructs named parameter from given identifier string.

Definition at line 78 of file EnhancedPathParameter.cpp.

    : EnhancedPathParameter(parent)
{
    m_identifier = identifierFromString(identifier);
}

References identifierFromString(), and m_identifier.

Member Function Documentation

evaluate()

qreal EnhancedPathNamedParameter::evaluate ( )

overridevirtual

evaluates the parameter using the given path

Implements EnhancedPathParameter.

Definition at line 84 of file EnhancedPathParameter.cpp.

{
    const QRect &viewBox = parent()->viewBox();
 
    switch (m_identifier) {
    case IdentifierPi:
        return M_PI;
        break;
    case IdentifierLeft:
        return viewBox.left();
        break;
    case IdentifierTop:
        return viewBox.top();
        break;
    case IdentifierRight:
        return viewBox.right();
        break;
    case IdentifierBottom:
        return viewBox.bottom();
        break;
    case IdentifierXstretch:
        break;
    case IdentifierYstretch:
        break;
    case IdentifierHasStroke:
        return parent()->stroke() ? 1.0 : 0.0;
        break;
    case IdentifierHasFill:
        return parent()->background() ? 0.0 : 1.0;
        break;
    case IdentifierWidth:
        return viewBox.width();
        break;
    case IdentifierHeight:
        return viewBox.height();
        break;
    case IdentifierLogwidth:
        // TODO: ? viewBox does not have any unit or const relation to mm
        return KoUnit(KoUnit::Millimeter).toUserValue(viewBox.width()) * 100;
        break;
    case IdentifierLogheight:
        // TODO: ? viewBox does not have any unit or const relation to mm
        return KoUnit(KoUnit::Millimeter).toUserValue(viewBox.height()) * 100;
        break;
    default:
        break;
    }
    return 0.0;
}

References KoShape::background(), IdentifierBottom, IdentifierHasFill, IdentifierHasStroke, IdentifierHeight, IdentifierLeft, IdentifierLogheight, IdentifierLogwidth, IdentifierPi, IdentifierRight, IdentifierTop, IdentifierWidth, IdentifierXstretch, IdentifierYstretch, m_identifier, M_PI, KoUnit::Millimeter, EnhancedPathParameter::parent(), KoShape::stroke(), KoUnit::toUserValue(), and EnhancedPathShape::viewBox().

identifierFromString()

Identifier EnhancedPathNamedParameter::identifierFromString ( const QString & text )

static

Returns identifier type from given string.

Definition at line 134 of file EnhancedPathParameter.cpp.

{
    if (text.isEmpty()) {
        return IdentifierUnknown;
    } else if (text == "pi") {
        return IdentifierPi;
    } else if (text == "left") {
        return IdentifierLeft;
    } else if (text == "top") {
        return IdentifierTop;
    } else if (text == "right") {
        return IdentifierRight;
    } else if (text == "bottom") {
        return IdentifierBottom;
    } else if (text == "xstretch") {
        return IdentifierXstretch;
    } else if (text == "ystretch") {
        return IdentifierYstretch;
    } else if (text == "hasstroke") {
        return IdentifierHasStroke;
    } else if (text == "hasfill") {
        return IdentifierHasFill;
    } else if (text == "width") {
        return IdentifierWidth;
    } else if (text == "height") {
        return IdentifierHeight;
    } else if (text == "logwidth") {
        return IdentifierLogwidth;
    } else if (text == "logheight") {
        return IdentifierLogheight;
    } else {
        return IdentifierUnknown;
    }
}

References IdentifierBottom, IdentifierHasFill, IdentifierHasStroke, IdentifierHeight, IdentifierLeft, IdentifierLogheight, IdentifierLogwidth, IdentifierPi, IdentifierRight, IdentifierTop, IdentifierUnknown, IdentifierWidth, IdentifierXstretch, and IdentifierYstretch.

toString()

QString EnhancedPathNamedParameter::toString ( ) const

overridevirtual

returns string representation of the parameter

Implements EnhancedPathParameter.

Definition at line 169 of file EnhancedPathParameter.cpp.

{
    return identifierData[m_identifier];
}

References identifierData, and m_identifier.

Member Data Documentation

m_identifier

Identifier EnhancedPathNamedParameter::m_identifier

private

the identifier type

Definition at line 75 of file EnhancedPathParameter.h.

---

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

• plugins/flake/pathshapes/enhancedpath/EnhancedPathParameter.h
• plugins/flake/pathshapes/enhancedpath/EnhancedPathParameter.cpp