KisLiquifyProperties Class Reference

#include <kis_liquify_properties.h>

Inheritance diagram for KisLiquifyProperties:

Public Types
enum	LiquifyMode {   MOVE , SCALE , ROTATE , OFFSET ,   UNDO , RESTORE_SHAPE , 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	preserveShapeRotation () const
bool	preserveShapeScale () const
bool	preserveShapeStretch () const
bool	reverseDirection () const
void	saveMode () const
void	setAmount (qreal value)
void	setAmountHasPressure (bool value)
void	setFlow (qreal value)
void	setMode (LiquifyMode value)
void	setPreserveShapeRotation (bool value)
void	setPreserveShapeScale (bool value)
void	setPreserveShapeStretch (bool 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 ()
static bool	supportsReverseDirection (LiquifyMode mode)
static bool	supportsWashMode (LiquifyMode mode)

Private Attributes
qreal	m_amount
bool	m_amountHasPressure
qreal	m_flow
LiquifyMode	m_mode
bool	m_preserveShapeRotation
bool	m_preserveShapeScale
bool	m_preserveShapeStretch
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
RESTORE_SHAPE
N_MODES

Definition at line 21 of file kis_liquify_properties.h.

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

Constructor & Destructor Documentation

KisLiquifyProperties() [1/2]

KisLiquifyProperties::KisLiquifyProperties ( )

inline

Definition at line 32 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),
          m_preserveShapeRotation(true),
          m_preserveShapeScale(true),
          m_preserveShapeStretch(false)
    {
    }

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;
    m_preserveShapeRotation = rhs.m_preserveShapeRotation;
    m_preserveShapeScale = rhs.m_preserveShapeScale;
    m_preserveShapeStretch = rhs.m_preserveShapeStretch;
}

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

Member Function Documentation

amount()

qreal KisLiquifyProperties::amount ( ) const

inline

Definition at line 80 of file kis_liquify_properties.h.

                         {
        return m_amount;
    }

amountHasPressure()

bool KisLiquifyProperties::amountHasPressure ( ) const

inline

Definition at line 101 of file kis_liquify_properties.h.

                                   {
        return m_amountHasPressure;
    }

flow()

qreal KisLiquifyProperties::flow ( ) const

inline

Definition at line 122 of file kis_liquify_properties.h.

                       {
        return m_flow;
    }

fromXML()

KisLiquifyProperties KisLiquifyProperties::fromXML ( const QDomElement & e )

static

Definition at line 203 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 if (result && newMode == N_MODES) {
        props.m_mode = RESTORE_SHAPE;
    } else {
        result = false;
    }
 
    if (result) {
        KisDomUtils::loadValue(liqEl, "preserveShapeRotation", &props.m_preserveShapeRotation);
        KisDomUtils::loadValue(liqEl, "preserveShapeScale", &props.m_preserveShapeScale);
        KisDomUtils::loadValue(liqEl, "preserveShapeStretch", &props.m_preserveShapeStretch);
    }
 
    return props;
}

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

loadAndResetMode()

void KisLiquifyProperties::loadAndResetMode

(

)

Definition at line 168 of file kis_liquify_properties.cpp.

{
    KConfigGroup globalCfg =  KSharedConfig::openConfig()->group("LiquifyTool");
    const int loadedMode = globalCfg.readEntry("mode", (int)m_mode);
    if (loadedMode >= 0 && loadedMode < N_MODES) {
        m_mode = (LiquifyMode) loadedMode;
    } else if (loadedMode == N_MODES) {
        m_mode = RESTORE_SHAPE;
    } else {
        m_mode = MOVE;
    }
 
    loadMode();
}

References loadMode(), m_mode, MOVE, N_MODES, and RESTORE_SHAPE.

loadMode()

void KisLiquifyProperties::loadMode

(

)

Definition at line 150 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", defaultAmountForMode(m_mode));
    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);
    m_preserveShapeRotation = cfg.readEntry("preserveShapeRotation", m_preserveShapeRotation);
    m_preserveShapeScale = cfg.readEntry("preserveShapeScale", m_preserveShapeScale);
    m_preserveShapeStretch = cfg.readEntry("preserveShapeStretch", m_preserveShapeStretch);
}

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

maxSize()

static qreal KisLiquifyProperties::maxSize ( )

inlinestatic

Definition at line 76 of file kis_liquify_properties.h.

                           {
        return 1000.0;
    }

minSize()

static qreal KisLiquifyProperties::minSize ( )

inlinestatic

Definition at line 72 of file kis_liquify_properties.h.

                           {
        return 5.0;
    }

mode()

LiquifyMode KisLiquifyProperties::mode ( ) const

inline

Definition at line 55 of file kis_liquify_properties.h.

                             {
        return m_mode;
    }

operator=()

KisLiquifyProperties & KisLiquifyProperties::operator=

(

const KisLiquifyProperties &

rhs

)

Definition at line 34 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;
    m_preserveShapeRotation = rhs.m_preserveShapeRotation;
    m_preserveShapeScale = rhs.m_preserveShapeScale;
    m_preserveShapeStretch = rhs.m_preserveShapeStretch;
 
    return *this;
}

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

operator==()

bool KisLiquifyProperties::operator==

(

const KisLiquifyProperties &

other

)

const

Definition at line 52 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 &&
        m_preserveShapeRotation == other.m_preserveShapeRotation &&
        m_preserveShapeScale == other.m_preserveShapeScale &&
        m_preserveShapeStretch == other.m_preserveShapeStretch;
}

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

preserveShapeRotation()

bool KisLiquifyProperties::preserveShapeRotation ( ) const

inline

Definition at line 129 of file kis_liquify_properties.h.

                                       {
        return m_preserveShapeRotation;
    }

preserveShapeScale()

bool KisLiquifyProperties::preserveShapeScale ( ) const

inline

Definition at line 136 of file kis_liquify_properties.h.

                                    {
        return m_preserveShapeScale;
    }

preserveShapeStretch()

bool KisLiquifyProperties::preserveShapeStretch ( ) const

inline

Definition at line 143 of file kis_liquify_properties.h.

                                      {
        return m_preserveShapeStretch;
    }

reverseDirection()

bool KisLiquifyProperties::reverseDirection ( ) const

inline

Definition at line 108 of file kis_liquify_properties.h.

                                  {
        return m_reverseDirection;
    }

saveMode()

void KisLiquifyProperties::saveMode

(

)

const

Definition at line 129 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);
    cfg.writeEntry("preserveShapeRotation", m_preserveShapeRotation);
    cfg.writeEntry("preserveShapeScale", m_preserveShapeScale);
    cfg.writeEntry("preserveShapeStretch", m_preserveShapeStretch);
 
    KConfigGroup globalCfg =  KSharedConfig::openConfig()->group("LiquifyTool");
    globalCfg.writeEntry("mode", (int)m_mode);
}

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

setAmount()

void KisLiquifyProperties::setAmount ( qreal value )

inline

Definition at line 83 of file kis_liquify_properties.h.

                                {
        m_amount = value;
    }

References value().

setAmountHasPressure()

void KisLiquifyProperties::setAmountHasPressure ( bool value )

inline

Definition at line 104 of file kis_liquify_properties.h.

                                          {
        m_amountHasPressure = value;
    }

References value().

setFlow()

void KisLiquifyProperties::setFlow ( qreal value )

inline

Definition at line 125 of file kis_liquify_properties.h.

                              {
        m_flow = value;
    }

References value().

setMode()

void KisLiquifyProperties::setMode ( LiquifyMode value )

inline

Definition at line 58 of file kis_liquify_properties.h.

                                    {
        m_mode = value;
    }

References value().

setPreserveShapeRotation()

void KisLiquifyProperties::setPreserveShapeRotation ( bool value )

inline

Definition at line 132 of file kis_liquify_properties.h.

                                              {
        m_preserveShapeRotation = value;
    }

References value().

setPreserveShapeScale()

void KisLiquifyProperties::setPreserveShapeScale ( bool value )

inline

Definition at line 139 of file kis_liquify_properties.h.

                                           {
        m_preserveShapeScale = value;
    }

References value().

setPreserveShapeStretch()

void KisLiquifyProperties::setPreserveShapeStretch ( bool value )

inline

Definition at line 146 of file kis_liquify_properties.h.

                                             {
        m_preserveShapeStretch = value;
    }

References value().

setReverseDirection()

void KisLiquifyProperties::setReverseDirection ( bool value )

inline

Definition at line 111 of file kis_liquify_properties.h.

                                         {
        m_reverseDirection = value;
    }

References value().

setSize()

void KisLiquifyProperties::setSize ( qreal value )

inline

Definition at line 68 of file kis_liquify_properties.h.

                              {
        m_size = value;
    }

References value().

setSizeHasPressure()

void KisLiquifyProperties::setSizeHasPressure ( bool value )

inline

Definition at line 97 of file kis_liquify_properties.h.

                                        {
        m_sizeHasPressure = value;
    }

References value().

setSpacing()

void KisLiquifyProperties::setSpacing ( qreal value )

inline

Definition at line 90 of file kis_liquify_properties.h.

                                 {
        m_spacing = value;
    }

References value().

setUseWashMode()

void KisLiquifyProperties::setUseWashMode ( bool value )

inline

Definition at line 118 of file kis_liquify_properties.h.

                                    {
        m_useWashMode = value;
    }

References value().

size()

qreal KisLiquifyProperties::size ( ) const

inline

Definition at line 65 of file kis_liquify_properties.h.

                       {
        return m_size;
    }

sizeHasPressure()

bool KisLiquifyProperties::sizeHasPressure ( ) const

inline

Definition at line 94 of file kis_liquify_properties.h.

                                 {
        return m_sizeHasPressure;
    }

spacing()

qreal KisLiquifyProperties::spacing ( ) const

inline

Definition at line 87 of file kis_liquify_properties.h.

                          {
        return m_spacing;
    }

supportsReverseDirection()

bool KisLiquifyProperties::supportsReverseDirection ( LiquifyMode mode )

static

Definition at line 69 of file kis_liquify_properties.cpp.

{
    return mode != UNDO &&
        mode != RESTORE_SHAPE;
}

References mode(), RESTORE_SHAPE, and UNDO.

supportsWashMode()

bool KisLiquifyProperties::supportsWashMode ( LiquifyMode mode )

static

Definition at line 75 of file kis_liquify_properties.cpp.

{
    return mode != UNDO &&
        mode != RESTORE_SHAPE;
}

References mode(), RESTORE_SHAPE, and UNDO.

toXML()

void KisLiquifyProperties::toXML

(

QDomElement *

e

)

const

Definition at line 183 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);
    KisDomUtils::saveValue(&liqEl, "preserveShapeRotation", m_preserveShapeRotation);
    KisDomUtils::saveValue(&liqEl, "preserveShapeScale", m_preserveShapeScale);
    KisDomUtils::saveValue(&liqEl, "preserveShapeStretch", m_preserveShapeStretch);
}

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

useWashMode()

bool KisLiquifyProperties::useWashMode ( ) const

inline

Definition at line 115 of file kis_liquify_properties.h.

                             {
        return m_useWashMode;
    }

Member Data Documentation

m_amount

qreal KisLiquifyProperties::m_amount

private

Definition at line 161 of file kis_liquify_properties.h.

m_amountHasPressure

bool KisLiquifyProperties::m_amountHasPressure

private

Definition at line 164 of file kis_liquify_properties.h.

m_flow

qreal KisLiquifyProperties::m_flow

private

Definition at line 168 of file kis_liquify_properties.h.

m_mode

LiquifyMode KisLiquifyProperties::m_mode

private

Definition at line 159 of file kis_liquify_properties.h.

m_preserveShapeRotation

bool KisLiquifyProperties::m_preserveShapeRotation

private

Definition at line 169 of file kis_liquify_properties.h.

m_preserveShapeScale

bool KisLiquifyProperties::m_preserveShapeScale

private

Definition at line 170 of file kis_liquify_properties.h.

m_preserveShapeStretch

bool KisLiquifyProperties::m_preserveShapeStretch

private

Definition at line 171 of file kis_liquify_properties.h.

m_reverseDirection

bool KisLiquifyProperties::m_reverseDirection

private

Definition at line 165 of file kis_liquify_properties.h.

m_size

qreal KisLiquifyProperties::m_size

private

Definition at line 160 of file kis_liquify_properties.h.

m_sizeHasPressure

bool KisLiquifyProperties::m_sizeHasPressure

private

Definition at line 163 of file kis_liquify_properties.h.

m_spacing

qreal KisLiquifyProperties::m_spacing

private

Definition at line 162 of file kis_liquify_properties.h.

m_useWashMode

bool KisLiquifyProperties::m_useWashMode

private

Definition at line 167 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