KisBrushModel Namespace Reference

Namespaces
namespace	detail

Classes
struct	AutoBrushData
struct	AutoBrushGeneratorData
struct	BrushData
struct	CommonData
struct	MaskingBrushData
struct	PrecisionData
struct	PredefinedBrushData
struct	TextBrushData

Enumerations
enum	AutoBrushGeneratorShape { Circle = 0 , Rectangle }
enum	AutoBrushGeneratorType { Default = 0 , Soft , Gaussian }
enum	BrushType { Auto = 0 , Predefined , Text }

Functions
KisPaintopLodLimitations	brushLodLimitations (const BrushData &data)
qreal	effectiveSizeForBrush (BrushType type, const AutoBrushData &autoBrush, const PredefinedBrushData &predefinedBrush, const TextBrushData &textBrush)
qreal	effectiveSizeForBrush (const BrushData &brush)
qreal	lightnessModeActivated (BrushType type, const PredefinedBrushData &predefinedBrush)
bool	operator== (const MaskingBrushData &lhs, const MaskingBrushData &rhs)
bool	operator== (const PrecisionData &lhs, const PrecisionData &rhs)
void	setEffectiveSizeForBrush (const BrushType type, AutoBrushData &autoBrush, PredefinedBrushData &predefinedBrush, TextBrushData &textBrush, qreal value)

Enumeration Type Documentation

AutoBrushGeneratorShape

enum KisBrushModel::AutoBrushGeneratorShape

Enumerator
Circle
Rectangle

Definition at line 45 of file KisBrushModel.h.

                             {
    Circle = 0,
    Rectangle
};

AutoBrushGeneratorType

enum KisBrushModel::AutoBrushGeneratorType

Enumerator
Default
Soft
Gaussian

Definition at line 50 of file KisBrushModel.h.

                            {
    Default = 0,
    Soft,
    Gaussian
};

BrushType

enum KisBrushModel::BrushType

Enumerator
Auto
Predefined
Text

Definition at line 143 of file KisBrushModel.h.

               {
    Auto = 0,
    Predefined,
    Text
};

Function Documentation

brushLodLimitations()

KisPaintopLodLimitations BRUSH_EXPORT KisBrushModel::brushLodLimitations

(

const BrushData &

data

)

Definition at line 71 of file KisBrushModel.cpp.

{
    KisPaintopLodLimitations l;
 
    if (!data.common.useAutoSpacing && data.common.spacing > 0.5) {
        l.limitations << KoID("huge-spacing", i18nc("PaintOp instant preview limitation", "Spacing > 0.5, consider disabling Instant Preview"));
    }
 
    if (data.type == Auto) {
        if (!qFuzzyCompare(data.autoBrush.density, 1.0)) {
            l.limitations << KoID("auto-brush-density", i18nc("PaintOp instant preview limitation", "Brush Density recommended value 100.0"));
        }
 
        if (!qFuzzyCompare(data.autoBrush.randomness, 0.0)) {
            l.limitations << KoID("auto-brush-randomness", i18nc("PaintOp instant preview limitation", "Brush Randomness recommended value 0.0"));
        }
    }
 
    return l;
}

References Auto, KisBrushModel::BrushData::autoBrush, KisBrushModel::BrushData::common, KisBrushModel::AutoBrushData::density, KisPaintopLodLimitations::limitations, qFuzzyCompare(), KisBrushModel::AutoBrushData::randomness, KisBrushModel::CommonData::spacing, KisBrushModel::BrushData::type, and KisBrushModel::CommonData::useAutoSpacing.

effectiveSizeForBrush() [1/2]

qreal BRUSH_EXPORT KisBrushModel::effectiveSizeForBrush	(	BrushType	type,
		const AutoBrushData &	autoBrush,
		const PredefinedBrushData &	predefinedBrush,
		const TextBrushData &	textBrush )

Definition at line 92 of file KisBrushModel.cpp.

{
    qreal result = 42;
 
    switch (type) {
    case Auto:
        result = autoBrush.generator.diameter;
        break;
    case Predefined:
        result = predefinedBrush.baseSize.width() * predefinedBrush.scale;
        break;
    case Text:
        result = textBrush.baseSize.width() * textBrush.scale;
        break;
    }
 
    return result;
}

References Auto, KisBrushModel::PredefinedBrushData::baseSize, KisBrushModel::TextBrushData::baseSize, KisBrushModel::AutoBrushGeneratorData::diameter, KisBrushModel::AutoBrushData::generator, Predefined, KisBrushModel::PredefinedBrushData::scale, KisBrushModel::TextBrushData::scale, and Text.

effectiveSizeForBrush() [2/2]

qreal BRUSH_EXPORT KisBrushModel::effectiveSizeForBrush

(

const BrushData &

brush

)

Definition at line 139 of file KisBrushModel.cpp.

{
    return effectiveSizeForBrush(brush.type, brush.autoBrush, brush.predefinedBrush, brush.textBrush);
}

References KisBrushModel::BrushData::autoBrush, effectiveSizeForBrush(), KisBrushModel::BrushData::predefinedBrush, KisBrushModel::BrushData::textBrush, and KisBrushModel::BrushData::type.

lightnessModeActivated()

qreal BRUSH_EXPORT KisBrushModel::lightnessModeActivated	(	BrushType	type,
		const PredefinedBrushData &	predefinedBrush )

Definition at line 114 of file KisBrushModel.cpp.

{
    // TODO: use effectiveApplication instead!!!
    return type == Predefined && predefinedBrush.application == LIGHTNESSMAP;
}

References KisBrushModel::PredefinedBrushData::application, LIGHTNESSMAP, and Predefined.

operator==() [1/2]

bool KisBrushModel::operator==	(	const MaskingBrushData &	lhs,
		const MaskingBrushData &	rhs )

Definition at line 13 of file KisMaskingBrushOptionProperties.cpp.

{
    return lhs.isEnabled == rhs.isEnabled &&
            lhs.brush == rhs.brush &&
            lhs.compositeOpId == rhs.compositeOpId &&
            lhs.useMasterSize == rhs.useMasterSize &&
            qFuzzyCompare(lhs.masterSizeCoeff, rhs.masterSizeCoeff);
}

References KisBrushModel::MaskingBrushData::brush, KisBrushModel::MaskingBrushData::compositeOpId, KisBrushModel::MaskingBrushData::isEnabled, KisBrushModel::MaskingBrushData::masterSizeCoeff, qFuzzyCompare(), and KisBrushModel::MaskingBrushData::useMasterSize.

operator==() [2/2]

bool KisBrushModel::operator==	(	const PrecisionData &	lhs,
		const PrecisionData &	rhs )

Definition at line 57 of file kis_precision_option.cpp.

{
    return lhs.precisionLevel == rhs.precisionLevel &&
            lhs.useAutoPrecision == rhs.useAutoPrecision;
}

setEffectiveSizeForBrush()

void BRUSH_EXPORT KisBrushModel::setEffectiveSizeForBrush	(	const BrushType	type,
		AutoBrushData &	autoBrush,
		PredefinedBrushData &	predefinedBrush,
		TextBrushData &	textBrush,
		qreal	value )

Definition at line 120 of file KisBrushModel.cpp.

{
    switch (type) {
    case Auto:
        autoBrush.generator.diameter = value;
        break;
    case Predefined:
        predefinedBrush.scale = value / predefinedBrush.baseSize.width();
        break;
    case Text:
        textBrush.scale = value / textBrush.baseSize.width();
        break;
    }
}

References Auto, KisBrushModel::PredefinedBrushData::baseSize, KisBrushModel::TextBrushData::baseSize, KisBrushModel::AutoBrushGeneratorData::diameter, KisBrushModel::AutoBrushData::generator, Predefined, KisBrushModel::PredefinedBrushData::scale, KisBrushModel::TextBrushData::scale, Text, and value().