vlVolIter< DataType, vlLayout::VirtualCall > Class Template Reference

This is a generic iterator class. More...

#include <vlvoliterator.h>

Inheritance diagram for vlVolIter< DataType, vlLayout::VirtualCall >:

List of all members.

Public Member Functions
	vlVolIter (vlVolume *vol)
	default constructor - initial position of iterator is set to (0,0,0)
	vlVolIter (vlVolData *data)
	default constructor - initial position of iterator is set to (0,0,0)
	vlVolIter (vlVolIterBase< DataType > *other)
	constructor when another iterator is specified
virtual	~vlVolIter ()
	default destructor
bool	set (const DataType &value)
	Set the value of voxel at current position.
bool	setRelative (const int32 deltaOffset, const DataType &value)
	set value at a voxel deltaOffset from the current position
bool	setRelative (const vlOffset &offset, const DataType &value)
	set value at a voxel offset from the current one
bool	setRelativeNBC (const vlOffset &offset, const DataType &value)
	Same as getRelative but with NBC = No Boundary Check, thus faster.
bool	setRelativeX (const int32 offset, const DataType &value)
	Get the voxel along X axis.
bool	setRelativeY (const int32 offset, const DataType &value)
	Get the voxel along Y axis.
bool	setRelativeZ (const int32 offset, const DataType &value)
	Get the voxel along Z axis.
bool	setNeighbor (const DataType &value)
	Set the current neighbor of the current voxel.
Protected Member Functions
template<int Layout> bool	getIter (vlVolume *vol)
template<int Layout> bool	getIter (vlVolData *data)
Protected Attributes
vlVolIterBase< DataType > *	m_iter
	Internal iterator - will point to the real iterator.

---

Detailed Description

template<typename DataType>
class vlVolIter< DataType, vlLayout::VirtualCall >

It does not have any code of itself. It simply calls the iterator of the data layout. This class is a non-const iterator.

See also:

vlVolIterConst

Author:

Sarang Lakare <sarang@users.sf.net>

Definition at line 445 of file vlvoliterator.h.

---

Constructor & Destructor Documentation

template<typename DataType> virtual vlVolIter< DataType, vlLayout::VirtualCall >::~vlVolIter (   )  [inline, virtual]

---

Member Function Documentation

template<typename DataType> template<int Layout> bool vlVolIter< DataType, vlLayout::VirtualCall >::getIter (  vlVolData *  data  )  [inline, protected]

Definition at line 609 of file vlvoliterator.h.

template<typename DataType> template<int Layout> bool vlVolIter< DataType, vlLayout::VirtualCall >::getIter (  vlVolume *  vol  )  [inline, protected]

Definition at line 593 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::set (  const DataType &  value  )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 536 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setNeighbor (  const DataType &  value  )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 584 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setRelative (  const vlOffset &  offset, const DataType &  value )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 550 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setRelative (  const int32  deltaOffset, const DataType &  value )  [inline]

Definition at line 543 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setRelativeNBC (  const vlOffset &  offset, const DataType &  value )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 557 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setRelativeX (  const int32  offset, const DataType &  value )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 564 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setRelativeY (  const int32  offset, const DataType &  value )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 571 of file vlvoliterator.h.

template<typename DataType> bool vlVolIter< DataType, vlLayout::VirtualCall >::setRelativeZ (  const int32  offset, const DataType &  value )  [inline, virtual]

Implements vlVolIterBase< DataType >. Definition at line 578 of file vlvoliterator.h.

template<typename DataType> vlVolIter< DataType, vlLayout::VirtualCall >::vlVolIter (  vlVolIterBase< DataType > *  other  )  [inline]

template<typename DataType> vlVolIter< DataType, vlLayout::VirtualCall >::vlVolIter (  vlVolData *  data  )  [inline]

template<typename DataType> vlVolIter< DataType, vlLayout::VirtualCall >::vlVolIter (  vlVolume *  vol  )  [inline]

---

Member Data Documentation

template<typename DataType> vlVolIterBase<DataType>* vlVolIter< DataType, vlLayout::VirtualCall >::m_iter [protected]

Definition at line 624 of file vlvoliterator.h.

---

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

• vlvoliterator.h

---