VertexDescriptor Struct Reference

#include <KisMagneticGraph.h>

Public Types
enum	Direction {   MIN = 0 , N = MIN , S , E ,   W , NW , NE , SW ,   SE , NONE }

Public Member Functions
VertexDescriptor	neighbor (Direction direction) const
bool	operator!= (VertexDescriptor const &rhs) const
bool	operator< (VertexDescriptor const &rhs) const
bool	operator== (QPoint const &rhs) const
bool	operator== (VertexDescriptor const &rhs) const
	VertexDescriptor ()
	VertexDescriptor (long _x, long _y)
	VertexDescriptor (QPoint pt)

Public Attributes
long	x
long	y

Detailed Description

Definition at line 19 of file KisMagneticGraph.h.

Member Enumeration Documentation

Direction

enum VertexDescriptor::Direction

Enumerator
MIN
N
S
E
W
NW
NE
SW
SE
NONE

Definition at line 22 of file KisMagneticGraph.h.

                   {
        MIN = 0,
        N   = MIN, S, E, W, NW, NE, SW, SE, NONE
    };

Constructor & Destructor Documentation

VertexDescriptor() [1/3]

VertexDescriptor::VertexDescriptor ( long _x, long _y )

inline

Definition at line 27 of file KisMagneticGraph.h.

                                       :
        x(_x), y(_y)
    { }

VertexDescriptor() [2/3]

VertexDescriptor::VertexDescriptor ( QPoint pt )

inline

Definition at line 31 of file KisMagneticGraph.h.

                                :
        x(pt.x()), y(pt.y())
    { }

VertexDescriptor() [3/3]

VertexDescriptor::VertexDescriptor ( )

inline

Definition at line 35 of file KisMagneticGraph.h.

                       :
        x(0), y(0)
    { }

Member Function Documentation

neighbor()

VertexDescriptor VertexDescriptor::neighbor ( Direction direction ) const

inline

Definition at line 61 of file KisMagneticGraph.h.

    {
        int dx = 0, dy = 0;
 
        switch (direction) {
            case W:
                Q_FALLTHROUGH();
            case SW:
                Q_FALLTHROUGH();
            case NW:
                dx = -1;
                break;
            case E:
                Q_FALLTHROUGH();
            case SE:
                Q_FALLTHROUGH();
            case NE:
                dx = 1;
            default:
                ;
        }
 
        switch (direction) {
            case N:
                Q_FALLTHROUGH();
            case NW:
                Q_FALLTHROUGH();
            case NE:
                dy = -1;
                break;
            case S:
                Q_FALLTHROUGH();
            case SW:
                Q_FALLTHROUGH();
            case SE:
                dy = 1;
            default:
                ;
        }
 
        VertexDescriptor const neighbor(x + dx, y + dy);
        return neighbor;
    } // neighbor

References E, N, NE, neighbor(), NW, S, SE, SW, W, x, and y.

operator!=()

bool VertexDescriptor::operator!= ( VertexDescriptor const & rhs ) const

inline

Definition at line 49 of file KisMagneticGraph.h.

    {
        return rhs.x != x || rhs.y != y;
    }

References x, and y.

operator<()

bool VertexDescriptor::operator< ( VertexDescriptor const & rhs ) const

inline

Definition at line 54 of file KisMagneticGraph.h.

    {
        return x < rhs.x || (x == rhs.x && y < rhs.y);
    }

References x, and y.

operator==() [1/2]

bool VertexDescriptor::operator== ( QPoint const & rhs ) const

inline

Definition at line 44 of file KisMagneticGraph.h.

    {
        return rhs.x() == x && rhs.y() == y;
    }

References x, and y.

operator==() [2/2]

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

inline

Definition at line 39 of file KisMagneticGraph.h.

    {
        return rhs.x == x && rhs.y == y;
    }

References x, and y.

Member Data Documentation

x

long VertexDescriptor::x

Definition at line 20 of file KisMagneticGraph.h.

y

long VertexDescriptor::y

Definition at line 20 of file KisMagneticGraph.h.

---

The documentation for this struct was generated from the following file:

• plugins/tools/selectiontools/KisMagneticGraph.h