Writes Windows AVI files. More...

#include <vtkAVIWriter.h>

Inheritance diagram for vtkAVIWriter:

Collaboration diagram for vtkAVIWriter:

Public Types
typedef vtkGenericMovieWriter	Superclass

Public Types inherited from vtkGenericMovieWriter
enum	MovieWriterErrorIds { UserError = 40000, InitError, NoInputError, CanNotCompress, CanNotFormat, ChangedResolutionError }

typedef vtkImageAlgorithm	Superclass

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAVIWriter *	NewInstance () const

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
vtkGenericMovieWriter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

virtual int	GetError ()

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const

vtkImageData *	GetOutput ()

vtkImageData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

vtkImageData *	GetImageDataInput (int port)

virtual void	AddInputData (vtkDataObject *)

virtual void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkAVIWriter *	New ()

static int	IsTypeOf (const char *type)

static vtkAVIWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkGenericMovieWriter
static int	IsTypeOf (const char *type)

static vtkGenericMovieWriter *	SafeDownCast (vtkObjectBase *o)

static const char *	GetStringFromErrorCode (unsigned long event)

Static Public Member Functions inherited from vtkImageAlgorithm
static int	IsTypeOf (const char *type)

static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAVIWriter ()

	~vtkAVIWriter ()

Protected Member Functions inherited from vtkGenericMovieWriter
	vtkGenericMovieWriter ()

	~vtkGenericMovieWriter ()

Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()

	~vtkImageAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual void	CopyInputArrayAttributesToOutput (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	ExecuteDataWithInformation (vtkDataObject output, vtkInformation outInfo)

virtual void	ExecuteData (vtkDataObject *output)

virtual void	Execute ()

virtual void	AllocateOutputData (vtkImageData out, vtkInformation outInfo, int *uExtent)

virtual vtkImageData *	AllocateOutputData (vtkDataObject out, vtkInformation outInfo)

virtual void	CopyAttributeData (vtkImageData in, vtkImageData out, vtkInformationVector **inputVector)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

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 vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

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 &)

	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 vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 36 of file vtkAVIWriter.h.

Member Typedef Documentation

typedef vtkGenericMovieWriter vtkAVIWriter::Superclass

Definition at line 40 of file vtkAVIWriter.h.

Constructor & Destructor Documentation

vtkAVIWriter::vtkAVIWriter ( )

protected

vtkAVIWriter::~vtkAVIWriter ( )

protected

Member Function Documentation

static vtkAVIWriter* vtkAVIWriter::New ( )

static

static int vtkAVIWriter::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkAVIWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGenericMovieWriter.

vtkAVIWriter* vtkAVIWriter::NewInstance ( ) const

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 vtkImageAlgorithm.

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 93 of file vtkAVIWriter.h.

int vtkAVIWriter::Rate

protected

Definition at line 95 of file vtkAVIWriter.h.

int vtkAVIWriter::Time

protected

Definition at line 96 of file vtkAVIWriter.h.

int vtkAVIWriter::Quality

protected

Definition at line 97 of file vtkAVIWriter.h.

int vtkAVIWriter::PromptCompressionOptions

protected

Definition at line 98 of file vtkAVIWriter.h.

char* vtkAVIWriter::CompressorFourCC

protected

Definition at line 99 of file vtkAVIWriter.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Movie/vtkAVIWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation