ncut::PNGSequence Class Reference

#include <ncutImage.h>

Inheritance diagram for ncut::PNGSequence:

ncut::Sequence< PNG_IMAGE_DATATYPE > List of all members.

Public Member Functions

PNGImageoperator[] (unsigned long)
const PNGImageoperator[] (unsigned long) const
int pushThrough (const Image< PNG_IMAGE_DATATYPE > &frame)
 Push a frame onto the sequence and pop the first frame.
int pushThrough (const PNGImage &frame)
 Push a frame onto the sequence and pop the first frame.
int pushFrame (const Image< PNG_IMAGE_DATATYPE > &frame)
 Push a frame to the back of the sequence.
int pushFrame (const PNGImage &frame)
 Push a frame to the back of the sequence.
void popFrame ()
 Pop the last frame of the sequence.
int save (const char *filename) const
 Save all PNG images in this sequence.
 PNGSequence ()
 PNGSequence empty constructor
 PNGSequence (const PNGSequence &clone)
 PNGSequence copy constructor.
virtual ~PNGSequence ()
 PNGSequence destructor.
virtual PNGSequenceoperator= (const PNGSequence &clone)
 PNGSequence assignment operator.

Detailed Description

PNGSequence adds PNG-specific save functionality to its base class Sequence. Only images of type PNGImage are allows in a PNGSequence.


Constructor & Destructor Documentation

ncut::PNGSequence::PNGSequence  ) 
 

PNGSequence empty constructor

Creates an empty PNGSequence with=height=channels=0.

ncut::PNGSequence::PNGSequence const PNGSequence clone  ) 
 

PNGSequence copy constructor.

Parameters:
clone The PNGSequence to be cloned.


Member Function Documentation

PNGSequence & ncut::PNGSequence::operator= const PNGSequence clone  )  [virtual]
 

PNGSequence assignment operator.

Parameters:
clone The PNGSequence to be cloned.
Returns:
This object.

void ncut::PNGSequence::popFrame  )  [virtual]
 

Pop the last frame of the sequence.

Deletes the last frame and removes it from the sequence. This does nothing if the sequence is empty.

Reimplemented from ncut::Sequence< PNG_IMAGE_DATATYPE >.

int ncut::PNGSequence::pushFrame const PNGImage frame  ) 
 

Push a frame to the back of the sequence.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image to the back of the sequence. The length of the sequence is increased by one. Only PNG images of the same dimension as all other images in the sequence are accepted.

int ncut::PNGSequence::pushFrame const Image< PNG_IMAGE_DATATYPE > &  frame  )  [virtual]
 

Push a frame to the back of the sequence.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image to the back of the sequence. The length of the sequence is increased by one. Only PNG images of the same dimension as all other images in the sequence are accepted. frame is cast to a PNGImage.

Reimplemented from ncut::Sequence< PNG_IMAGE_DATATYPE >.

int ncut::PNGSequence::pushThrough const PNGImage frame  ) 
 

Push a frame onto the sequence and pop the first frame.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image onto the sequence and removes the first frame of the sequence. The length of the sequence remains unchanged. Only PNG images of the same dimension as all other images in the sequence are accepted.

int ncut::PNGSequence::pushThrough const Image< PNG_IMAGE_DATATYPE > &  frame  )  [virtual]
 

Push a frame onto the sequence and pop the first frame.

Parameters:
frame The Image to be pushed onto the sequence.
Returns:
0 if successful.
Pushes a copy of Image onto the sequence and removes the first frame of the sequence. The length of the sequence remains unchanged. Only PNG images of the same dimension as all other images in the sequence are accepted. frame is cast to a PNGImage.

Reimplemented from ncut::Sequence< PNG_IMAGE_DATATYPE >.

int ncut::PNGSequence::save const char *  filename  )  const
 

Save all PNG images in this sequence.

Parameters:
filename The base filename for all images.
Returns:
0 if successful.
The sequence number of each frame is appended to the filename and the frame is saved.


The documentation for this class was generated from the following files:
Generated on Thu Jun 22 14:47:22 2006 for ncut.kdevelop by  doxygen 1.4.6