stmm-games-doc  0.32.0
Public Member Functions | Protected Member Functions | List of all members
stmg::Coords::const_iterator Class Reference

Coords iterator. More...

Inheritance diagram for stmg::Coords::const_iterator:
Inheritance graph
[legend]

Public Member Functions

int32_t x () const noexcept
 The current x position. More...
 
int32_t y () const noexcept
 The current y position. More...
 
NPoint point () const noexcept
 The current position. More...
 
void next () noexcept
 Move the iterator to the next coord. More...
 
bool operator== (const const_iterator &it) const noexcept
 Tells whether the iterator point to the same position as another. More...
 
bool operator!= (const const_iterator &it) const noexcept
 Opposite of const_iterator::operator==(). More...
 

Protected Member Functions

int32_t get () const noexcept
 

Detailed Description

Coords iterator.

Member Function Documentation

◆ get()

int32_t stmg::Coords::const_iterator::get ( ) const
inlineprotectednoexcept

◆ next()

void stmg::Coords::const_iterator::next ( )
inlinenoexcept

Move the iterator to the next coord.

◆ operator!=()

bool stmg::Coords::const_iterator::operator!= ( const const_iterator it) const
inlinenoexcept

◆ operator==()

bool stmg::Coords::const_iterator::operator== ( const const_iterator it) const
inlinenoexcept

Tells whether the iterator point to the same position as another.

Parameters
itThe other iterator.
Returns
Whether same position within Coords.

◆ point()

NPoint stmg::Coords::const_iterator::point ( ) const
inlinenoexcept

The current position.

Returns
The position.

◆ x()

int32_t stmg::Coords::const_iterator::x ( ) const
inlinenoexcept

The current x position.

Returns
The x.

◆ y()

int32_t stmg::Coords::const_iterator::y ( ) const
inlinenoexcept

The current y position.

Returns
The y.