iflSize(3)	  Image	Format Library C++ Reference Manual	    iflSize(3)

NAME    [Toc]    [Back]

     iflSize - defines the size	of an IL image

INHERITS FROM    [Toc]    [Back]

     This is a base class and therefore	has no inheritance.

HEADER FILE    [Toc]    [Back]

     #include <ifl/iflSize.h>

DESCRIPTION    [Toc]    [Back]

     This object is used to describe the size of an IL image. It is mostly
     used to group the four values describing the (x, y, z, c) size of an
     image together in a convenient way.  An iflSize object can	be declared in
     the following way:

	      // unitialized
	      iflSize size;

	      // initialized
	      iflSize size(X_SIZE, Y_SIZE, Z_SIZE, C_SIZE);
	      iflSize size(X_SIZE, Y_SIZE, C_SIZE);
	      iflSize size(otherSizeObj);


     Several useful operators are provided to extract the total	size and to
     perform direct comparisons	between	iflSize	objects.

CLASS MEMBER FUNCTION SUMMARY    [Toc]    [Back]

     Constructors

	  iflSize()
	  iflSize(int x, int y,	int c=1)
	  iflSize(int x, int y,	int z, int c)
	  iflSize(const	iflSize& size)


     Initialization    [Toc]    [Back]

	  void init(int	x, int y, int z, int c)


     Operators    [Toc]    [Back]

	  operator int() const
	  void operator=(const iflSize&	from)
	  operator!=(const iflSize& rhs)  const
	  operator==(const iflSize& rhs)  const








									Page 1






iflSize(3)	  Image	Format Library C++ Reference Manual	    iflSize(3)

FUNCTION DESCRIPTIONS    [Toc]    [Back]

     iflSize()

	  iflSize()
	  iflSize(int x, int y,	int c=1)
	  iflSize(int x, int y,	int z, int c)
	  iflSize(const	iflSize& size)


	  The first version with no arguments constructs an uninitialized
	  iflSize.  The	second version constructs an iflSize with the size set
	  to (x, y, c).	Note that c and	z default to 1.	 The third version
	  constructs an	iflSize	with the size set to (x, y, z, c).  The	final
	  version constructs an	iflSize	whose values are taken from size.

     void init()

	  void init(int	x, int y, int z, int c)


	  Thi method initializes the size to (x, y, z, c).

     operator int()

	  operator int() const


	  The int cast operator	returns	the product of the dimensions,
	  x*y*z*c.

     operator=()

	  void operator=(const iflSize&	from)


	  The assignment operator copies from into the iflSize object it is
	  invoked on.

     operator!=()

	  operator!=(const iflSize& rh)	const


	  The inequality operator compares two iflSize objects and returns
	  TRUE if any of the corresponding (x, y, z, c)	members	differ,	FALSE
	  otherwise.

     operator==()

	  operator==(const iflSize& rh)	const





									Page 2






iflSize(3)	  Image	Format Library C++ Reference Manual	    iflSize(3)



	  The equality operator	compares two iflSize objects and returns TRUE
	  if all of the	corresponding (x, y, z,	c) members are the same, FALSE
	  otherwise.


									PPPPaaaaggggeeee 3333