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

Writes Windows AVI files. More...

#include <vtkAVIWriter.h>

Inheritance diagram for vtkAVIWriter:
[legend]
Collaboration diagram for vtkAVIWriter:
[legend]

List of all members.

Public Types

typedef vtkGenericMovieWriter Superclass
- Public Types inherited from vtkGenericMovieWriter
enum  MovieWriterErrorIds {
  UserError = 40000, InitError, NoInputError, CanNotCompress,
  CanNotFormat, ChangedResolutionError
}
- Public Types inherited from vtkProcessObject
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

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 ()
- Public Member Functions inherited from vtkGenericMovieWriter
virtual void SetInput (vtkImageData *input)
virtual vtkImageDataGetInput ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual int GetError ()
- Public Member Functions inherited from vtkProcessObject
void SqueezeInputArray ()
void RemoveAllInputs ()
vtkDataObject ** GetInputs ()
int GetNumberOfInputs ()
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetNumberOfInputConnections (int port, int n)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
vtkDataObjectGetOutputDataObject (int port)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkAVIWriterNew ()
static int IsTypeOf (const char *type)
static vtkAVIWriterSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkGenericMovieWriter
static const char * GetStringFromErrorCode (unsigned long event)

Protected Member Functions

 vtkAVIWriter ()
 ~vtkAVIWriter ()
- Protected Member Functions inherited from vtkGenericMovieWriter
 vtkGenericMovieWriter ()
 ~vtkGenericMovieWriter ()
- Protected Member Functions inherited from vtkProcessObject
void SetNumberOfInputs (int num)
virtual void SetNthInput (int num, vtkDataObject *input)
virtual void AddInput (vtkDataObject *input)
virtual void RemoveInput (vtkDataObject *input)
virtual void ReportReferences (vtkGarbageCollector *)
virtual int FillInputPortInformation (int, vtkInformation *)
virtual int FillOutputPortInformation (int, vtkInformation *)
void AddInputInternal (vtkDataObject *input)
void RemoveInputInternal (vtkDataObject *input)
void SetupInputs ()
 vtkProcessObject ()
 ~vtkProcessObject ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkAVIWriterInternal * Internals
int Rate
int Time
int Quality
int PromptCompressionOptions
char * CompressorFourCC
- Protected Attributes inherited from vtkGenericMovieWriter
char * FileName
int Error
- Protected Attributes inherited from vtkProcessObject
int NumberOfInputs
int NumberOfRequiredInputs
vtkDataObject ** Inputs
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.


Member Typedef Documentation

Reimplemented from vtkGenericMovieWriter.

Definition at line 39 of file vtkAVIWriter.h.


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: