Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
Inkscape::UI::NodeIterator< N > Class Template Reference

Iterator for editable nodes. More...

#include <node.h>

Inheritance diagram for Inkscape::UI::NodeIterator< N >:

Public Types

using self = NodeIterator
 

Public Member Functions

 NodeIterator ()
 
self & operator++ ()
 
self & operator-- ()
 
bool operator== (self const &other) const
 
N & operator* () const
 
 operator bool () const
 
N * get_pointer () const
 Get a pointer to the underlying node. Equivalent to &*i.
 
N * ptr () const
 
self next () const
 
self prev () const
 
self & advance ()
 
self & retreat ()
 

Private Member Functions

 NodeIterator (ListNode const *n)
 

Private Attributes

ListNode * _node
 

Friends

class NodeList
 

Detailed Description

template<typename N>
class Inkscape::UI::NodeIterator< N >

Iterator for editable nodes.

Use this class for all operations that require some knowledge about the node's neighbors. It is a bidirectional iterator.

Because paths can be cyclic, node iterators have two different ways to increment and decrement them. When using ++/–, the end iterator will eventually be returned. When using advance()/retreat(), the end iterator will only be returned when the path is open. If it's closed, calling advance() will cycle indefinitely. This is particularly useful for cases where the adjacency of nodes is more important than their sequence order.

When i is a node iterator, then:

  • ++i moves the iterator to the next node in sequence order;
  • –i moves the iterator to the previous node in sequence order;
  • i.next() returns the next node with wrap-around;
  • i.prev() returns the previous node with wrap-around;
  • i.advance() moves the iterator to the next node with wrap-around;
  • i.retreat() moves the iterator to the previous node with wrap-around.

next() and prev() do not change their iterator. They can return the end iterator if the path is open.

Unlike most other iterators, you can check whether you've reached the end of the list without having access to the iterator's container. Simply use if (i) { ...

Definition at line 285 of file node.h.

Member Typedef Documentation

◆ self

template<typename N >
using Inkscape::UI::NodeIterator< N >::self = NodeIterator

Definition at line 289 of file node.h.

Constructor & Destructor Documentation

◆ NodeIterator() [1/2]

template<typename N >
Inkscape::UI::NodeIterator< N >::NodeIterator ( )
inline

Definition at line 290 of file node.h.

◆ NodeIterator() [2/2]

template<typename N >
Inkscape::UI::NodeIterator< N >::NodeIterator ( ListNode const *  n)
inlineprivate

Definition at line 325 of file node.h.

Member Function Documentation

◆ advance()

template<typename N >
NodeIterator< N > & Inkscape::UI::NodeIterator< N >::advance ( )

Definition at line 489 of file node.h.

Referenced by Inkscape::UI::NodeIterator< N >::next().

◆ get_pointer()

template<typename N >
N * Inkscape::UI::NodeIterator< N >::get_pointer ( ) const
inline

Get a pointer to the underlying node. Equivalent to &*i.

Definition at line 307 of file node.h.

References Inkscape::UI::NodeIterator< N >::_node, and N.

◆ next()

template<typename N >
self Inkscape::UI::NodeIterator< N >::next ( ) const
inline

Definition at line 311 of file node.h.

References Inkscape::UI::NodeIterator< N >::advance().

Referenced by Inkscape::UI::PathManipulator::_chooseHandle(), Inkscape::UI::PathManipulator::_deleteSegments(), Inkscape::UI::PathManipulator::_deleteStretch(), Inkscape::UI::CurveDragPoint::_getTip(), Inkscape::UI::Node::_linearGrow(), Inkscape::UI::Node::_next(), Inkscape::UI::PathManipulator::_nodeClicked(), Inkscape::UI::PathManipulator::_selectionChanged(), Inkscape::UI::PathManipulator::_updateDragPoint(), Inkscape::UI::CurveDragPoint::clicked(), Inkscape::UI::PathManipulator::deleteNodes(), Inkscape::UI::CurveDragPoint::doubleclicked(), Inkscape::UI::CurveDragPoint::dragged(), Inkscape::UI::PathManipulator::duplicateNodes(), Inkscape::UI::CurveDragPoint::grabbed(), Inkscape::UI::PathManipulator::insertNodeAtExtremum(), Inkscape::UI::PathManipulator::insertNodes(), Inkscape::UI::PathManipulator::setSegmentType(), Inkscape::UI::PathManipulator::subdivideSegment(), Inkscape::UI::PathManipulator::weldNodes(), and Inkscape::UI::PathManipulator::weldSegments().

◆ operator bool()

template<typename N >
Inkscape::UI::NodeIterator< N >::operator bool ( ) const
inline

Definition at line 485 of file node.h.

◆ operator*()

template<typename N >
N & Inkscape::UI::NodeIterator< N >::operator* ( ) const
inline

Definition at line 304 of file node.h.

References Inkscape::UI::NodeIterator< N >::_node, and N.

◆ operator++()

template<typename N >
self & Inkscape::UI::NodeIterator< N >::operator++ ( )
inline

Definition at line 295 of file node.h.

References Inkscape::UI::NodeIterator< N >::_node, and Inkscape::UI::ListNode::ln_next.

◆ operator--()

template<typename N >
self & Inkscape::UI::NodeIterator< N >::operator-- ( )
inline

Definition at line 299 of file node.h.

References Inkscape::UI::NodeIterator< N >::_node, and Inkscape::UI::ListNode::ln_prev.

◆ operator==()

template<typename N >
bool Inkscape::UI::NodeIterator< N >::operator== ( self const &  other) const
inline

Definition at line 303 of file node.h.

References Inkscape::UI::NodeIterator< N >::_node.

◆ prev()

template<typename N >
self Inkscape::UI::NodeIterator< N >::prev ( ) const
inline

Definition at line 316 of file node.h.

References Inkscape::UI::NodeIterator< N >::retreat().

Referenced by Inkscape::UI::PathManipulator::_chooseHandle(), Inkscape::UI::PathManipulator::_deleteSegments(), Inkscape::UI::PathManipulator::_deleteStretch(), Inkscape::UI::Node::_linearGrow(), Inkscape::UI::Node::_prev(), Inkscape::UI::PathManipulator::_selectionChanged(), and Inkscape::UI::PathManipulator::weldSegments().

◆ ptr()

template<typename N >
N * Inkscape::UI::NodeIterator< N >::ptr ( ) const
inline
See also
get_pointer()

Definition at line 309 of file node.h.

References Inkscape::UI::NodeIterator< N >::_node, and N.

Referenced by Inkscape::UI::PathManipulator::_chooseHandle(), Inkscape::UI::PathManipulator::_createGeometryFromControlPoints(), Inkscape::UI::Node::_linearGrow(), Inkscape::UI::Node::_prev(), Inkscape::UI::CurveDragPoint::clicked(), Inkscape::UI::PathManipulator::insertNode(), Inkscape::UI::PathManipulator::insertNodeAtExtremum(), and Inkscape::UI::MultiPathManipulator::shiftSelection().

◆ retreat()

template<typename N >
NodeIterator< N > & Inkscape::UI::NodeIterator< N >::retreat ( )

Definition at line 495 of file node.h.

Referenced by Inkscape::UI::NodeIterator< N >::prev().

Friends And Related Symbol Documentation

◆ NodeList

template<typename N >
friend class NodeList
friend

Definition at line 329 of file node.h.

Member Data Documentation

◆ _node

template<typename N >
ListNode* Inkscape::UI::NodeIterator< N >::_node
private

Definition at line 328 of file node.h.

Referenced by Inkscape::UI::NodeList::before(), Inkscape::UI::NodeList::before(), Inkscape::UI::NodeList::erase(), Inkscape::UI::NodeList::get(), Inkscape::UI::NodeIterator< N >::get_pointer(), Inkscape::UI::NodeList::insert(), Inkscape::UI::NodeIterator< N >::operator*(), Inkscape::UI::NodeIterator< N >::operator++(), Inkscape::UI::NodeIterator< N >::operator--(), Inkscape::UI::NodeIterator< N >::operator==(), Inkscape::UI::NodeIterator< N >::ptr(), and Inkscape::UI::NodeList::splice().

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