Home :: @root classes

class Image

^ 
********************************************************************** Represents a matrix of colors.

This class can read and write images in the format called portable image format because it is easy to generate and modify, but not very efficient. There are three varieties of portable images: - pbm (only black and white color values) - pgm (grey scale color values) - ppm (full color values) These images can be viewed using a program like gimp, xpaint, or xv.

Source:
image.h:26
Author:
Robert C. Duvall
Version:
unknown

Contents

^ 
EntityTypeScopeShort Description
~Imagedestructor publicautomatically generated
Imageconstructor public Create an empty image
Imageconstructor public Create an image from another
COMMENTattribute publicundocumented
DEFAULT_CREATORattribute publicundocumented
equalsmethod public Compare with another image for equality
getColorAtmethod public Get color of color [x,y] in assignable context
getColorAtmethod public Get color of color [x,y] in const context
getHeightmethod public Return height (i.e., number of rows) of image
getWidthmethod public Return width (i.e., number of columns) of image
operator *=operator public Multiplies colors in this image by those in another one
operator *=operator public Multiplies all colors in this image by a single other color
operator +=operator public Adds colors in another image with those in this one
operator +=operator public Adds a single other color with all those in this one
operator -=operator public Subtracts colors in another image from those in this one
operator -=operator public Subtracts a single color from all those in this one
operator /=operator public Divides colors in this image by those in another one
operator /=operator public Divides all colors in this image by a single other color
operator =operator public Replace colors in this image with a single other color
operator =operator public Copy the content of another Image into this one
readmethod public Read image data from given source
setColorAtmethod public Set color [x,y] to given color
writemethod public Write image data to given source

destructor ~Image

? ^  > 
automatically generated
Source:
image.h
Code:
public ~ Image ( )

constructor Image

? ^  < > 
Create an empty image
Source:
image.h:37
Code:
public Image ( unsigned int width = 0 ,
unsigned int height = 0 ,
const Color & color = Color::BLACK )

constructor Image

? ^  < > 
Create an image from another
Source:
image.h:42
Code:
public Image ( const Image & other )

attribute COMMENT

? ^  < > 
undocumented
Source:
image.h:29
Code:
public static const char COMMENT

attribute DEFAULT_CREATOR

? ^  < > 
undocumented
Source:
image.h:28
Code:
public static const string DEFAULT_CREATOR

method equals

? ^  < > 
Compare with another image for equality
Source:
image.h:57
Code:
public bool equals ( const Image & other ) const

method getColorAt

? ^  < > 
Get color of color [x,y] in assignable context
Source:
image.h:82
Code:
public Color & getColorAt ( unsigned int x ,
unsigned int y )

method getColorAt

? ^  < > 
Get color of color [x,y] in const context
Source:
image.h:78
Code:
public Color getColorAt ( unsigned int x ,
unsigned int y ) const

method getHeight

? ^  < > 
Return height (i.e., number of rows) of image
Source:
image.h:88
Code:
public unsigned int getHeight ( ) const

method getWidth

? ^  < > 
Return width (i.e., number of columns) of image
Source:
image.h:92
Code:
public unsigned int getWidth ( ) const

operator *=

? ^  < > 
Multiplies colors in this image by those in another one
Source:
image.h:114
Code:
public Image & operator *= ( const Image & other )

operator *=

? ^  < > 
Multiplies all colors in this image by a single other color
Source:
image.h:118
Code:
public Image & operator *= ( const Color & other )

operator +=

? ^  < > 
Adds colors in another image with those in this one
Source:
image.h:98
Code:
public Image & operator += ( const Image & other )

operator +=

? ^  < > 
Adds a single other color with all those in this one
Source:
image.h:102
Code:
public Image & operator += ( const Color & other )

operator -=

? ^  < > 
Subtracts colors in another image from those in this one
Source:
image.h:106
Code:
public Image & operator -= ( const Image & other )

operator -=

? ^  < > 
Subtracts a single color from all those in this one
Source:
image.h:110
Code:
public Image & operator -= ( const Color & other )

operator /=

? ^  < > 
Divides colors in this image by those in another one
Source:
image.h:122
Code:
public Image & operator /= ( const Image & other )

operator /=

? ^  < > 
Divides all colors in this image by a single other color
Source:
image.h:126
Code:
public Image & operator /= ( const Color & other )

operator =

? ^  < > 
Replace colors in this image with a single other color
Source:
image.h:51
Code:
public Image & operator = ( const Color & other )

operator =

? ^  < > 
Copy the content of another Image into this one
Source:
image.h:47
Code:
public Image & operator = ( const Image & other )

method read

? ^  < > 
Read image data from given source
Source:
image.h:63
Code:
public bool read ( istream & input )

method setColorAt

? ^  < > 
Set color [x,y] to given color
Source:
image.h:74
Code:
public void setColorAt ( unsigned int x ,
unsigned int y ,
const Color & color )

method write

? ^  < > 
Write image data to given source
Source:
image.h:67
Code:
public bool write ( ostream & output ) const

Created Thu Oct 10 01:13:46 2002.
This documentation was generated automatically by
ccdoc v0.8 r26 2001/11/28 bin_opt_suncc_solaris-2.8.
Click here to submit a bug report or feature request.
Click here to return to the top of the page.