#include <bristle.h>

Public Member Functions
void	addInk (float value)

	Bristle ()=default

	Bristle (float x, float y, float length)

const KoColor &	color () const

int	counter () const

float	distanceCenter ()

bool	enabled () const

float	inkAmount () const

float	length () const

float	prevX () const

float	prevY () const

void	removeInk (float value)

void	setColor (const KoColor &color)

void	setEnabled (bool enabled)

void	setInkAmount (float inkAmount)

void	setLength (float length)

void	setPrevX (float prevX)

void	setPrevY (float prevY)

void	setX (float x)

void	setY (float y)

void	upIncrement ()

float	x () const

float	y () const

	~Bristle ()

Private Member Functions
void	init (float x, float y, float length)

Private Attributes
KoColor	m_color

int	m_counter {0}

bool	m_enabled {true}

float	m_inkAmount {0.0f}

float	m_length {0.0f}

float	m_prevX {0.0f}

float	m_prevY {0.0f}

float	m_x {0.0f}

float	m_y {0.0f}

Detailed Description

Definition at line 13 of file bristle.h.

Constructor & Destructor Documentation

◆ Bristle() [1/2]

Bristle::Bristle ( )

default

◆ Bristle() [2/2]

Bristle::Bristle	(	float	x,
		float	y,
		float	length )

Definition at line 9 of file bristle.cpp.

    : m_x(x)
    , m_y(y)
    , m_prevX(x)
    , m_prevY(y)
    , m_length(length)
{}

◆ ~Bristle()

Bristle::~Bristle ( )

Definition at line 17 of file bristle.cpp.

18{

19}

Member Function Documentation

◆ addInk()

void Bristle::addInk ( float value )

Definition at line 27 of file bristle.cpp.

{
    m_inkAmount = m_inkAmount + value;
}

References m_inkAmount, and value().

◆ color()

const KoColor & Bristle::color ( ) const

inline

Definition at line 41 of file bristle.h.

                                         {
        return m_color;
    }

References m_color.

◆ counter()

int Bristle::counter ( ) const

inline

Definition at line 45 of file bristle.h.

                               {
        return m_counter;
    }

References m_counter.

◆ distanceCenter()

float Bristle::distanceCenter ( )

inline

Definition at line 57 of file bristle.h.

                                  {
        return std::sqrt(m_x * m_x + m_y * m_y);
    }

References m_x, and m_y.

◆ enabled()

bool Bristle::enabled ( ) const

inline

Definition at line 76 of file bristle.h.

                                {
        return m_enabled;
    }

References m_enabled.

◆ init()

void Bristle::init	(	float	x,
		float	y,
		float	length )

private

◆ inkAmount()

float Bristle::inkAmount ( ) const

inline

Definition at line 53 of file bristle.h.

                                   {
        return m_inkAmount;
    };

References m_inkAmount.

◆ length()

float Bristle::length ( ) const

inline

Definition at line 37 of file bristle.h.

                                {
        return m_length;
    }

References m_length.

◆ prevX()

float Bristle::prevX ( ) const

inline

Definition at line 29 of file bristle.h.

                               {
        return m_prevX;
    }

References m_prevX.

◆ prevY()

float Bristle::prevY ( ) const

inline

Definition at line 33 of file bristle.h.

                               {
        return m_prevY;
    }

References m_prevY.

◆ removeInk()

void Bristle::removeInk ( float value )

Definition at line 32 of file bristle.cpp.

{
    m_inkAmount = m_inkAmount - value;
}

References m_inkAmount, and value().

◆ setColor()

void Bristle::setColor ( const KoColor & color )

Definition at line 49 of file bristle.cpp.

{
    m_color = color;
}

References color(), and m_color.

◆ setEnabled()

void Bristle::setEnabled ( bool enabled )

Definition at line 55 of file bristle.cpp.

{
    m_enabled = enabled;
}

References enabled(), and m_enabled.

◆ setInkAmount()

void Bristle::setInkAmount ( float inkAmount )

Definition at line 37 of file bristle.cpp.

{
    if (inkAmount > 1.0f) {
        inkAmount = 1.0f;
    }
    else if (inkAmount < -1.0f) {
        inkAmount = -1.0f;
    }
 
    m_inkAmount = inkAmount;
}

References inkAmount(), and m_inkAmount.

◆ setLength()

void Bristle::setLength ( float length )

Definition at line 21 of file bristle.cpp.

{
    m_length = length;
}

References length(), and m_length.

◆ setPrevX()

void Bristle::setPrevX ( float prevX )

inline

Definition at line 68 of file bristle.h.

                                      {
        m_prevX = prevX;
    }

References m_prevX, and prevX().

◆ setPrevY()

void Bristle::setPrevY ( float prevY )

inline

Definition at line 72 of file bristle.h.

                                      {
        m_prevY = prevY;
    }

References m_prevY, and prevY().

◆ setX()

void Bristle::setX ( float x )

inline

Definition at line 61 of file bristle.h.

                              {
        m_x = x;
    }

References m_x, and x().

◆ setY()

void Bristle::setY ( float y )

inline

Definition at line 64 of file bristle.h.

                              {
        m_y = y;
    }

References m_y, and y().

◆ upIncrement()

void Bristle::upIncrement ( )

inline

Definition at line 49 of file bristle.h.

                              {
        m_counter++;
    }

References m_counter.

◆ x()

float Bristle::x ( ) const

inline

Definition at line 21 of file bristle.h.

                           {
        return m_x;
    }

References m_x.

◆ y()

float Bristle::y ( ) const

inline

Definition at line 25 of file bristle.h.

                           {
        return m_y;
    }

References m_y.

Member Data Documentation

◆ m_color

KoColor Bristle::m_color

private

Definition at line 98 of file bristle.h.

◆ m_counter

int Bristle::m_counter {0}

private

Definition at line 102 of file bristle.h.

102{0};

◆ m_enabled

bool Bristle::m_enabled {true}

private

Definition at line 104 of file bristle.h.

104{true};

◆ m_inkAmount

float Bristle::m_inkAmount {0.0f}

private

Definition at line 99 of file bristle.h.

99{0.0f};

◆ m_length

float Bristle::m_length {0.0f}

private

Definition at line 97 of file bristle.h.

97{0.0f}; // z - coordinate

◆ m_prevX

float Bristle::m_prevX {0.0f}

private

Definition at line 95 of file bristle.h.

95{0.0f};

◆ m_prevY

float Bristle::m_prevY {0.0f}

private

Definition at line 96 of file bristle.h.

96{0.0f};

◆ m_x

float Bristle::m_x {0.0f}

private

Definition at line 93 of file bristle.h.

93{0.0f};

◆ m_y

float Bristle::m_y {0.0f}

private

Definition at line 94 of file bristle.h.

94{0.0f};

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

plugins/paintops/hairy/bristle.h
plugins/paintops/hairy/bristle.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Bristle() [1/2]

◆ Bristle() [2/2]

◆ ~Bristle()

Member Function Documentation

◆ addInk()

◆ color()

◆ counter()

◆ distanceCenter()

◆ enabled()

◆ init()

◆ inkAmount()

◆ length()

◆ prevX()

◆ prevY()

◆ removeInk()

◆ setColor()

◆ setEnabled()

◆ setInkAmount()

◆ setLength()

◆ setPrevX()

◆ setPrevY()

◆ setX()

◆ setY()

◆ upIncrement()

◆ x()

◆ y()

Member Data Documentation

◆ m_color

◆ m_counter

◆ m_enabled

◆ m_inkAmount

◆ m_length

◆ m_prevX

◆ m_prevY

◆ m_x

◆ m_y