vlVolIter< DataType, LayoutType > Class Template Reference

This class defines an iterator for run length encoded data volumes. More...

#include <vlvoliter_rlencode.h>

Inheritance diagram for vlVolIter< DataType, LayoutType >:

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, LayoutType > *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 int32 deltaOffset, const DataType &value)
	set value at a voxel deltaOffset from the current position
bool	setRelative (const vlTriple< int32 > &delta, const DataType &value)
	set value at a voxel delta from the current one
bool	setRelativeNBC (const vlTriple< int32 > &delta, 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.

---

Detailed Description

template<typename DataType>
class vlVolIter< DataType, LayoutType >

Todo:

Right now, this is just a copy of Linear - So implement rle.

Author:

Sarang Lakare <sarang@users.sf.net>

Definition at line 40 of file vlvoliter_rlencode.h.

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

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

Parameters: DataType  value  Returns: Implements vlVolIterBase< DataType >. Definition at line 98 of file vlvoliter_rlencode.h.

template<typename DataType> bool vlVolIter< DataType, LayoutType >::setRelative (  const vlTriple< int32 > &  delta, const DataType &  value )  [inline]

Definition at line 120 of file vlvoliter_rlencode.h. References int32, vlTriple< T >::x(), vlTriple< T >::y(), and vlTriple< T >::z().

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

Definition at line 106 of file vlvoliter_rlencode.h.

template<typename DataType> bool vlVolIter< DataType, LayoutType >::setRelativeNBC (  const vlTriple< int32 > &  delta, const DataType &  value )

Definition at line 134 of file vlvoliter_rlencode.h. References int32, vlTriple< T >::x(), vlTriple< T >::y(), and vlTriple< T >::z().

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

Implements vlVolIterBase< DataType >. Definition at line 148 of file vlvoliter_rlencode.h. References int32.

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

Implements vlVolIterBase< DataType >. Definition at line 162 of file vlvoliter_rlencode.h. References int32.

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

Implements vlVolIterBase< DataType >. Definition at line 176 of file vlvoliter_rlencode.h. References int32.

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

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

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

---

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

• vlvoliter_rlencode.h

---