vtkGenericMovieWriter Class Reference
#include <vtkGenericMovieWriter.h>
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 34 of file vtkGenericMovieWriter.h.
Public Types | |
| enum | MovieWriterErrorIds { UserError = 40000, InitError, NoInputError, CanNotCompress, CanNotFormat, ChangedResolutionError } |
| typedef vtkProcessObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetInput (vtkImageData *input) |
| virtual vtkImageData * | GetInput () |
| 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 vtkGenericMovieWriter * | SafeDownCast (vtkObject *o) |
| static const char * | GetStringFromErrorCode (unsigned long event) |
Protected Member Functions | |
| vtkGenericMovieWriter () | |
| ~vtkGenericMovieWriter () | |
Protected Attributes | |
| char * | FileName |
| int | Error |
Member Typedef Documentation
Reimplemented from vtkProcessObject.
Reimplemented in vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
Definition at line 37 of file vtkGenericMovieWriter.h.
Member Enumeration Documentation
Definition at line 69 of file vtkGenericMovieWriter.h.
Constructor & Destructor Documentation
| vtkGenericMovieWriter::vtkGenericMovieWriter | ( | ) | [protected] |
| vtkGenericMovieWriter::~vtkGenericMovieWriter | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkGenericMovieWriter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkProcessObject.
Reimplemented in vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| 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 vtkProcessObject.
Reimplemented in vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| 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 vtkProcessObject.
Reimplemented in vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| static vtkGenericMovieWriter* vtkGenericMovieWriter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkProcessObject.
Reimplemented in vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| 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 vtkProcessObject.
Reimplemented in vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| virtual void vtkGenericMovieWriter::SetInput | ( | vtkImageData * | input | ) | [virtual] |
Set/Get the input object from the image pipeline.
| virtual vtkImageData* vtkGenericMovieWriter::GetInput | ( | ) | [virtual] |
Set/Get the input object from the image pipeline.
| 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 vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| 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 vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| 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 vtkAVIWriter, vtkFFMPEGWriter, vtkMPEG2Writer, and vtkOggTheoraWriter.
| 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
char* vtkGenericMovieWriter::FileName [protected] |
Definition at line 83 of file vtkGenericMovieWriter.h.
int vtkGenericMovieWriter::Error [protected] |
Definition at line 84 of file vtkGenericMovieWriter.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkGenericMovieWriter.h
