#include <kis_grid_config.h>

Inheritance diagram for KisGridConfig:

Classes
struct	TrigoCache

Public Types
enum	GridType { GRID_RECTANGULAR = 0 , GRID_ISOMETRIC_LEGACY , GRID_ISOMETRIC }

enum	LineTypeInternal { LINE_SOLID = 0 , LINE_DASHED , LINE_DOTTED , LINE_NONE }

Public Member Functions
bool	angleAspectLocked () const

qreal	angleLeft () const

bool	angleLeftActive () const

qreal	angleRight () const

bool	angleRightActive () const

int	cellSize () const

int	cellSpacing () const

QColor	colorMain () const

QColor	colorSubdivision () const

QColor	colorVertical () const

GridType	gridType () const

bool	isDefault () const

	KisGridConfig ()

LineTypeInternal	lineTypeMain () const

LineTypeInternal	lineTypeSubdivision () const

LineTypeInternal	lineTypeVertical () const

bool	loadDynamicDataFromXml (const QDomElement &parent)

void	loadStaticData ()

QPoint	offset () const

bool	offsetActive () const

bool	offsetAspectLocked () const

bool	operator== (const KisGridConfig &rhs) const

QPen	penMain () const

QPen	penSubdivision () const

QPen	penVertical () const

QDomElement	saveDynamicDataToXml (QDomDocument &doc, const QString &tag) const

void	saveStaticData () const

void	setAngleAspectLocked (bool value)

void	setAngleLeft (qreal angle)

void	setAngleLeftActive (bool value)

void	setAngleRight (qreal angle)

void	setAngleRightActive (bool value)

void	setCellSize (int spacing)

void	setCellSpacing (int spacing)

void	setColorMain (const QColor &value)

void	setColorSubdivision (const QColor &value)

void	setColorVertical (const QColor &value)

void	setGridType (GridType type)

void	setLineTypeMain (LineTypeInternal value)

void	setLineTypeSubdivision (LineTypeInternal value)

void	setLineTypeVertical (LineTypeInternal value)

void	setOffset (const QPoint &value)

void	setOffsetActive (bool value)

void	setOffsetAspectLocked (bool value)

void	setShowGrid (bool value)

void	setSnapToGrid (bool value)

void	setSpacing (const QPoint &value)

void	setSpacingAspectLocked (bool value)

void	setSubdivision (int value)

void	setXSpacingActive (bool value)

void	setYSpacingActive (bool value)

bool	showGrid () const

bool	snapToGrid () const

QPoint	spacing () const

bool	spacingAspectLocked () const

int	subdivision () const

void	transform (const QTransform &transform)

TrigoCache	trigoCache () const

bool	xSpacingActive () const

bool	ySpacingActive () const

Static Public Member Functions
static const KisGridConfig &	defaultGrid ()

Private Member Functions
void	updatePenStyle (QPen *pen, QColor color, LineTypeInternal type)

void	updateTrigoCache ()

Private Attributes
bool	m_angleAspectLocked

qreal	m_angleLeft

bool	m_angleLeftActive

qreal	m_angleRight

bool	m_angleRightActive

int	m_cellSize

int	m_cellSpacing

QColor	m_colorIsoVertical

QColor	m_colorMain

QColor	m_colorSubdivision

GridType	m_gridType

LineTypeInternal	m_lineTypeIsoVertical

LineTypeInternal	m_lineTypeMain

LineTypeInternal	m_lineTypeSubdivision

QPoint	m_offset

bool	m_offsetActive

bool	m_offsetAspectLocked

QPen	m_penMain

QPen	m_penSubdivision

QPen	m_penVertical

bool	m_showGrid

bool	m_snapToGrid

QPoint	m_spacing

bool	m_spacingAspectLocked

int	m_subdivision

TrigoCache	m_trigoCache

bool	m_xSpacingActive

bool	m_ySpacingActive

Detailed Description

Definition at line 23 of file kis_grid_config.h.

Member Enumeration Documentation

◆ GridType

enum KisGridConfig::GridType

Enumerator
GRID_RECTANGULAR
GRID_ISOMETRIC_LEGACY
GRID_ISOMETRIC

Definition at line 33 of file kis_grid_config.h.

                  {
        GRID_RECTANGULAR = 0,
        GRID_ISOMETRIC_LEGACY,
        GRID_ISOMETRIC
    };

◆ LineTypeInternal

enum KisGridConfig::LineTypeInternal

Enumerator
LINE_SOLID
LINE_DASHED
LINE_DOTTED
LINE_NONE

Definition at line 26 of file kis_grid_config.h.

                          {
        LINE_SOLID = 0,
        LINE_DASHED,
        LINE_DOTTED,
        LINE_NONE
    };

Constructor & Destructor Documentation

◆ KisGridConfig()

KisGridConfig::KisGridConfig ( )

inline

Definition at line 52 of file kis_grid_config.h.

        : m_showGrid(false),
          m_snapToGrid(false),
          m_spacing(16,16),
          m_xSpacingActive(true),
          m_ySpacingActive(true),
          m_offsetActive(false),
          m_offsetAspectLocked(true),
          m_spacingAspectLocked(true),
          m_angleLeft(45),
          m_angleRight(45),
          m_angleAspectLocked(true),
          m_angleLeftActive(true),
          m_angleRightActive(true),
          m_cellSpacing(30),
          m_cellSize(30),
          m_gridType(GRID_RECTANGULAR),
          m_subdivision(2),
          m_lineTypeMain(LINE_SOLID),
          m_lineTypeSubdivision(LINE_DOTTED),
          m_lineTypeIsoVertical(LINE_DASHED),
          m_colorMain(200, 200, 200, 200),
          m_colorSubdivision(200, 200, 200, 150),
          m_colorIsoVertical(200, 200, 200, 100),
          m_penMain(QPen()),
          m_penSubdivision(QPen()),
          m_penVertical(QPen())
    {
        loadStaticData();
        m_penMain.setWidth(0);
        m_penSubdivision.setWidth(0);
        m_penVertical.setWidth(0);
    }

Member Function Documentation

◆ angleAspectLocked()

bool KisGridConfig::angleAspectLocked ( ) const

inline

Definition at line 240 of file kis_grid_config.h.

                                   {
        return m_angleAspectLocked;
    }

◆ angleLeft()

qreal KisGridConfig::angleLeft ( ) const

inline

Definition at line 171 of file kis_grid_config.h.

                            {
        return m_angleLeft;
    }

◆ angleLeftActive()

bool KisGridConfig::angleLeftActive ( ) const

inline

Definition at line 188 of file kis_grid_config.h.

                                 {
        return m_angleLeftActive;
    }

◆ angleRight()

qreal KisGridConfig::angleRight ( ) const

inline

Definition at line 179 of file kis_grid_config.h.

                             {
        return m_angleRight;
    }

◆ angleRightActive()

bool KisGridConfig::angleRightActive ( ) const

inline

Definition at line 196 of file kis_grid_config.h.

                                  {
        return m_angleRightActive;
    }

◆ cellSize()

int KisGridConfig::cellSize ( ) const

inline

Definition at line 211 of file kis_grid_config.h.

                         {
        return m_cellSize;
    }

◆ cellSpacing()

int KisGridConfig::cellSpacing ( ) const

inline

Definition at line 204 of file kis_grid_config.h.

                            {
        return m_cellSpacing;
    }

◆ colorMain()

QColor KisGridConfig::colorMain ( ) const

inline

Definition at line 274 of file kis_grid_config.h.

                             {
        return m_colorMain;
    }

◆ colorSubdivision()

QColor KisGridConfig::colorSubdivision ( ) const

inline

Definition at line 282 of file kis_grid_config.h.

                                    {
        return m_colorSubdivision;
    }

◆ colorVertical()

QColor KisGridConfig::colorVertical ( ) const

inline

Definition at line 290 of file kis_grid_config.h.

                                 {
        return m_colorIsoVertical;
    }

◆ defaultGrid()

const KisGridConfig & KisGridConfig::defaultGrid ( )

static

Definition at line 23 of file kis_grid_config.cpp.

{
    staticDefaultObject->loadStaticData();
    return *staticDefaultObject;
}

References loadStaticData().

◆ gridType()

GridType KisGridConfig::gridType ( ) const

inline

Definition at line 219 of file kis_grid_config.h.

                              {
        return m_gridType;
    }

◆ isDefault()

bool KisGridConfig::isDefault ( ) const

inline

Definition at line 322 of file kis_grid_config.h.

                           {
        return *this == defaultGrid();
    }

References defaultGrid.

◆ lineTypeMain()

LineTypeInternal KisGridConfig::lineTypeMain ( ) const

inline

Definition at line 247 of file kis_grid_config.h.

                                          {
        return m_lineTypeMain;
    }

◆ lineTypeSubdivision()

LineTypeInternal KisGridConfig::lineTypeSubdivision ( ) const

inline

Definition at line 255 of file kis_grid_config.h.

                                                 {
        return m_lineTypeSubdivision;
    }

◆ lineTypeVertical()

LineTypeInternal KisGridConfig::lineTypeVertical ( ) const

inline

Definition at line 264 of file kis_grid_config.h.

                                              {
        return m_lineTypeIsoVertical;
    }

◆ loadDynamicDataFromXml()

bool KisGridConfig::loadDynamicDataFromXml ( const QDomElement & parent )

Definition at line 115 of file kis_grid_config.cpp.

{
    KisConfig cfg(true);
    bool result = true;
 
    result &= KisDomUtils::loadValue(gridElement, "showGrid", &m_showGrid);
    result &= KisDomUtils::loadValue(gridElement, "snapToGrid", &m_snapToGrid);
    result &= KisDomUtils::loadValue(gridElement, "offset", &m_offset);
    result &= KisDomUtils::loadValue(gridElement, "spacing", &m_spacing);
    result &= KisDomUtils::loadValue(gridElement, "offsetAspectLocked", &m_offsetAspectLocked);
    result &= KisDomUtils::loadValue(gridElement, "spacingAspectLocked", &m_spacingAspectLocked);
    result &= KisDomUtils::loadValue(gridElement, "subdivision", &m_subdivision);
    result &= KisDomUtils::loadValue(gridElement, "angleLeft", &m_angleLeft);
    result &= KisDomUtils::loadValue(gridElement, "angleRight", &m_angleRight);
    result &= KisDomUtils::loadValue(gridElement, "cellSpacing", &m_cellSpacing);
    result &= KisDomUtils::loadValue(gridElement, "gridType", (int*)(&m_gridType));
 
    // following variables may not be present in older files; do not update result variable
    KisDomUtils::loadValue(gridElement, "offsetActive", &m_offsetActive);
    KisDomUtils::loadValue(gridElement, "xSpacingActive", &m_xSpacingActive);
    KisDomUtils::loadValue(gridElement, "ySpacingActive", &m_ySpacingActive);
    KisDomUtils::loadValue(gridElement, "angleLeftActive", &m_angleLeftActive);
    KisDomUtils::loadValue(gridElement, "angleRightActive", &m_angleRightActive);
    KisDomUtils::loadValue(gridElement, "angleAspectLocked", &m_angleAspectLocked);
    KisDomUtils::loadValue(gridElement, "cellSize", &m_cellSize);
 
    int lineTypeMain = cfg.getGridMainStyle();
    KisDomUtils::loadValue(gridElement, "lineTypeMain", &lineTypeMain);
    m_lineTypeMain = LineTypeInternal(lineTypeMain);
 
    int lineTypeSubdivision = cfg.getGridSubdivisionStyle();
    KisDomUtils::loadValue(gridElement, "lineTypeSubdivision", &lineTypeSubdivision);
    m_lineTypeSubdivision = LineTypeInternal(lineTypeSubdivision);
 
    int lineTypeVertical = cfg.getGridIsoVerticalStyle();
    KisDomUtils::loadValue(gridElement, "lineTypeVertical", &lineTypeVertical);
    m_lineTypeIsoVertical = LineTypeInternal(lineTypeVertical);
 
    m_colorMain = cfg.getGridMainColor();
    KisDomUtils::loadValue(gridElement, "colorMain", &m_colorMain);
 
    m_colorSubdivision = cfg.getGridSubdivisionColor();
    KisDomUtils::loadValue(gridElement, "colorSubdivision", &m_colorSubdivision);
 
    m_colorIsoVertical = cfg.getGridIsoVerticalColor();
    KisDomUtils::loadValue(gridElement, "colorVertical", &m_colorIsoVertical);
 
    updatePenStyle(&m_penMain, m_colorMain, m_lineTypeMain);
    updatePenStyle(&m_penSubdivision, m_colorSubdivision, m_lineTypeSubdivision);
    updatePenStyle(&m_penVertical, m_colorIsoVertical, m_lineTypeIsoVertical);
    updateTrigoCache();
 
    return result;
}

References KisConfig::getGridIsoVerticalColor(), KisConfig::getGridIsoVerticalStyle(), KisConfig::getGridMainColor(), KisConfig::getGridMainStyle(), KisConfig::getGridSubdivisionColor(), KisConfig::getGridSubdivisionStyle(), lineTypeMain(), lineTypeSubdivision(), lineTypeVertical(), KisDomUtils::loadValue(), m_angleAspectLocked, m_angleLeft, m_angleLeftActive, m_angleRight, m_angleRightActive, m_cellSize, m_cellSpacing, m_colorIsoVertical, m_colorMain, m_colorSubdivision, m_gridType, m_lineTypeIsoVertical, m_lineTypeMain, m_lineTypeSubdivision, m_offset, m_offsetActive, m_offsetAspectLocked, m_penMain, m_penSubdivision, m_penVertical, m_showGrid, m_snapToGrid, m_spacing, m_spacingAspectLocked, m_subdivision, m_xSpacingActive, m_ySpacingActive, updatePenStyle(), and updateTrigoCache().

◆ loadStaticData()

void KisGridConfig::loadStaticData ( )

Definition at line 57 of file kis_grid_config.cpp.

{
    KisConfig cfg(true);
 
    m_lineTypeMain = LineTypeInternal(cfg.getGridMainStyle());
    m_lineTypeSubdivision = LineTypeInternal(cfg.getGridSubdivisionStyle());
    m_lineTypeIsoVertical = LineTypeInternal(cfg.getGridIsoVerticalStyle());
 
    m_colorMain = cfg.getGridMainColor();
    m_colorSubdivision = cfg.getGridSubdivisionColor();
    m_colorIsoVertical = cfg.getGridIsoVerticalColor();
 
    m_spacing = cfg.getDefaultGridSpacing();
}

References KisConfig::getDefaultGridSpacing(), KisConfig::getGridIsoVerticalColor(), KisConfig::getGridIsoVerticalStyle(), KisConfig::getGridMainColor(), KisConfig::getGridMainStyle(), KisConfig::getGridSubdivisionColor(), KisConfig::getGridSubdivisionStyle(), m_colorIsoVertical, m_colorMain, m_colorSubdivision, m_lineTypeIsoVertical, m_lineTypeMain, m_lineTypeSubdivision, and m_spacing.

◆ offset()

QPoint KisGridConfig::offset ( ) const

inline

Definition at line 135 of file kis_grid_config.h.

                          {
        return m_offset;
    }

◆ offsetActive()

bool KisGridConfig::offsetActive ( ) const

inline

Definition at line 128 of file kis_grid_config.h.

                              {
        return m_offsetActive;
    }

◆ offsetAspectLocked()

bool KisGridConfig::offsetAspectLocked ( ) const

inline

Definition at line 226 of file kis_grid_config.h.

                                    {
        return m_offsetAspectLocked;
    }

◆ operator==()

bool KisGridConfig::operator== ( const KisGridConfig & rhs ) const

inline

Definition at line 86 of file kis_grid_config.h.

                                                    {
        return
            m_showGrid == rhs.m_showGrid &&
            m_snapToGrid == rhs.m_snapToGrid &&
            m_spacing == rhs.m_spacing &&
            m_xSpacingActive == rhs.m_xSpacingActive &&
            m_ySpacingActive == rhs.m_ySpacingActive &&
            m_offsetActive == rhs.m_offsetActive &&
            m_offset == rhs.m_offset &&
            m_offsetAspectLocked == rhs.m_offsetAspectLocked &&
            m_spacingAspectLocked == rhs.m_spacingAspectLocked &&
            m_angleRight == rhs.m_angleRight &&
            m_angleLeft == rhs.m_angleLeft &&
            m_angleAspectLocked == rhs.m_angleAspectLocked &&
            m_angleLeftActive == rhs.m_angleLeftActive &&
            m_angleRightActive == rhs.m_angleRightActive &&
            m_gridType == rhs.m_gridType &&
            m_cellSpacing == rhs.m_cellSpacing &&
            m_cellSize == rhs.m_cellSize &&
            m_subdivision == rhs.m_subdivision &&
            m_lineTypeMain == rhs.m_lineTypeMain &&
            m_lineTypeSubdivision == rhs.m_lineTypeSubdivision &&
            m_lineTypeIsoVertical == rhs.m_lineTypeIsoVertical &&
            m_colorMain == rhs.m_colorMain &&
            m_colorSubdivision == rhs.m_colorSubdivision &&
            m_colorIsoVertical == rhs.m_colorIsoVertical;
    }

References m_angleAspectLocked, m_angleLeft, m_angleLeftActive, m_angleRight, m_angleRightActive, m_cellSize, m_cellSpacing, m_colorIsoVertical, m_colorMain, m_colorSubdivision, m_gridType, m_lineTypeIsoVertical, m_lineTypeMain, m_lineTypeSubdivision, m_offset, m_offsetActive, m_offsetAspectLocked, m_showGrid, m_snapToGrid, m_spacing, m_spacingAspectLocked, m_subdivision, m_xSpacingActive, and m_ySpacingActive.

◆ penMain()

QPen KisGridConfig::penMain ( ) const

inline

Definition at line 298 of file kis_grid_config.h.

                         {
        return m_penMain;
    }

◆ penSubdivision()

QPen KisGridConfig::penSubdivision ( ) const

inline

Definition at line 302 of file kis_grid_config.h.

                                {
        return m_penSubdivision;
    }

◆ penVertical()

QPen KisGridConfig::penVertical ( ) const

inline

Definition at line 306 of file kis_grid_config.h.

                             {
        return m_penVertical;
    }

◆ saveDynamicDataToXml()

QDomElement KisGridConfig::saveDynamicDataToXml	(	QDomDocument &	doc,
		const QString &	tag ) const

Definition at line 83 of file kis_grid_config.cpp.

{
    QDomElement gridElement = doc.createElement(tag);
    KisDomUtils::saveValue(&gridElement, "showGrid", m_showGrid);
    KisDomUtils::saveValue(&gridElement, "snapToGrid", m_snapToGrid);
    KisDomUtils::saveValue(&gridElement, "offsetActive", m_offsetActive);
    KisDomUtils::saveValue(&gridElement, "offset", m_offset);
    KisDomUtils::saveValue(&gridElement, "spacing", m_spacing);
    KisDomUtils::saveValue(&gridElement, "xSpacingActive", m_xSpacingActive);
    KisDomUtils::saveValue(&gridElement, "ySpacingActive", m_ySpacingActive);
    KisDomUtils::saveValue(&gridElement, "offsetAspectLocked", m_offsetAspectLocked);
    KisDomUtils::saveValue(&gridElement, "spacingAspectLocked", m_spacingAspectLocked);
    KisDomUtils::saveValue(&gridElement, "subdivision", m_subdivision);
    KisDomUtils::saveValue(&gridElement, "angleLeft", m_angleLeft);
    KisDomUtils::saveValue(&gridElement, "angleRight", m_angleRight);
    KisDomUtils::saveValue(&gridElement, "angleLeftActive", m_angleLeftActive);
    KisDomUtils::saveValue(&gridElement, "angleRightActive", m_angleRightActive);
    KisDomUtils::saveValue(&gridElement, "angleAspectLocked", m_angleAspectLocked);
    KisDomUtils::saveValue(&gridElement, "cellSpacing", m_cellSpacing);
    KisDomUtils::saveValue(&gridElement, "cellSize", m_cellSize);
    KisDomUtils::saveValue(&gridElement, "gridType", m_gridType);
 
    KisDomUtils::saveValue(&gridElement, "colorMain", m_colorMain);
    KisDomUtils::saveValue(&gridElement, "colorSubdivision", m_colorSubdivision);
    KisDomUtils::saveValue(&gridElement, "colorVertical", m_colorIsoVertical);
    KisDomUtils::saveValue(&gridElement, "lineTypeMain", m_lineTypeMain);
    KisDomUtils::saveValue(&gridElement, "lineTypeSubdivision", m_lineTypeSubdivision);
    KisDomUtils::saveValue(&gridElement, "lineTypeVertical", m_lineTypeIsoVertical);
 
    return gridElement;
}

References m_angleAspectLocked, m_angleLeft, m_angleLeftActive, m_angleRight, m_angleRightActive, m_cellSize, m_cellSpacing, m_colorIsoVertical, m_colorMain, m_colorSubdivision, m_gridType, m_lineTypeIsoVertical, m_lineTypeMain, m_lineTypeSubdivision, m_offset, m_offsetActive, m_offsetAspectLocked, m_showGrid, m_snapToGrid, m_spacing, m_spacingAspectLocked, m_subdivision, m_xSpacingActive, m_ySpacingActive, and KisDomUtils::saveValue().

◆ saveStaticData()

void KisGridConfig::saveStaticData ( ) const

Definition at line 72 of file kis_grid_config.cpp.

{
    KisConfig cfg(false);
    cfg.setGridMainStyle(m_lineTypeMain);
    cfg.setGridSubdivisionStyle(m_lineTypeSubdivision);
    cfg.setGridIsoVerticalStyle(m_lineTypeIsoVertical);
    cfg.setGridMainColor(m_colorMain);
    cfg.setGridSubdivisionColor(m_colorSubdivision);
    cfg.setGridIsoVerticalColor(m_colorIsoVertical);
}

References m_colorIsoVertical, m_colorMain, m_colorSubdivision, m_lineTypeIsoVertical, m_lineTypeMain, m_lineTypeSubdivision, KisConfig::setGridIsoVerticalColor(), KisConfig::setGridIsoVerticalStyle(), KisConfig::setGridMainColor(), KisConfig::setGridMainStyle(), KisConfig::setGridSubdivisionColor(), and KisConfig::setGridSubdivisionStyle().

◆ setAngleAspectLocked()

void KisGridConfig::setAngleAspectLocked ( bool value )

inline

Definition at line 243 of file kis_grid_config.h.

                                          {
        m_angleAspectLocked = value;
    }

References value().

◆ setAngleLeft()

void KisGridConfig::setAngleLeft ( qreal angle )

inline

Definition at line 174 of file kis_grid_config.h.

                                   {
        m_angleLeft = angle;
        updateTrigoCache();
    }

◆ setAngleLeftActive()

void KisGridConfig::setAngleLeftActive ( bool value )

inline

Definition at line 192 of file kis_grid_config.h.

                                        {
        m_angleLeftActive = value;
    }

References value().

◆ setAngleRight()

void KisGridConfig::setAngleRight ( qreal angle )

inline

Definition at line 183 of file kis_grid_config.h.

                                    {
        m_angleRight = angle;
        updateTrigoCache();
    }

◆ setAngleRightActive()

void KisGridConfig::setAngleRightActive ( bool value )

inline

Definition at line 200 of file kis_grid_config.h.

                                         {
        m_angleRightActive = value;
    }

References value().

◆ setCellSize()

void KisGridConfig::setCellSize ( int spacing )

inline

Definition at line 214 of file kis_grid_config.h.

                                  {
        m_cellSize = spacing;
        updateTrigoCache();
    }

◆ setCellSpacing()

void KisGridConfig::setCellSpacing ( int spacing )

inline

Definition at line 207 of file kis_grid_config.h.

                                     {
        m_cellSpacing = spacing;
    }

◆ setColorMain()

void KisGridConfig::setColorMain ( const QColor & value )

inline

Definition at line 277 of file kis_grid_config.h.

                                           {
        m_colorMain = value;
        updatePenStyle(&m_penMain, m_colorMain, m_lineTypeMain);
    }

References value().

◆ setColorSubdivision()

void KisGridConfig::setColorSubdivision ( const QColor & value )

inline

Definition at line 285 of file kis_grid_config.h.

                                                  {
        m_colorSubdivision = value;
        updatePenStyle(&m_penSubdivision, m_colorSubdivision, m_lineTypeSubdivision);
    }

References value().

◆ setColorVertical()

void KisGridConfig::setColorVertical ( const QColor & value )

inline

Definition at line 293 of file kis_grid_config.h.

                                               {
        m_colorIsoVertical = value;
        updatePenStyle(&m_penVertical, m_colorIsoVertical, m_lineTypeIsoVertical);
    }

References value().

◆ setGridType()

void KisGridConfig::setGridType ( GridType type )

inline

Definition at line 222 of file kis_grid_config.h.

                                    {
        m_gridType = type;
    }

◆ setLineTypeMain()

void KisGridConfig::setLineTypeMain ( LineTypeInternal value )

inline

Definition at line 250 of file kis_grid_config.h.

                                                 {
        m_lineTypeMain = value;
        updatePenStyle(&m_penMain, m_colorMain, m_lineTypeMain);
    }

References value().

◆ setLineTypeSubdivision()

void KisGridConfig::setLineTypeSubdivision ( LineTypeInternal value )

inline

Definition at line 259 of file kis_grid_config.h.

                                                        {
        m_lineTypeSubdivision = value;
        updatePenStyle(&m_penSubdivision, m_colorSubdivision, m_lineTypeSubdivision);
    }

References value().

◆ setLineTypeVertical()

void KisGridConfig::setLineTypeVertical ( LineTypeInternal value )

inline

Definition at line 268 of file kis_grid_config.h.

                                                     {
        m_lineTypeIsoVertical= value;
        updatePenStyle(&m_penVertical, m_colorIsoVertical, m_lineTypeIsoVertical);
        updateTrigoCache();
    }

References value().

◆ setOffset()

void KisGridConfig::setOffset ( const QPoint & value )

inline

Definition at line 138 of file kis_grid_config.h.

                                        {
        m_offset = value;
        updateTrigoCache();
    }

References value().

◆ setOffsetActive()

void KisGridConfig::setOffsetActive ( bool value )

inline

Definition at line 131 of file kis_grid_config.h.

                                     {
        m_offsetActive = value;
    }

References value().

◆ setOffsetAspectLocked()

void KisGridConfig::setOffsetAspectLocked ( bool value )

inline

Definition at line 229 of file kis_grid_config.h.

                                           {
        m_offsetAspectLocked = value;
    }

References value().

◆ setShowGrid()

void KisGridConfig::setShowGrid ( bool value )

inline

Definition at line 117 of file kis_grid_config.h.

                                 {
        m_showGrid = value;
    }

References value().

◆ setSnapToGrid()

void KisGridConfig::setSnapToGrid ( bool value )

inline

Definition at line 124 of file kis_grid_config.h.

                                   {
        m_snapToGrid = value;
    }

References value().

◆ setSpacing()

void KisGridConfig::setSpacing ( const QPoint & value )

inline

Definition at line 146 of file kis_grid_config.h.

                                         {
        m_spacing = value;
    }

References value().

◆ setSpacingAspectLocked()

void KisGridConfig::setSpacingAspectLocked ( bool value )

inline

Definition at line 236 of file kis_grid_config.h.

                                            {
        m_spacingAspectLocked = value;
    }

References value().

◆ setSubdivision()

void KisGridConfig::setSubdivision ( int value )

inline

Definition at line 167 of file kis_grid_config.h.

                                   {
        m_subdivision = value;
    }

References value().

◆ setXSpacingActive()

void KisGridConfig::setXSpacingActive ( bool value )

inline

Definition at line 153 of file kis_grid_config.h.

                                       {
        m_xSpacingActive = value;
    }

References value().

◆ setYSpacingActive()

void KisGridConfig::setYSpacingActive ( bool value )

inline

Definition at line 160 of file kis_grid_config.h.

                                       {
        m_ySpacingActive = value;
    }

References value().

◆ showGrid()

bool KisGridConfig::showGrid ( ) const

inline

Definition at line 114 of file kis_grid_config.h.

                          {
        return m_showGrid;
    }

◆ snapToGrid()

bool KisGridConfig::snapToGrid ( ) const

inline

Definition at line 121 of file kis_grid_config.h.

                            {
        return m_snapToGrid;
    }

◆ spacing()

QPoint KisGridConfig::spacing ( ) const

inline

Definition at line 143 of file kis_grid_config.h.

                           {
        return m_spacing;
    }

◆ spacingAspectLocked()

bool KisGridConfig::spacingAspectLocked ( ) const

inline

Definition at line 233 of file kis_grid_config.h.

                                     {
        return m_spacingAspectLocked;
    }

◆ subdivision()

int KisGridConfig::subdivision ( ) const

inline

Definition at line 164 of file kis_grid_config.h.

                            {
        return m_subdivision;
    }

◆ transform()

void KisGridConfig::transform ( const QTransform & transform )

Transform the grids using the given transform. Please note that transform should be in 'image' coordinate system. Used with image-wide transformations.

Definition at line 29 of file kis_grid_config.cpp.

{
    if (transform.type() >= QTransform::TxShear) return;
 
    KisAlgebra2D::DecomposedMatrix m(transform);
 
    if (m_gridType == GRID_RECTANGULAR) {
        QTransform t = m.scaleTransform();
 
        const qreal eps = 1e-3;
        const qreal wrappedRotation = KisAlgebra2D::wrapValue(m.angle, 90.0);
        if (wrappedRotation <= eps || wrappedRotation >= 90.0 - eps) {
            t *= m.rotateTransform();
        }
 
        m_spacing = KisAlgebra2D::abs(t.map(m_spacing));
        // Transform map may round spacing down to 0, but it must be at least 1
        m_spacing.setX(qMax(1, m_spacing.x()));
        m_spacing.setY(qMax(1, m_spacing.y()));
 
    } else if (m_gridType == GRID_ISOMETRIC_LEGACY) {
        if (qFuzzyCompare(m.scaleX, m.scaleY)) {
            m_cellSpacing = qRound(qAbs(m_cellSpacing * m.scaleX));
        }
    }
    m_offset = KisAlgebra2D::wrapValue(transform.map(m_offset), m_spacing);
}

References KisAlgebra2D::abs(), KisAlgebra2D::DecomposedMatrix::angle, eps, GRID_ISOMETRIC_LEGACY, GRID_RECTANGULAR, m_cellSpacing, m_gridType, m_offset, m_spacing, qFuzzyCompare(), KisAlgebra2D::DecomposedMatrix::rotateTransform(), KisAlgebra2D::DecomposedMatrix::scaleTransform(), KisAlgebra2D::DecomposedMatrix::scaleX, KisAlgebra2D::DecomposedMatrix::scaleY, transform(), and KisAlgebra2D::wrapValue().

◆ trigoCache()

TrigoCache KisGridConfig::trigoCache ( ) const

inline

Definition at line 310 of file kis_grid_config.h.

                                  {
        return m_trigoCache;
    }

◆ updatePenStyle()

void KisGridConfig::updatePenStyle	(	QPen *	pen,
		QColor	color,
		LineTypeInternal	type )

private

Definition at line 170 of file kis_grid_config.cpp.

{
    pen->setColor(color);
 
    if (type == LINE_DASHED) {
        QVector<qreal> dashes;
        dashes << 5 << 5;
        pen->setDashPattern(dashes);
    } else if (type == LINE_DOTTED) {
        pen->setStyle(Qt::DotLine);
    } else if (type == LINE_NONE) {
        pen->setStyle(Qt::NoPen);
    } else {
        // assume it's SOLID by default
        pen->setStyle(Qt::SolidLine);
    }
}

References LINE_DASHED, LINE_DOTTED, and LINE_NONE.

◆ updateTrigoCache()

void KisGridConfig::updateTrigoCache ( )

private

Definition at line 188 of file kis_grid_config.cpp.

{
    // Here some variable needed to render grid that can be calculated when grid settings in done, instead
    // of doing recalculation on every canvas refresh
    const qreal cosAngleRight = qCos(qDegreesToRadians(m_angleRight));
    const qreal cosAngleLeft = qCos(qDegreesToRadians(m_angleLeft));
 
    m_trigoCache.tanAngleRight = qTan(qDegreesToRadians(m_angleRight));
    m_trigoCache.correctedAngleRightCellSize = m_cellSize * (qSin(qDegreesToRadians(m_angleLeft)) + cosAngleLeft * m_trigoCache.tanAngleRight);
    if (m_angleRight > 0.0) {
        m_trigoCache.correctedAngleRightOffsetX = m_offset.x() * m_trigoCache.tanAngleRight;
    } else {
        m_trigoCache.correctedAngleRightOffsetX = m_offset.x();
    }
 
    m_trigoCache.tanAngleLeft = qTan(qDegreesToRadians(m_angleLeft));
    m_trigoCache.correctedAngleLeftCellSize = m_cellSize * (qSin(qDegreesToRadians(m_angleRight)) + cosAngleRight * m_trigoCache.tanAngleLeft);
    if (m_angleLeft > 0.0) {
        m_trigoCache.correctedAngleLeftOffsetX = m_offset.x() * m_trigoCache.tanAngleLeft;
    } else {
        m_trigoCache.correctedAngleLeftOffsetX = m_offset.x();
    }
 
    if (m_angleRight == m_angleLeft && m_lineTypeIsoVertical != LINE_NONE) {
        m_trigoCache.verticalSpace = m_subdivision * m_cellSize * (cosAngleLeft + cosAngleRight) / 2;
    } else {
        // allow vertical grid line only if angle left and right are the same
        m_trigoCache.verticalSpace = 0;
    }
}

References KisGridConfig::TrigoCache::correctedAngleLeftCellSize, KisGridConfig::TrigoCache::correctedAngleLeftOffsetX, KisGridConfig::TrigoCache::correctedAngleRightCellSize, KisGridConfig::TrigoCache::correctedAngleRightOffsetX, LINE_NONE, m_angleLeft, m_angleRight, m_cellSize, m_lineTypeIsoVertical, m_offset, m_subdivision, m_trigoCache, KisGridConfig::TrigoCache::tanAngleLeft, KisGridConfig::TrigoCache::tanAngleRight, and KisGridConfig::TrigoCache::verticalSpace.

◆ xSpacingActive()

bool KisGridConfig::xSpacingActive ( ) const

inline

Definition at line 150 of file kis_grid_config.h.

                                {
        return m_xSpacingActive;
    }

◆ ySpacingActive()

bool KisGridConfig::ySpacingActive ( ) const

inline

Definition at line 157 of file kis_grid_config.h.

                                {
        return m_ySpacingActive;
    }

Member Data Documentation

◆ m_angleAspectLocked

bool KisGridConfig::m_angleAspectLocked

private

Definition at line 348 of file kis_grid_config.h.

◆ m_angleLeft

qreal KisGridConfig::m_angleLeft

private

Definition at line 346 of file kis_grid_config.h.

◆ m_angleLeftActive

bool KisGridConfig::m_angleLeftActive

private

Definition at line 349 of file kis_grid_config.h.

◆ m_angleRight

qreal KisGridConfig::m_angleRight

private

Definition at line 347 of file kis_grid_config.h.

◆ m_angleRightActive

bool KisGridConfig::m_angleRightActive

private

Definition at line 350 of file kis_grid_config.h.

◆ m_cellSize

int KisGridConfig::m_cellSize

private

Definition at line 352 of file kis_grid_config.h.

◆ m_cellSpacing

int KisGridConfig::m_cellSpacing

private

Definition at line 351 of file kis_grid_config.h.

◆ m_colorIsoVertical

QColor KisGridConfig::m_colorIsoVertical

private

Definition at line 367 of file kis_grid_config.h.

◆ m_colorMain

QColor KisGridConfig::m_colorMain

private

Definition at line 365 of file kis_grid_config.h.

◆ m_colorSubdivision

QColor KisGridConfig::m_colorSubdivision

private

Definition at line 366 of file kis_grid_config.h.

◆ m_gridType

GridType KisGridConfig::m_gridType

private

Definition at line 354 of file kis_grid_config.h.

◆ m_lineTypeIsoVertical

LineTypeInternal KisGridConfig::m_lineTypeIsoVertical

private

Definition at line 363 of file kis_grid_config.h.

◆ m_lineTypeMain

LineTypeInternal KisGridConfig::m_lineTypeMain

private

Definition at line 361 of file kis_grid_config.h.

◆ m_lineTypeSubdivision

LineTypeInternal KisGridConfig::m_lineTypeSubdivision

private

Definition at line 362 of file kis_grid_config.h.

◆ m_offset

QPoint KisGridConfig::m_offset

private

Definition at line 357 of file kis_grid_config.h.

◆ m_offsetActive

bool KisGridConfig::m_offsetActive

private

Definition at line 343 of file kis_grid_config.h.

◆ m_offsetAspectLocked

bool KisGridConfig::m_offsetAspectLocked

private

Definition at line 344 of file kis_grid_config.h.

◆ m_penMain

QPen KisGridConfig::m_penMain

private

Definition at line 369 of file kis_grid_config.h.

◆ m_penSubdivision

QPen KisGridConfig::m_penSubdivision

private

Definition at line 370 of file kis_grid_config.h.

◆ m_penVertical

QPen KisGridConfig::m_penVertical

private

Definition at line 371 of file kis_grid_config.h.

◆ m_showGrid

bool KisGridConfig::m_showGrid

private

Definition at line 338 of file kis_grid_config.h.

◆ m_snapToGrid

bool KisGridConfig::m_snapToGrid

private

Definition at line 339 of file kis_grid_config.h.

◆ m_spacing

QPoint KisGridConfig::m_spacing

private

Definition at line 340 of file kis_grid_config.h.

◆ m_spacingAspectLocked

bool KisGridConfig::m_spacingAspectLocked

private

Definition at line 345 of file kis_grid_config.h.

◆ m_subdivision

int KisGridConfig::m_subdivision

private

Definition at line 355 of file kis_grid_config.h.

◆ m_trigoCache

TrigoCache KisGridConfig::m_trigoCache

private

Definition at line 373 of file kis_grid_config.h.

◆ m_xSpacingActive

bool KisGridConfig::m_xSpacingActive

private

Definition at line 341 of file kis_grid_config.h.

◆ m_ySpacingActive

bool KisGridConfig::m_ySpacingActive

private

Definition at line 342 of file kis_grid_config.h.

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

libs/ui/canvas/kis_grid_config.h
libs/ui/canvas/kis_grid_config.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ GridType

◆ LineTypeInternal

Constructor & Destructor Documentation

◆ KisGridConfig()

Member Function Documentation

◆ angleAspectLocked()

◆ angleLeft()

◆ angleLeftActive()

◆ angleRight()

◆ angleRightActive()

◆ cellSize()

◆ cellSpacing()

◆ colorMain()

◆ colorSubdivision()

◆ colorVertical()

◆ defaultGrid()

◆ gridType()

◆ isDefault()

◆ lineTypeMain()

◆ lineTypeSubdivision()

◆ lineTypeVertical()

◆ loadDynamicDataFromXml()

◆ loadStaticData()

◆ offset()

◆ offsetActive()

◆ offsetAspectLocked()

◆ operator==()

◆ penMain()

◆ penSubdivision()

◆ penVertical()

◆ saveDynamicDataToXml()

◆ saveStaticData()

◆ setAngleAspectLocked()

◆ setAngleLeft()

◆ setAngleLeftActive()

◆ setAngleRight()

◆ setAngleRightActive()

◆ setCellSize()

◆ setCellSpacing()

◆ setColorMain()

◆ setColorSubdivision()

◆ setColorVertical()

◆ setGridType()

◆ setLineTypeMain()

◆ setLineTypeSubdivision()

◆ setLineTypeVertical()

◆ setOffset()

◆ setOffsetActive()

◆ setOffsetAspectLocked()

◆ setShowGrid()

◆ setSnapToGrid()

◆ setSpacing()

◆ setSpacingAspectLocked()

◆ setSubdivision()

◆ setXSpacingActive()

◆ setYSpacingActive()

◆ showGrid()

◆ snapToGrid()

◆ spacing()

◆ spacingAspectLocked()

◆ subdivision()

◆ transform()

◆ trigoCache()

◆ updatePenStyle()

◆ updateTrigoCache()

◆ xSpacingActive()

◆ ySpacingActive()

Member Data Documentation

◆ m_angleAspectLocked

◆ m_angleLeft

◆ m_angleLeftActive

◆ m_angleRight