vtkMPEG2Writer Class Reference

#include <vtkMPEG2Writer.h>

Inheritance diagram for vtkMPEG2Writer:

[legend]Collaboration diagram for vtkMPEG2Writer:

[legend]List of all members.

---

Detailed Description

Writes MPEG2 Movie files.

vtkMPEG2Writer writes Movie files. The data type of the file is unsigned char regardless of the input type.

This class is conditionally compiled into VTK only if VTK's CMake option VTK_USE_MPEG2_ENCODER is ON. It is OFF by default.

Portions of the mpeg2 library are patented. VTK does not enable linking to this library by default so VTK can remain "patent free". Users who wish to link in mpeg2 functionality must build that library separately and then turn on VTK_USE_MPEG2_ENCODER when configuring VTK. After turning on VTK_USE_MPEG2_ENCODER, you must also set the CMake variables vtkMPEG2Encode_INCLUDE_PATH and vtkMPEG2Encode_LIBRARIES.

You are solely responsible for any legal issues associated with using patented code in your software.

You can download a "CMake-ified" source tree of the MPEG2 library by visiting the download page at http://www.vtk.org and scrolling down to the "Download Additional Components" section.

See also:

vtkGenericMovieWriter vtkAVIWriter vtkFFMPEGWriter

Tests:

vtkMPEG2Writer (Tests)

Definition at line 55 of file vtkMPEG2Writer.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 ()
Static Public Member Functions
static vtkMPEG2Writer *	New ()
static int	IsTypeOf (const char *type)
static vtkMPEG2Writer *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkMPEG2Writer ()
	~vtkMPEG2Writer ()
void	Initialize ()
Protected Attributes
vtkMPEG2WriterInternal *	Internals
long	Time
int	ActualWrittenTime
int	Initialized
MPEG2_structure *	MPEGStructure

---

Member Typedef Documentation

typedef vtkGenericMovieWriter vtkMPEG2Writer::Superclass

Reimplemented from vtkGenericMovieWriter. Definition at line 59 of file vtkMPEG2Writer.h.

---

Constructor & Destructor Documentation

vtkMPEG2Writer::vtkMPEG2Writer (   )  [protected]

vtkMPEG2Writer::~vtkMPEG2Writer (   )  [protected]

---

Member Function Documentation

static vtkMPEG2Writer* vtkMPEG2Writer::New (   )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkAlgorithm.

virtual const char* vtkMPEG2Writer::GetClassName (   )  [virtual]

Reimplemented from vtkGenericMovieWriter.

static int vtkMPEG2Writer::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkGenericMovieWriter.

virtual int vtkMPEG2Writer::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkGenericMovieWriter.

static vtkMPEG2Writer* vtkMPEG2Writer::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkGenericMovieWriter.

void vtkMPEG2Writer::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 vtkMPEG2Writer::Start (   )  [virtual]

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

void vtkMPEG2Writer::Write (   )  [virtual]

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

void vtkMPEG2Writer::End (   )  [virtual]

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

void vtkMPEG2Writer::Initialize (   )  [protected]

---

Member Data Documentation

vtkMPEG2WriterInternal* vtkMPEG2Writer::Internals [protected]

Definition at line 74 of file vtkMPEG2Writer.h.

long vtkMPEG2Writer::Time [protected]

Definition at line 76 of file vtkMPEG2Writer.h.

int vtkMPEG2Writer::ActualWrittenTime [protected]

Definition at line 77 of file vtkMPEG2Writer.h.

int vtkMPEG2Writer::Initialized [protected]

Definition at line 81 of file vtkMPEG2Writer.h.

MPEG2_structure* vtkMPEG2Writer::MPEGStructure [protected]

Definition at line 83 of file vtkMPEG2Writer.h.

---

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

• dox/IO/vtkMPEG2Writer.h

---