ModelInputIterator Interface Reference

The ModelInputIterator class handles iteration over given ModelInputPictures. Handles boundarys and allows for easy boundary checks. Different implementations of this interface allow to easily swap iteration policy, f.e. iterate keyframes only. More...

#include <ModelInputIterator.h>

Inheritance diagram for ModelInputIterator:

Public Member Functions
virtual unsigned int	getNext (ModelInputPictures *mip, unsigned int currentIdx, unsigned int stepsize=1)=0
	steps for stepsize images forward from given currentIdx without leaving the boundarys of ModelInputPictures mip.
virtual unsigned int	getPrevious (ModelInputPictures *mip, unsigned int currentIdx, unsigned int stepsize=1)=0
	steps for stepsize images backward from given currentIdx without leaving the boundarys of ModelInputPictures mip.
virtual unsigned int	getFirst (ModelInputPictures *mip)=0
	get index of first image in ModelInputPicturesInstance mip.
virtual unsigned int	getLast (ModelInputPictures *mip)=0
	get index of last image in ModelInputPicturesInstance mip.
virtual bool	isFirst (ModelInputPictures *mip, unsigned int currentIdx)=0
	check if currentIdx is first index in ModelInputPictures mip.
virtual bool	isLast (ModelInputPictures *mip, unsigned int currentIdx)=0
	check if currentIdx is last index in ModelInputPictures mip.

Detailed Description

The ModelInputIterator class handles iteration over given ModelInputPictures. Handles boundarys and allows for easy boundary checks. Different implementations of this interface allow to easily swap iteration policy, f.e. iterate keyframes only.

Author

Dominik Wüst

Date

2021/02/11

Member Function Documentation

getFirst()

virtual unsigned int ModelInputIterator::getFirst ( ModelInputPictures *  mip )

pure virtual

get index of first image in ModelInputPicturesInstance mip.

Parameters

mip	the ModelInputPictures to iterate

Returns

the index of the first image

Implemented in ImageIterator, and KeyframeIterator.

getLast()

virtual unsigned int ModelInputIterator::getLast ( ModelInputPictures *  mip )

pure virtual

get index of last image in ModelInputPicturesInstance mip.

Parameters

mip	the ModelInputPictures to iterate

Returns

the index of the first image

Implemented in ImageIterator, and KeyframeIterator.

getNext()

virtual unsigned int ModelInputIterator::getNext ( ModelInputPictures *  mip, unsigned int  currentIdx, unsigned int  stepsize = 1  )

pure virtual

steps for stepsize images forward from given currentIdx without leaving the boundarys of ModelInputPictures mip.

Parameters

mip	the ModelInputPictures instance to iterate
currentIdx	the index to start from
stepsize	the number of images to step from currentIdx

Returns

the new index which is stepsize images forward from currentIdx

Implemented in ImageIterator, and KeyframeIterator.

getPrevious()

virtual unsigned int ModelInputIterator::getPrevious ( ModelInputPictures *  mip, unsigned int  currentIdx, unsigned int  stepsize = 1  )

pure virtual

steps for stepsize images backward from given currentIdx without leaving the boundarys of ModelInputPictures mip.

Parameters

mip	the ModelInputPictures instance to iterate
currentIdx	the index to start from
stepsize	the number of images to step from currentIdx

Returns

the new index which is stepsize images backward from currentIdx

Implemented in ImageIterator, and KeyframeIterator.

isFirst()

virtual bool ModelInputIterator::isFirst ( ModelInputPictures *  mip, unsigned int  currentIdx  )

pure virtual

check if currentIdx is first index in ModelInputPictures mip.

Parameters

mip	the ModelInputPictures to iterate
currentIdx	index to check

Returns

true if currentIdx is first index, false otherwise

Implemented in ImageIterator, and KeyframeIterator.

isLast()

virtual bool ModelInputIterator::isLast ( ModelInputPictures *  mip, unsigned int  currentIdx  )

pure virtual

check if currentIdx is last index in ModelInputPictures mip.

Parameters

mip	the ModelInputPictures to iterate
currentIdx	index to check

Returns

true if currentIdx is last index, false otherwise

Implemented in ImageIterator, and KeyframeIterator.

---

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

• iVS3D/src/iVS3D-core/controller/ModelInputIterator.h