VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkGenericMovieWriter Class Reference

an abstract movie writer class. More...

#include <vtkGenericMovieWriter.h>

Inheritance diagram for vtkGenericMovieWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkGenericMovieWriter:
Collaboration graph
[legend]

List of all members.

Public Types

enum  MovieWriterErrorIds {
  UserError = 40000, InitError, NoInputError, CanNotCompress,
  CanNotFormat, ChangedResolutionError
}
typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkGenericMovieWriterNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void Start ()=0
virtual void Write ()=0
virtual void End ()=0
virtual int GetError ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkGenericMovieWriterSafeDownCast (vtkObjectBase *o)
static const char * GetStringFromErrorCode (unsigned long event)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkGenericMovieWriter ()
 ~vtkGenericMovieWriter ()

Protected Attributes

char * FileName
int Error

Detailed Description

an abstract movie writer class.

vtkGenericMovieWriter is the abstract base class for several movie writers. The input type is a vtkImageData. The Start() method will open and create the file, the Write() method will output a frame to the file (i.e. the contents of the vtkImageData), End() will finalize and close the file.

See also:
vtkAVIWriter vtkMPEG2Writer

Definition at line 35 of file vtkGenericMovieWriter.h.


Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

Definition at line 38 of file vtkGenericMovieWriter.h.


Member Enumeration Documentation

Enumerator:
UserError 
InitError 
NoInputError 
CanNotCompress 
CanNotFormat 
ChangedResolutionError 

Definition at line 64 of file vtkGenericMovieWriter.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkGenericMovieWriter::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

virtual int vtkGenericMovieWriter::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

virtual vtkObjectBase* vtkGenericMovieWriter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

void vtkGenericMovieWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

virtual void vtkGenericMovieWriter::SetFileName ( const char *  ) [virtual]

Specify file name of avi file.

virtual char* vtkGenericMovieWriter::GetFileName ( ) [virtual]

Specify file name of avi file.

virtual void vtkGenericMovieWriter::Start ( ) [pure virtual]

These methods start writing an Movie file, write a frame to the file and then end the writing process.

Implemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

virtual void vtkGenericMovieWriter::Write ( ) [pure virtual]

These methods start writing an Movie file, write a frame to the file and then end the writing process.

Implemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

virtual void vtkGenericMovieWriter::End ( ) [pure virtual]

These methods start writing an Movie file, write a frame to the file and then end the writing process.

Implemented in vtkMPEG2Writer, vtkFFMPEGWriter, vtkOggTheoraWriter, and vtkAVIWriter.

virtual int vtkGenericMovieWriter::GetError ( ) [virtual]

Was there an error on the last write performed?

static const char* vtkGenericMovieWriter::GetStringFromErrorCode ( unsigned long  event) [static]

Converts vtkErrorCodes and vtkGenericMovieWriter errors to strings.


Member Data Documentation

Definition at line 78 of file vtkGenericMovieWriter.h.

Definition at line 79 of file vtkGenericMovieWriter.h.


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