#include <kis_liquify_properties.h>

Inheritance diagram for KisLiquifyProperties:

Public Types
enum	LiquifyMode { MOVE , SCALE , ROTATE , OFFSET , UNDO , N_MODES }

Public Member Functions
qreal	amount () const

bool	amountHasPressure () const

qreal	flow () const

	KisLiquifyProperties ()

	KisLiquifyProperties (const KisLiquifyProperties &rhs)

void	loadAndResetMode ()

void	loadMode ()

LiquifyMode	mode () const

KisLiquifyProperties &	operator= (const KisLiquifyProperties &rhs)

bool	operator== (const KisLiquifyProperties &other) const

bool	reverseDirection () const

void	saveMode () const

void	setAmount (qreal value)

void	setAmountHasPressure (bool value)

void	setFlow (qreal value)

void	setMode (LiquifyMode value)

void	setReverseDirection (bool value)

void	setSize (qreal value)

void	setSizeHasPressure (bool value)

void	setSpacing (qreal value)

void	setUseWashMode (bool value)

qreal	size () const

bool	sizeHasPressure () const

qreal	spacing () const

void	toXML (QDomElement *e) const

bool	useWashMode () const

Static Public Member Functions
static KisLiquifyProperties	fromXML (const QDomElement &e)

static qreal	maxSize ()

static qreal	minSize ()

Private Attributes
qreal	m_amount

bool	m_amountHasPressure

qreal	m_flow

LiquifyMode	m_mode

bool	m_reverseDirection

qreal	m_size

bool	m_sizeHasPressure

qreal	m_spacing

bool	m_useWashMode

Detailed Description

Definition at line 18 of file kis_liquify_properties.h.

Member Enumeration Documentation

◆ LiquifyMode

enum KisLiquifyProperties::LiquifyMode

Enumerator
MOVE
SCALE
ROTATE
OFFSET
UNDO
N_MODES

Definition at line 21 of file kis_liquify_properties.h.

                     {
        MOVE,
        SCALE,
        ROTATE,
        OFFSET,
        UNDO,
 
        N_MODES
    };

Constructor & Destructor Documentation

◆ KisLiquifyProperties() [1/2]

KisLiquifyProperties::KisLiquifyProperties ( )

inline

Definition at line 31 of file kis_liquify_properties.h.

        : m_mode(MOVE),
          m_size(60),
          m_amount(0.05),
          m_spacing(0.2),
          m_sizeHasPressure(false),
          m_amountHasPressure(false),
          m_reverseDirection(false),
          m_useWashMode(false),
          m_flow(0.2)
    {
    }

◆ KisLiquifyProperties() [2/2]

KisLiquifyProperties::KisLiquifyProperties ( const KisLiquifyProperties & rhs )

Definition at line 18 of file kis_liquify_properties.cpp.

{
    m_mode = rhs.m_mode;
    m_size = rhs.m_size;
    m_amount = rhs.m_amount;
    m_spacing = rhs.m_spacing;
    m_sizeHasPressure = rhs.m_sizeHasPressure;
    m_amountHasPressure = rhs.m_amountHasPressure;
    m_reverseDirection = rhs.m_reverseDirection;
    m_useWashMode = rhs.m_useWashMode;
    m_flow = rhs.m_flow;
}

References m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, and m_useWashMode.

Member Function Documentation

◆ amount()

qreal KisLiquifyProperties::amount ( ) const

inline

Definition at line 73 of file kis_liquify_properties.h.

                         {
        return m_amount;
    }

◆ amountHasPressure()

bool KisLiquifyProperties::amountHasPressure ( ) const

inline

Definition at line 94 of file kis_liquify_properties.h.

                                   {
        return m_amountHasPressure;
    }

◆ flow()

qreal KisLiquifyProperties::flow ( ) const

inline

Definition at line 115 of file kis_liquify_properties.h.

                       {
        return m_flow;
    }

◆ fromXML()

KisLiquifyProperties KisLiquifyProperties::fromXML ( const QDomElement & e )

static

Definition at line 145 of file kis_liquify_properties.cpp.

{
    KisLiquifyProperties props;
    bool result = false;
 
    QDomElement liqEl;
    int newMode = 0;
 
    result =
        KisDomUtils::findOnlyElement(e, "liquify_properties", &liqEl) &&
 
        KisDomUtils::loadValue(liqEl, "mode", &newMode) &&
        KisDomUtils::loadValue(liqEl, "size", &props.m_size) &&
        KisDomUtils::loadValue(liqEl, "amount", &props.m_amount) &&
        KisDomUtils::loadValue(liqEl, "spacing", &props.m_spacing) &&
        KisDomUtils::loadValue(liqEl, "sizeHasPressure", &props.m_sizeHasPressure) &&
        KisDomUtils::loadValue(liqEl, "amountHasPressure", &props.m_amountHasPressure) &&
        KisDomUtils::loadValue(liqEl, "reverseDirection", &props.m_reverseDirection) &&
        KisDomUtils::loadValue(liqEl, "useWashMode", &props.m_useWashMode) &&
        KisDomUtils::loadValue(liqEl, "flow", &props.m_flow);
 
    if (result && newMode >= 0 && newMode < N_MODES) {
        props.m_mode = (LiquifyMode) newMode;
    } else {
        result = false;
    }
 
    return props;
}

References KisDomUtils::findOnlyElement(), KisDomUtils::loadValue(), m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, m_useWashMode, and N_MODES.

◆ loadAndResetMode()

void KisLiquifyProperties::loadAndResetMode ( )

Definition at line 120 of file kis_liquify_properties.cpp.

{
    KConfigGroup globalCfg =  KSharedConfig::openConfig()->group("LiquifyTool");
    m_mode = (LiquifyMode) globalCfg.readEntry("mode", (int)m_mode);
 
    loadMode();
}

References loadMode(), and m_mode.

◆ loadMode()

void KisLiquifyProperties::loadMode ( )

Definition at line 105 of file kis_liquify_properties.cpp.

{
    KConfigGroup cfg =
         KSharedConfig::openConfig()->group(liquifyModeString(m_mode));
 
    m_size = cfg.readEntry("size", m_size);
    m_amount = cfg.readEntry("amount", m_amount);
    m_spacing = cfg.readEntry("spacing", m_spacing);
    m_sizeHasPressure = cfg.readEntry("sizeHasPressure", m_sizeHasPressure);
    m_amountHasPressure = cfg.readEntry("amountHasPressure", m_amountHasPressure);
    m_reverseDirection = cfg.readEntry("reverseDirection", m_reverseDirection);
    m_useWashMode = cfg.readEntry("useWashMode", m_useWashMode);
    m_flow = cfg.readEntry("flow", m_flow);
}

References liquifyModeString(), m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, and m_useWashMode.

◆ maxSize()

static qreal KisLiquifyProperties::maxSize ( )

inlinestatic

Definition at line 69 of file kis_liquify_properties.h.

                           {
        return 1000.0;
    }

◆ minSize()

static qreal KisLiquifyProperties::minSize ( )

inlinestatic

Definition at line 65 of file kis_liquify_properties.h.

                           {
        return 5.0;
    }

◆ mode()

LiquifyMode KisLiquifyProperties::mode ( ) const

inline

Definition at line 51 of file kis_liquify_properties.h.

                             {
        return m_mode;
    }

◆ operator=()

KisLiquifyProperties & KisLiquifyProperties::operator= ( const KisLiquifyProperties & rhs )

Definition at line 31 of file kis_liquify_properties.cpp.

{
    m_mode = rhs.m_mode;
    m_size = rhs.m_size;
    m_amount = rhs.m_amount;
    m_spacing = rhs.m_spacing;
    m_sizeHasPressure = rhs.m_sizeHasPressure;
    m_amountHasPressure = rhs.m_amountHasPressure;
    m_reverseDirection = rhs.m_reverseDirection;
    m_useWashMode = rhs.m_useWashMode;
    m_flow = rhs.m_flow;
 
    return *this;
}

References m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, and m_useWashMode.

◆ operator==()

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

Definition at line 46 of file kis_liquify_properties.cpp.

{
    return
        m_mode == other.m_mode &&
        m_size == other.m_size &&
        m_amount == other.m_amount &&
        m_spacing == other.m_spacing &&
        m_sizeHasPressure == other.m_sizeHasPressure &&
        m_amountHasPressure == other.m_amountHasPressure &&
        m_reverseDirection == other.m_reverseDirection &&
        m_useWashMode == other.m_useWashMode &&
        m_flow == other.m_flow;
}

References m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, and m_useWashMode.

◆ reverseDirection()

bool KisLiquifyProperties::reverseDirection ( ) const

inline

Definition at line 101 of file kis_liquify_properties.h.

                                  {
        return m_reverseDirection;
    }

◆ saveMode()

void KisLiquifyProperties::saveMode ( ) const

Definition at line 87 of file kis_liquify_properties.cpp.

{
    KConfigGroup cfg =
         KSharedConfig::openConfig()->group(liquifyModeString(m_mode));
 
    cfg.writeEntry("size", m_size);
    cfg.writeEntry("amount", m_amount);
    cfg.writeEntry("spacing", m_spacing);
    cfg.writeEntry("sizeHasPressure", m_sizeHasPressure);
    cfg.writeEntry("amountHasPressure", m_amountHasPressure);
    cfg.writeEntry("reverseDirection", m_reverseDirection);
    cfg.writeEntry("useWashMode", m_useWashMode);
    cfg.writeEntry("flow", m_flow);
 
    KConfigGroup globalCfg =  KSharedConfig::openConfig()->group("LiquifyTool");
    globalCfg.writeEntry("mode", (int)m_mode);
}

References liquifyModeString(), m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, and m_useWashMode.

◆ setAmount()

void KisLiquifyProperties::setAmount ( qreal value )

inline

Definition at line 76 of file kis_liquify_properties.h.

                                {
        m_amount = value;
    }

References value().

◆ setAmountHasPressure()

void KisLiquifyProperties::setAmountHasPressure ( bool value )

inline

Definition at line 97 of file kis_liquify_properties.h.

                                          {
        m_amountHasPressure = value;
    }

References value().

◆ setFlow()

void KisLiquifyProperties::setFlow ( qreal value )

inline

Definition at line 118 of file kis_liquify_properties.h.

                              {
        m_flow = value;
    }

References value().

◆ setMode()

void KisLiquifyProperties::setMode ( LiquifyMode value )

inline

Definition at line 54 of file kis_liquify_properties.h.

                                    {
        m_mode = value;
    }

References value().

◆ setReverseDirection()

void KisLiquifyProperties::setReverseDirection ( bool value )

inline

Definition at line 104 of file kis_liquify_properties.h.

                                         {
        m_reverseDirection = value;
    }

References value().

◆ setSize()

void KisLiquifyProperties::setSize ( qreal value )

inline

Definition at line 61 of file kis_liquify_properties.h.

                              {
        m_size = value;
    }

References value().

◆ setSizeHasPressure()

void KisLiquifyProperties::setSizeHasPressure ( bool value )

inline

Definition at line 90 of file kis_liquify_properties.h.

                                        {
        m_sizeHasPressure = value;
    }

References value().

◆ setSpacing()

void KisLiquifyProperties::setSpacing ( qreal value )

inline

Definition at line 83 of file kis_liquify_properties.h.

                                 {
        m_spacing = value;
    }

References value().

◆ setUseWashMode()

void KisLiquifyProperties::setUseWashMode ( bool value )

inline

Definition at line 111 of file kis_liquify_properties.h.

                                    {
        m_useWashMode = value;
    }

References value().

◆ size()

qreal KisLiquifyProperties::size ( ) const

inline

Definition at line 58 of file kis_liquify_properties.h.

                       {
        return m_size;
    }

◆ sizeHasPressure()

bool KisLiquifyProperties::sizeHasPressure ( ) const

inline

Definition at line 87 of file kis_liquify_properties.h.

                                 {
        return m_sizeHasPressure;
    }

◆ spacing()

qreal KisLiquifyProperties::spacing ( ) const

inline

Definition at line 80 of file kis_liquify_properties.h.

                          {
        return m_spacing;
    }

◆ toXML()

void KisLiquifyProperties::toXML ( QDomElement * e ) const

Definition at line 128 of file kis_liquify_properties.cpp.

{
    QDomDocument doc = e->ownerDocument();
    QDomElement liqEl = doc.createElement("liquify_properties");
    e->appendChild(liqEl);
 
    KisDomUtils::saveValue(&liqEl, "mode", (int)m_mode);
    KisDomUtils::saveValue(&liqEl, "size", m_size);
    KisDomUtils::saveValue(&liqEl, "amount", m_amount);
    KisDomUtils::saveValue(&liqEl, "spacing", m_spacing);
    KisDomUtils::saveValue(&liqEl, "sizeHasPressure", m_sizeHasPressure);
    KisDomUtils::saveValue(&liqEl, "amountHasPressure", m_amountHasPressure);
    KisDomUtils::saveValue(&liqEl, "reverseDirection", m_reverseDirection);
    KisDomUtils::saveValue(&liqEl, "useWashMode", m_useWashMode);
    KisDomUtils::saveValue(&liqEl, "flow", m_flow);
}

References m_amount, m_amountHasPressure, m_flow, m_mode, m_reverseDirection, m_size, m_sizeHasPressure, m_spacing, m_useWashMode, and KisDomUtils::saveValue().

◆ useWashMode()

bool KisLiquifyProperties::useWashMode ( ) const

inline

Definition at line 108 of file kis_liquify_properties.h.

                             {
        return m_useWashMode;
    }

Member Data Documentation

◆ m_amount

qreal KisLiquifyProperties::m_amount

private

Definition at line 133 of file kis_liquify_properties.h.

◆ m_amountHasPressure

bool KisLiquifyProperties::m_amountHasPressure

private

Definition at line 136 of file kis_liquify_properties.h.

◆ m_flow

qreal KisLiquifyProperties::m_flow

private

Definition at line 140 of file kis_liquify_properties.h.

◆ m_mode

LiquifyMode KisLiquifyProperties::m_mode

private

Definition at line 131 of file kis_liquify_properties.h.

◆ m_reverseDirection

bool KisLiquifyProperties::m_reverseDirection

private

Definition at line 137 of file kis_liquify_properties.h.

◆ m_size

qreal KisLiquifyProperties::m_size

private

Definition at line 132 of file kis_liquify_properties.h.

◆ m_sizeHasPressure

bool KisLiquifyProperties::m_sizeHasPressure

private

Definition at line 135 of file kis_liquify_properties.h.

◆ m_spacing

qreal KisLiquifyProperties::m_spacing

private

Definition at line 134 of file kis_liquify_properties.h.

◆ m_useWashMode

bool KisLiquifyProperties::m_useWashMode

private

Definition at line 139 of file kis_liquify_properties.h.

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

plugins/tools/tool_transform2/kis_liquify_properties.h
plugins/tools/tool_transform2/kis_liquify_properties.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ LiquifyMode

Constructor & Destructor Documentation

◆ KisLiquifyProperties() [1/2]

◆ KisLiquifyProperties() [2/2]

Member Function Documentation

◆ amount()

◆ amountHasPressure()

◆ flow()

◆ fromXML()

◆ loadAndResetMode()

◆ loadMode()

◆ maxSize()

◆ minSize()

◆ mode()

◆ operator=()

◆ operator==()

◆ reverseDirection()

◆ saveMode()

◆ setAmount()

◆ setAmountHasPressure()

◆ setFlow()

◆ setMode()

◆ setReverseDirection()

◆ setSize()

◆ setSizeHasPressure()

◆ setSpacing()

◆ setUseWashMode()

◆ size()

◆ sizeHasPressure()

◆ spacing()

◆ toXML()

◆ useWashMode()

Member Data Documentation

◆ m_amount

◆ m_amountHasPressure

◆ m_flow

◆ m_mode

◆ m_reverseDirection

◆ m_size

◆ m_sizeHasPressure

◆ m_spacing

◆ m_useWashMode