ImageBuf::IteratorBase Class Reference

Inheritance diagram for ImageBuf::IteratorBase:

Public Member Functions
	IteratorBase (const ImageBuf &ib, WrapMode wrap)
	IteratorBase (const ImageBuf &ib, const ROI &roi, WrapMode wrap)
	Construct valid iteration region from ImageBuf and ROI.
	IteratorBase (const ImageBuf &ib, int xbegin, int xend, int ybegin, int yend, int zbegin, int zend, WrapMode wrap)
	IteratorBase (const IteratorBase &i)
const IteratorBase &	assign_base (const IteratorBase &i)
int	x () const
int	y () const
int	z () const
bool	valid () const
	Is the current location within the designated iteration range?
bool	valid (int x_, int y_, int z_=0) const
bool	exists (int x_, int y_, int z_=0) const
bool	exists () const
bool	done () const
	Are we finished iterating over the region?
int	deep_samples ()
	Retrieve the number of deep data samples at this pixel.
WrapMode	wrap () const
	Return the wrap mode.
void	pos (int x_, int y_, int z_=0)
void	operator++ ()
void	operator++ (int)
ROI	range () const
	Return the iteration range.

Protected Member Functions
void	init_ib (WrapMode wrap)
void	range_is_image ()
void	pos_xincr ()

Protected Attributes
const ImageBuf *	m_ib
bool	m_valid
bool	m_exists
bool	m_deep
bool	m_localpixels
int	m_img_xbegin
int	m_img_xend
int	m_img_ybegin
int	m_img_yend
int	m_img_zbegin
int	m_img_zend
int	m_rng_xbegin
int	m_rng_xend
int	m_rng_ybegin
int	m_rng_yend
int	m_rng_zbegin
int	m_rng_zend
int	m_x
int	m_y
int	m_z
ImageCache::Tile *	m_tile
int	m_tilexbegin
int	m_tileybegin
int	m_tilezbegin
int	m_tilexend
int	m_nchannels
size_t	m_pixel_bytes
char *	m_proxydata
WrapMode	m_wrap

Friends
class	ImageBuf
class	ImageBufImpl

Constructor & Destructor Documentation

ImageBuf::IteratorBase::IteratorBase ( const ImageBuf &  ib, const ROI &  roi, WrapMode  wrap  )

inline

Construct valid iteration region from ImageBuf and ROI.

ImageBuf::IteratorBase::IteratorBase ( const ImageBuf &  ib, int  xbegin, int  xend, int  ybegin, int  yend, int  zbegin, int  zend, WrapMode  wrap  )

inline

Construct from an ImageBuf and designated region – iterate over region, starting with the upper left pixel.

Member Function Documentation

const IteratorBase& ImageBuf::IteratorBase::assign_base ( const IteratorBase &  i )

inline

Assign one IteratorBase to another

int ImageBuf::IteratorBase::deep_samples ( )

inline

Retrieve the number of deep data samples at this pixel.

bool ImageBuf::IteratorBase::done ( ) const

inline

Are we finished iterating over the region?

bool ImageBuf::IteratorBase::exists ( int  x_, int  y_, int  z_ = 0  ) const

inline

Is the location (x,y[,z]) within the region of the ImageBuf that contains pixel values (sometimes called the "data window")?

bool ImageBuf::IteratorBase::exists ( ) const

inline

Does the current location exist within the ImageBuf's data window?

void ImageBuf::IteratorBase::operator++ ( )

inline

Increment to the next pixel in the region.

void ImageBuf::IteratorBase::operator++ ( int  )

inline

Increment to the next pixel in the region.

void ImageBuf::IteratorBase::pos ( int  x_, int  y_, int  z_ = 0  )

inline

Explicitly point the iterator. This results in an invalid iterator if outside the previously-designated region.

ROI ImageBuf::IteratorBase::range ( ) const

inline

Return the iteration range.

bool ImageBuf::IteratorBase::valid ( ) const

inline

Is the current location within the designated iteration range?

bool ImageBuf::IteratorBase::valid ( int  x_, int  y_, int  z_ = 0  ) const

inline

Is the location (x,y[,z]) within the designated iteration range?

WrapMode ImageBuf::IteratorBase::wrap ( ) const

inline

Return the wrap mode.

int ImageBuf::IteratorBase::x ( ) const

inline

Retrieve the current x location of the iterator.

int ImageBuf::IteratorBase::y ( ) const

inline

Retrieve the current y location of the iterator.

int ImageBuf::IteratorBase::z ( ) const

inline

Retrieve the current z location of the iterator.

---

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

• src/include/imagebuf.h