vtkOggTheoraWriter Class Reference

#include <vtkOggTheoraWriter.h>

Inheritance diagram for vtkOggTheoraWriter:

Inheritance graph
[legend]
Collaboration diagram for vtkOggTheoraWriter:

Collaboration graph
[legend]

List of all members.


Detailed Description

Uses the ogg and theora libraries to write video files.

vtkOggTheoraWriter is an adapter that allows VTK to use the ogg and theora libraries to write movie files. This class creates .ogv files containing theora encoded video without audio.

This implementation is based on vtkFFMPEGWriter and uses some code derived from the encoder example distributed with libtheora.

Tests:
vtkOggTheoraWriter (Tests)

Definition at line 38 of file vtkOggTheoraWriter.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 SetQuality (int)
virtual int GetQuality ()
virtual void SetRate (int)
virtual int GetRate ()
virtual void SetSubsampling (int)
virtual int GetSubsampling ()
virtual void SubsamplingOn ()
virtual void SubsamplingOff ()

Static Public Member Functions

static vtkOggTheoraWriterNew ()
static int IsTypeOf (const char *type)
static vtkOggTheoraWriterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkOggTheoraWriter ()
 ~vtkOggTheoraWriter ()

Protected Attributes

vtkOggTheoraWriterInternal * Internals
int Initialized
int Quality
int Rate
int Subsampling

Member Typedef Documentation

Reimplemented from vtkGenericMovieWriter.

Definition at line 42 of file vtkOggTheoraWriter.h.


Constructor & Destructor Documentation

vtkOggTheoraWriter::vtkOggTheoraWriter (  )  [protected]

vtkOggTheoraWriter::~vtkOggTheoraWriter (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkGenericMovieWriter.

static int vtkOggTheoraWriter::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 vtkOggTheoraWriter::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 vtkOggTheoraWriter* vtkOggTheoraWriter::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkGenericMovieWriter.

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

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

Implements vtkGenericMovieWriter.

void vtkOggTheoraWriter::Write (  )  [virtual]

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

Implements vtkGenericMovieWriter.

void vtkOggTheoraWriter::End (  )  [virtual]

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

Implements vtkGenericMovieWriter.

virtual void vtkOggTheoraWriter::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 vtkOggTheoraWriter::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 vtkOggTheoraWriter::SetRate ( int   )  [virtual]

Set/Get the frame rate, in frame/s.

virtual int vtkOggTheoraWriter::GetRate (  )  [virtual]

Set/Get the frame rate, in frame/s.

virtual void vtkOggTheoraWriter::SetSubsampling ( int   )  [virtual]

Is the video to be encoded using 4:2:0 subsampling?

virtual int vtkOggTheoraWriter::GetSubsampling (  )  [virtual]

Is the video to be encoded using 4:2:0 subsampling?

virtual void vtkOggTheoraWriter::SubsamplingOn (  )  [virtual]

Is the video to be encoded using 4:2:0 subsampling?

virtual void vtkOggTheoraWriter::SubsamplingOff (  )  [virtual]

Is the video to be encoded using 4:2:0 subsampling?


Member Data Documentation

vtkOggTheoraWriterInternal* vtkOggTheoraWriter::Internals [protected]

Definition at line 76 of file vtkOggTheoraWriter.h.

Definition at line 78 of file vtkOggTheoraWriter.h.

int vtkOggTheoraWriter::Quality [protected]

Definition at line 79 of file vtkOggTheoraWriter.h.

int vtkOggTheoraWriter::Rate [protected]

Definition at line 80 of file vtkOggTheoraWriter.h.

Definition at line 81 of file vtkOggTheoraWriter.h.


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

Generated on Mon Sep 27 18:36:40 2010 for VTK by  doxygen 1.5.6