UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Unigine::Tree::Iterator Class

Tree::Iterator.

To use this class, include the UnigineTree.h file.

Unigine::Tree::Iterator Class

Members


KeyType Type Definition

Description

Full declaration:
typedef Key Unigine::Tree< Key, Data >::Iterator::KeyType

DataType Type Definition

Description

Full declaration:
typedef Data Unigine::Tree< Key, Data >::Iterator::DataType


Iterator ()

Default constructor.

Iterator (const Iterator & it)

Copy constructor.

Arguments

  • const Iterator & it - Iterator.

~Iterator ()

Destructor.

UNIGINE_INLINE Iterator & operator= (const Iterator & it)

Assignment operator for the iterator.

Arguments

  • const Iterator & it - Iterator.

UNIGINE_INLINE int operator== (const Iterator & it) const

Check if two iterators are actually the same.

Arguments

  • const Iterator & it - The second iterator.

Return value

Returns 1 if iterators are the same; otherwise, 0 is returned.

UNIGINE_INLINE int operator!= (const Iterator & it) const

Check if two iterators are not the same.

Arguments

  • const Iterator & it - The second iterator.

Return value

Returns 1 if iterators are not the same; otherwise, 0 is returned.

UNIGINE_INLINE int operator== (const typename Tree< Key, Data >::ConstIterator & it) const

Check if two iterators are actually the same.

Arguments

  • const typename Tree< Key, Data >::ConstIterator & it - The second iterator.

Return value

Returns 1 if iterators are the same; otherwise, 0 is returned.

UNIGINE_INLINE int operator!= (const typename Tree< Key, Data >::ConstIterator & it) const

Check if two iterators are not the same.

Arguments

  • const typename Tree< Key, Data >::ConstIterator & it - The second iterator.

Return value

Returns 1 if iterators are not the same; otherwise, 0 is returned.

UNIGINE_INLINE Node & operator* ()

Returns iterator's node reference.

Return value

The iterator's node reference.

UNIGINE_INLINE Node * operator-> ()

Returns iterator's node pointer.

Return value

The iterator's node.

UNIGINE_INLINE Node * get ()

Returns iterator's node pointer.

Return value

The iterator's node pointer.

UNIGINE_INLINE Iterator & operator++ ()

Increases the iterator position.

Return value

The iterator referring to the next element.

UNIGINE_INLINE Iterator & operator-- ()

Decreases the iterator position.

Return value

The iterator referring to the prev element.

UNIGINE_INLINE Iterator operator++ ()

Increases the iterator position.

Return value

The iterator referring to the current element.

UNIGINE_INLINE Iterator operator-- ()

Decreases the iterator position.

Return value

The iterator referring to the current element.
Last update: 2017-07-03