ICF 3.1.1.10
Technical documentation of ICF Libraries
istd::CIndex2d Class Reference

Index implementation for addressing elements in 2D-space. More...

#include <CIndex2d.h>

Inheritance diagram for istd::CIndex2d:
Collaboration diagram for istd::CIndex2d:

Public Types

typedef TIndex< 2 > BaseClass
 
- Public Types inherited from istd::TIndex< 2 >
enum  
 
typedef int IndexType
 
typedef int * iterator
 

Public Member Functions

 CIndex2d ()
 
 CIndex2d (int x, int y)
 
 CIndex2d (const TIndex< 2 > &index)
 
 CIndex2d (const QPoint &point)
 
 CIndex2d (const QSize &size)
 
int GetX () const
 
void SetX (int value)
 
int GetY () const
 
void SetY (int value)
 
bool operator< (const CIndex2d &index) const
 
bool operator> (const CIndex2d &index) const
 
bool operator<= (const CIndex2d &index) const
 
bool operator>= (const CIndex2d &index) const
 
 operator QSize () const
 Cast/convert index to QSize object.
 
 operator QPoint () const
 Cast/convert index to QPoint object.
 
 operator QPointF () const
 Cast/convert index to QPointF object.
 
CIndex2doperator= (const CIndex2d &index)
 Assign value from another index.
 
CIndex2doperator= (const TIndex< 2 > &index)
 Assign value from a general defined 2D-index.
 
- Public Member Functions inherited from istd::TIndex< 2 >
 TIndex ()
 Default constructor with initialization of member to 0.
 
 TIndex (int value)
 Constructor initializing all members to specified value.
 
 TIndex (const TIndex &index)
 Copy constructor.
 
bool IsValid () const
 Check if this index is valid.
 
bool IsZero () const
 Check if this index point at zero element.
 
bool IsSizeEmpty () const
 Check if this index interpreted as size is empty.
 
void Reset ()
 Reset this object.
 
void Clear ()
 Set all components to 0.
 
bool IsDimensionsCountFixed () const
 Check, if number dimensions is fixed.
 
int GetDimensionsCount () const
 Get number of dimensions of this index.
 
bool SetDimensionsCount (int count) const
 Set number of dimensions of this index.
 
int GetAt (int index) const
 Get element stored at specified index.
 
void SetAt (int index, int value)
 Set element at specified index.
 
void SetAllTo (int value)
 Set all components to specified value.
 
bool IncreaseAt (int index)
 Increase single component at specified position.
 
bool DecreaseAt (int index)
 Decrease single component at specified position.
 
bool IsInside (const TIndex &boundaries) const
 Check if index is inside boundaries.
 
bool Increase (const TIndex &boundaries)
 Increase this index inside the boundaries.
 
bool Decrease (const TIndex &boundaries)
 Decrease this index inside the boundaries.
 
int GetProductVolume () const
 Get total number of elements if this index is treated as size.
 
int GetIterationIndex (const TIndex &boundaries) const
 Get index of iteration from zero to current index inside some boundaries.
 
iterator Begin () const
 Get begin value of element access iterator.
 
iterator End () const
 Get end value of element access iterator.
 
int operator[] (int index) const
 
int & operator[] (int index)
 
bool operator== (const TIndex &index) const
 
bool operator!= (const TIndex &index) const
 
TIndex operator+ (const TIndex &index) const
 
TIndexoperator+= (const TIndex &index)
 
TIndex operator- (const TIndex &index) const
 
TIndexoperator-= (const TIndex &index)
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::TIndex< 2 >
static const TIndex< Dimensions > & GetZero ()
 Get global instance of zero index.
 
static const TIndex< Dimensions > & GetInvalid ()
 Get global instance of invalid index.
 

Detailed Description

Index implementation for addressing elements in 2D-space.

Definition at line 24 of file CIndex2d.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 27 of file CIndex2d.h.

Constructor & Destructor Documentation

◆ CIndex2d() [1/5]

istd::CIndex2d::CIndex2d ( )
inline

Definition at line 74 of file CIndex2d.h.

◆ CIndex2d() [2/5]

istd::CIndex2d::CIndex2d ( int x,
int y )
inline

Definition at line 79 of file CIndex2d.h.

References istd::TIndex< 2 >::SetAt().

◆ CIndex2d() [3/5]

istd::CIndex2d::CIndex2d ( const TIndex< 2 > & index)
inline

Definition at line 86 of file CIndex2d.h.

◆ CIndex2d() [4/5]

istd::CIndex2d::CIndex2d ( const QPoint & point)
inline

Definition at line 91 of file CIndex2d.h.

References istd::TIndex< 2 >::SetAt().

◆ CIndex2d() [5/5]

istd::CIndex2d::CIndex2d ( const QSize & size)
inline

Definition at line 98 of file CIndex2d.h.

References istd::TIndex< 2 >::SetAt().

Member Function Documentation

◆ GetX()

◆ GetY()

◆ operator QPoint()

istd::CIndex2d::operator QPoint ( ) const
inline

Cast/convert index to QPoint object.

Definition at line 185 of file CIndex2d.h.

◆ operator QPointF()

istd::CIndex2d::operator QPointF ( ) const
inline

Cast/convert index to QPointF object.

Definition at line 191 of file CIndex2d.h.

◆ operator QSize()

istd::CIndex2d::operator QSize ( ) const
inline

Cast/convert index to QSize object.

Definition at line 179 of file CIndex2d.h.

◆ operator<()

bool istd::CIndex2d::operator< ( const CIndex2d & index) const
inline

Definition at line 129 of file CIndex2d.h.

References GetX(), and GetY().

◆ operator<=()

bool istd::CIndex2d::operator<= ( const CIndex2d & index) const
inline

Definition at line 151 of file CIndex2d.h.

◆ operator=() [1/2]

CIndex2d & istd::CIndex2d::operator= ( const CIndex2d & index)
inline

Assign value from another index.

Definition at line 163 of file CIndex2d.h.

◆ operator=() [2/2]

CIndex2d & istd::CIndex2d::operator= ( const TIndex< 2 > & index)
inline

Assign value from a general defined 2D-index.

Definition at line 171 of file CIndex2d.h.

◆ operator>()

bool istd::CIndex2d::operator> ( const CIndex2d & index) const
inline

Definition at line 145 of file CIndex2d.h.

◆ operator>=()

bool istd::CIndex2d::operator>= ( const CIndex2d & index) const
inline

Definition at line 157 of file CIndex2d.h.

◆ SetX()

void istd::CIndex2d::SetX ( int value)
inline

Definition at line 111 of file CIndex2d.h.

References istd::TIndex< 2 >::SetAt().

◆ SetY()

void istd::CIndex2d::SetY ( int value)
inline

Definition at line 123 of file CIndex2d.h.

References istd::TIndex< 2 >::SetAt().


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

© Witold Gantzke and Kirill Lepskiy