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

This class defines an iterator for "linear" data volumes. More...

#include <vlvoliter_linear.h>

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

List of all members.

Public Member Functions
	vlVolIter (vlVolume *vol)
	Constructor when volume pointer is provided.
	vlVolIter (vlVolData *data)
	Constructor when volume data pointer is provided.
	vlVolIter (vlVolDataLayout< DataType, vlLayout::Linear > *data)
	Constructor when volume data in linear layout pointer is provided.
virtual	~vlVolIter ()
	default destructor
bool	set (const DataType &value)
	Set the value of voxel at 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.
bool	setRelative (const int32 deltaOffset, const DataType &value)
	set value at a voxel deltaOffset from the current position.

---

Detailed Description

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

It is derived from vlVolIterator.

Todo:

Make & use local copies of m_step, m_dimLimit etc

Replace m_rData with m_pData and check performance

Add robust error checks - easy if moved to m_pData

Author:

Sarang Lakare <sarang@users.sf.net>

Definition at line 43 of file vlvoliter_linear.h.

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

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

Implements vlVolIterBase< DataType >.

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

Implements vlVolIterBase< DataType >.

template<typename DataType> bool vlVolIter< DataType, vlLayout::Linear >::setRelative (  const int32  deltaOffset, const DataType &  value )

This function is available only to Linear layout.

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

Implements vlVolIterBase< DataType >.

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

Implements vlVolIterBase< DataType >.

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

Implements vlVolIterBase< DataType >.

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

Implements vlVolIterBase< DataType >.

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

Implements vlVolIterBase< DataType >.

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

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

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

---

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

• vlvoliter_linear.h

---