helper class to write animation images/movies. More...

#include <vtkSMAnimationSceneImageWriter.h>

Inheritance diagram for vtkSMAnimationSceneImageWriter:

Collaboration diagram for vtkSMAnimationSceneImageWriter:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetFrameRate (double)
virtual double	GetFrameRate ()

virtual void	SetMagnification (int)
virtual int	GetMagnification ()

virtual void	SetQuality (int)
virtual int	GetQuality ()

virtual void	SetSubsampling (int)
virtual int	GetSubsampling ()
virtual void	SubsamplingOn ()
virtual void	SubsamplingOff ()

virtual int	GetErrorCode ()

virtual void	SetBackgroundColor (double, double, double)
virtual void	SetBackgroundColor (double[3])
virtual double *	GetBackgroundColor ()
virtual void	GetBackgroundColor (double &, double &, double &)
virtual void	GetBackgroundColor (double[3])
Static Public Member Functions
static vtkSMAnimationSceneImageWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkSMAnimationSceneImageWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
virtual bool	SaveInitialize ()
virtual bool	SaveFrame (double time)
virtual bool	SaveFinalize ()
bool	CreateWriter ()
void	UpdateImageSize ()
vtkImageData *	NewFrame ()
virtual void	SetActualSize (int, int)
void	SetActualSize (int[2])
virtual void	SetPrefix (const char *)
virtual void	SetSuffix (const char *)
void	SetImageWriter (vtkImageWriter *)
void	SetMovieWriter (vtkGenericMovieWriter *)

virtual vtkImageData *	CaptureViewImage (vtkSMViewProxy *, int magnification)
Protected Attributes
int	ActualSize [2]
int	Quality
int	Magnification
int	FileCount
int	ErrorCode
int	Subsampling
char *	Prefix
char *	Suffix
double	BackgroundColor [3]
double	FrameRate
vtkImageWriter *	ImageWriter
vtkGenericMovieWriter *	MovieWriter
static void	Merge (vtkImageData dest, vtkImageData src)
	vtkSMAnimationSceneImageWriter ()
	~vtkSMAnimationSceneImageWriter ()

Detailed Description

helper class to write animation images/movies.

vtkSMAnimationSceneImageWriter is a concrete implementation of vtkSMAnimationSceneWriter that can write movies or images. The generated output's size and alignment is exactly as specified on the GUISize, WindowPosition properties of the view modules. One can optionally specify Magnification to scale the output.

Attention:: This class does not support changing the dimensions of the view, one has to do that before calling Save(). It only provides Magnification which can scale the size using integral scale factor.

Definition at line 40 of file vtkSMAnimationSceneImageWriter.h.

Constructor & Destructor Documentation

vtkSMAnimationSceneImageWriter::vtkSMAnimationSceneImageWriter ( ) [protected]

Convenience method used to merge a smaller image (src) into a larger one (dest). The location of the smaller image in the larger image are determined by their extents.

vtkSMAnimationSceneImageWriter::~vtkSMAnimationSceneImageWriter ( ) [protected]

Convenience method used to merge a smaller image (src) into a larger one (dest). The location of the smaller image in the larger image are determined by their extents.

Member Function Documentation

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

Reimplemented from vtkSMSessionObject.

Reimplemented in pqAnimationSceneImageWriter.

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

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

static int vtkSMAnimationSceneImageWriter::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

virtual int vtkSMAnimationSceneImageWriter::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

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

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

void vtkSMAnimationSceneImageWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

virtual void vtkSMAnimationSceneImageWriter::SetMagnification ( int ) [virtual]

Set the magnification factor to use for the saved animation.

virtual int vtkSMAnimationSceneImageWriter::GetMagnification ( ) [virtual]

Set the magnification factor to use for the saved animation.

virtual void vtkSMAnimationSceneImageWriter::SetQuality ( int ) [virtual]

Get/Set the quality for the generated movie. Applicable only if the choose file format supports it. 0 means worst quality and smallest file size 2 means best quality and largest file size

virtual int vtkSMAnimationSceneImageWriter::GetQuality ( ) [virtual]

Get/Set the quality for the generated movie. Applicable only if the choose file format supports it. 0 means worst quality and smallest file size 2 means best quality and largest file size

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

Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. Since the human eye is more sensitive to brightness than color variations, subsampling can be useful to reduce the bitrate. Default value is 0.

virtual int vtkSMAnimationSceneImageWriter::GetSubsampling ( ) [virtual]

Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. Since the human eye is more sensitive to brightness than color variations, subsampling can be useful to reduce the bitrate. Default value is 0.

virtual void vtkSMAnimationSceneImageWriter::SubsamplingOn ( ) [virtual]

Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. Since the human eye is more sensitive to brightness than color variations, subsampling can be useful to reduce the bitrate. Default value is 0.

virtual void vtkSMAnimationSceneImageWriter::SubsamplingOff ( ) [virtual]

Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. Since the human eye is more sensitive to brightness than color variations, subsampling can be useful to reduce the bitrate. Default value is 0.

virtual int vtkSMAnimationSceneImageWriter::GetErrorCode ( ) [virtual]

Get the error code which is set if there's an error while writing the images.

virtual void vtkSMAnimationSceneImageWriter::SetBackgroundColor	(	double	,
		double	,
		double
	)		`[virtual]`