vlVolIterBase< DataType > Class Template Reference

This is the base class for non-const volume iterators. More...

#include <vlvoliterbase.h>

Inheritance diagram for vlVolIterBase< DataType >:

List of all members.

Public Member Functions
virtual bool	set (const DataType &value)=0
	Set the value of voxel at current position.
virtual bool	setRelative (const vlOffset &offset, const DataType &value)=0
	set value at a voxel offset from the current one
virtual bool	setRelativeNBC (const vlOffset &offset, const DataType &value)=0
	Same as getRelative but with NBC = No Boundary Check, thus faster.
virtual bool	setRelativeX (const int32 offset, const DataType &value)=0
	Set the voxel along X axis.
virtual bool	setRelativeY (const int32 offset, const DataType &value)=0
	Set the voxel along Y axis.
virtual bool	setRelativeZ (const int32 offset, const DataType &value)=0
	Set the voxel along Z axis.
virtual bool	setNeighbor (const DataType &value)=0
	Set the current neighbor of the current voxel.

---

Detailed Description

template<class DataType>
class vlVolIterBase< DataType >

Each layout type should re-implement all the API functions in the most optimal way. Derive non-const iterator for your data layout from this class. You will also need to implement const iterators. Those will be derived from vlVolIterBaseConst.

See also:

vlVolIterBaseConst

Author:

Sarang Lakare <sarang@users.sf.net>

Definition at line 367 of file vlvoliterbase.h.

---

Member Function Documentation

template<class DataType> virtual bool vlVolIterBase< DataType >::set (  const DataType &  value  )  [pure virtual]

Implemented in vlVolIter< DataType, LayoutType >, vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

template<class DataType> virtual bool vlVolIterBase< DataType >::setNeighbor (  const DataType &  value  )  [pure virtual]

Implemented in vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

template<class DataType> virtual bool vlVolIterBase< DataType >::setRelative (  const vlOffset &  offset, const DataType &  value )  [pure virtual]

Implemented in vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

template<class DataType> virtual bool vlVolIterBase< DataType >::setRelativeNBC (  const vlOffset &  offset, const DataType &  value )  [pure virtual]

Implemented in vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

template<class DataType> virtual bool vlVolIterBase< DataType >::setRelativeX (  const int32  offset, const DataType &  value )  [pure virtual]

Implemented in vlVolIter< DataType, LayoutType >, vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

template<class DataType> virtual bool vlVolIterBase< DataType >::setRelativeY (  const int32  offset, const DataType &  value )  [pure virtual]

Implemented in vlVolIter< DataType, LayoutType >, vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

template<class DataType> virtual bool vlVolIterBase< DataType >::setRelativeZ (  const int32  offset, const DataType &  value )  [pure virtual]

Implemented in vlVolIter< DataType, LayoutType >, vlVolIter< DataType, Layout >, vlVolIter< DataType, vlLayout::Generic >, vlVolIter< DataType, vlLayout::Linear >, and vlVolIter< DataType, vlLayout::VirtualCall >.

---

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

• vlvoliterbase.h

---