vtkAVIWriter Class Reference
#include <vtkAVIWriter.h>
Detailed Description
Writes Windows AVI files.vtkAVIWriter writes AVI files. Note that this class in only available on the Microsoft Windows platform. The data type of the file is unsigned char regardless of the input type.
- See also:
- vtkGenericMovieWriter vtkMPEG2Writer
- Tests:
- vtkAVIWriter (Tests)
Definition at line 35 of file vtkAVIWriter.h.
Public Types | |
| typedef vtkGenericMovieWriter | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | Start () |
| void | Write () |
| void | End () |
| virtual void | SetRate (int) |
| virtual int | GetRate () |
| virtual void | SetQuality (int) |
| virtual int | GetQuality () |
| virtual void | SetPromptCompressionOptions (int) |
| virtual int | GetPromptCompressionOptions () |
| virtual void | PromptCompressionOptionsOn () |
| virtual void | PromptCompressionOptionsOff () |
| virtual void | SetCompressorFourCC (const char *) |
| virtual char * | GetCompressorFourCC () |
Static Public Member Functions | |
| static vtkAVIWriter * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkAVIWriter * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkAVIWriter () | |
| ~vtkAVIWriter () | |
Protected Attributes | |
| vtkAVIWriterInternal * | Internals |
| int | Rate |
| int | Time |
| int | Quality |
| int | PromptCompressionOptions |
| char * | CompressorFourCC |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkAVIWriter::vtkAVIWriter | ( | ) | [protected] |
| vtkAVIWriter::~vtkAVIWriter | ( | ) | [protected] |
Member Function Documentation
| static vtkAVIWriter* vtkAVIWriter::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
| virtual const char* vtkAVIWriter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkGenericMovieWriter.
| static int vtkAVIWriter::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 vtkGenericMovieWriter.
| virtual int vtkAVIWriter::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 vtkGenericMovieWriter.
| static vtkAVIWriter* vtkAVIWriter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkGenericMovieWriter.
| void vtkAVIWriter::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 vtkGenericMovieWriter.
| void vtkAVIWriter::Start | ( | ) | [virtual] |
These methods start writing an AVI file, write a frame to the file and then end the writing process.
Implements vtkGenericMovieWriter.
| void vtkAVIWriter::Write | ( | ) | [virtual] |
These methods start writing an AVI file, write a frame to the file and then end the writing process.
Implements vtkGenericMovieWriter.
| void vtkAVIWriter::End | ( | ) | [virtual] |
These methods start writing an AVI file, write a frame to the file and then end the writing process.
Implements vtkGenericMovieWriter.
| virtual void vtkAVIWriter::SetRate | ( | int | ) | [virtual] |
Set/Get the frame rate, in frame/s.
| virtual int vtkAVIWriter::GetRate | ( | ) | [virtual] |
Set/Get the frame rate, in frame/s.
| virtual void vtkAVIWriter::SetQuality | ( | int | ) | [virtual] |
Set/Get the compression quality. 0 means worst quality and smallest file size 2 means best quality and largest file size
| virtual int vtkAVIWriter::GetQuality | ( | ) | [virtual] |
Set/Get the compression quality. 0 means worst quality and smallest file size 2 means best quality and largest file size
| virtual void vtkAVIWriter::SetPromptCompressionOptions | ( | int | ) | [virtual] |
Set/Get if the user should be prompted for compression options, i.e. pick a compressor, set the compression rate (override Rate), etc.). Default is OFF (legacy).
| virtual int vtkAVIWriter::GetPromptCompressionOptions | ( | ) | [virtual] |
Set/Get if the user should be prompted for compression options, i.e. pick a compressor, set the compression rate (override Rate), etc.). Default is OFF (legacy).
| virtual void vtkAVIWriter::PromptCompressionOptionsOn | ( | ) | [virtual] |
Set/Get if the user should be prompted for compression options, i.e. pick a compressor, set the compression rate (override Rate), etc.). Default is OFF (legacy).
| virtual void vtkAVIWriter::PromptCompressionOptionsOff | ( | ) | [virtual] |
Set/Get if the user should be prompted for compression options, i.e. pick a compressor, set the compression rate (override Rate), etc.). Default is OFF (legacy).
| virtual void vtkAVIWriter::SetCompressorFourCC | ( | const char * | ) | [virtual] |
Set/Get the compressor FourCC. A FourCC (literally, four-character code) is a sequence of four bytes used to uniquely identify data formats. [...] One of the most well-known uses of FourCCs is to identify the video codec used in AVI files. Common identifiers include DIVX, XVID, and H264. http://en.wikipedia.org/wiki/FourCC. Default value is: - msvc Other examples include: - DIB: Full Frames (Uncompressed) - LAGS: Lagarith Lossless Codec - MJPG: M-JPG, aka Motion JPEG (say, Pegasus Imaging PicVideo M-JPEG) Links: - http://www.fourcc.org/ - http://www.microsoft.com/whdc/archive/fourcc.mspx - http://abcavi.kibi.ru/fourcc.php
| virtual char* vtkAVIWriter::GetCompressorFourCC | ( | ) | [virtual] |
Set/Get the compressor FourCC. A FourCC (literally, four-character code) is a sequence of four bytes used to uniquely identify data formats. [...] One of the most well-known uses of FourCCs is to identify the video codec used in AVI files. Common identifiers include DIVX, XVID, and H264. http://en.wikipedia.org/wiki/FourCC. Default value is: - msvc Other examples include: - DIB: Full Frames (Uncompressed) - LAGS: Lagarith Lossless Codec - MJPG: M-JPG, aka Motion JPEG (say, Pegasus Imaging PicVideo M-JPEG) Links: - http://www.fourcc.org/ - http://www.microsoft.com/whdc/archive/fourcc.mspx - http://abcavi.kibi.ru/fourcc.php
Member Data Documentation
vtkAVIWriterInternal* vtkAVIWriter::Internals [protected] |
Definition at line 92 of file vtkAVIWriter.h.
int vtkAVIWriter::Rate [protected] |
Definition at line 94 of file vtkAVIWriter.h.
int vtkAVIWriter::Time [protected] |
Definition at line 95 of file vtkAVIWriter.h.
int vtkAVIWriter::Quality [protected] |
Definition at line 96 of file vtkAVIWriter.h.
int vtkAVIWriter::PromptCompressionOptions [protected] |
Definition at line 97 of file vtkAVIWriter.h.
char* vtkAVIWriter::CompressorFourCC [protected] |
Definition at line 98 of file vtkAVIWriter.h.
The documentation for this class was generated from the following file:
- dox/IO/vtkAVIWriter.h
