neighbour_iterator Struct Reference

#include <KisMagneticGraph.h>

Inheritance diagram for neighbour_iterator:

Public Member Functions
bool	equal (neighbour_iterator const &that) const
void	increment ()
	neighbour_iterator ()
	neighbour_iterator (VertexDescriptor v, KisMagneticGraph g, VertexDescriptor::Direction d)
std::pair< VertexDescriptor, VertexDescriptor >	operator* () const
void	operator++ ()
bool	operator== (neighbour_iterator const &that) const

Private Attributes
VertexDescriptor::Direction	m_direction {VertexDescriptor::NONE}
KisMagneticGraph	m_graph
VertexDescriptor	m_point

Detailed Description

Definition at line 178 of file KisMagneticGraph.h.

Constructor & Destructor Documentation

neighbour_iterator() [1/2]

neighbour_iterator::neighbour_iterator ( VertexDescriptor v, KisMagneticGraph g, VertexDescriptor::Direction d )

inline

Definition at line 182 of file KisMagneticGraph.h.

                                                                                            :
        m_point(v), m_direction(d), m_graph(g)
    { }

neighbour_iterator() [2/2]

neighbour_iterator::neighbour_iterator ( )

inline

Definition at line 186 of file KisMagneticGraph.h.

    { }

Member Function Documentation

equal()

bool neighbour_iterator::equal ( neighbour_iterator const & that ) const

inline

Definition at line 213 of file KisMagneticGraph.h.

    {
        return operator == (that);
    }

References operator==().

increment()

void neighbour_iterator::increment ( )

inline

Definition at line 218 of file KisMagneticGraph.h.

    {
        operator ++ ();
    }

References operator++().

operator*()

std::pair< VertexDescriptor, VertexDescriptor > neighbour_iterator::operator* ( ) const

inline

Definition at line 189 of file KisMagneticGraph.h.

    {
        std::pair<VertexDescriptor,
                  VertexDescriptor> const result = std::make_pair(m_point, m_point.neighbor(m_direction));
        return result;
    }

References m_direction, m_point, and VertexDescriptor::neighbor().

operator++()

void neighbour_iterator::operator++ ( )

inline

Definition at line 196 of file KisMagneticGraph.h.

    {
        m_direction = static_cast<VertexDescriptor::Direction>(int(m_direction) + 1);
        VertexDescriptor next = m_point.neighbor(m_direction);
        if (m_direction == VertexDescriptor::NONE) {
            return;
        }
        if (!m_graph.m_rect.contains(next.x, next.y)) {
            operator ++ ();
        }
    }

References m_direction, m_graph, m_point, KisMagneticGraph::m_rect, VertexDescriptor::neighbor(), VertexDescriptor::NONE, and operator++().

operator==()

bool neighbour_iterator::operator== ( neighbour_iterator const & that ) const

inline

Definition at line 208 of file KisMagneticGraph.h.

    {
        return m_point == that.m_point && m_direction == that.m_direction;
    }

References m_direction, and m_point.

Member Data Documentation

m_direction

VertexDescriptor::Direction neighbour_iterator::m_direction {VertexDescriptor::NONE}

private

Definition at line 225 of file KisMagneticGraph.h.

{VertexDescriptor::NONE};

m_graph

KisMagneticGraph neighbour_iterator::m_graph

private

Definition at line 226 of file KisMagneticGraph.h.

m_point

VertexDescriptor neighbour_iterator::m_point

private

Definition at line 224 of file KisMagneticGraph.h.

---

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

• plugins/tools/selectiontools/KisMagneticGraph.h