pqAnimationSceneImageWriter is a subclass of vtkSMAnimationSceneImageWriter which knows how to generate images from a plot view modules. More...

#include <pqAnimationSceneImageWriter.h>

Inheritance diagram for pqAnimationSceneImageWriter:

[legend]

Collaboration diagram for pqAnimationSceneImageWriter:

[legend]

Public Types
typedef vtkSMAnimationSceneImageWriter	Superclass

Public Types inherited from vtkSMAnimationSceneImageWriter
typedef vtkSMAnimationSceneWriter	Superclass

Public Types inherited from vtkSMAnimationSceneWriter
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkSMAnimationSceneImageWriter
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetFrameRate (double)

virtual double	GetFrameRate ()

virtual void	SetMagnification (int)
	Set the magnification factor to use for the saved animation. More...

virtual int	GetMagnification ()
	Set the magnification factor to use for the saved animation. More...

virtual void	SetQuality (int)
	Get/Set the quality for the generated movie. More...

virtual int	GetQuality ()
	Get/Set the quality for the generated movie. More...

virtual void	SetCompression (bool)
	Turns on(the default) or off compression. More...

virtual bool	GetCompression ()
	Turns on(the default) or off compression. More...

virtual void	CompressionOn ()
	Turns on(the default) or off compression. More...

virtual void	CompressionOff ()
	Turns on(the default) or off compression. More...

virtual void	SetSubsampling (int)
	Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. More...

virtual int	GetSubsampling ()
	Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. More...

virtual void	SubsamplingOn ()
	Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. More...

virtual void	SubsamplingOff ()
	Get/Set the setting whether the movie encoder should use subsampling of the chrome planes or not, if applicable. More...

virtual int	GetErrorCode ()
	Get the error code which is set if there's an error while writing the images. More...

virtual void	SetBackgroundColor (double, double, double)
	Get/Set the RGB background color to use to fill empty spaces in the image. More...

virtual void	SetBackgroundColor (double [3])
	Get/Set the RGB background color to use to fill empty spaces in the image. More...

virtual double *	GetBackgroundColor ()
	Get/Set the RGB background color to use to fill empty spaces in the image. More...

virtual void	GetBackgroundColor (double &, double &, double &)
	Get/Set the RGB background color to use to fill empty spaces in the image. More...

virtual void	GetBackgroundColor (double [3])
	Get/Set the RGB background color to use to fill empty spaces in the image. More...

Public Member Functions inherited from vtkSMAnimationSceneWriter
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetAnimationScene (vtkSMProxy *)
	Convenience method to set the proxy. More...

bool	Save ()
	Begin the saving. More...

virtual void	SetAnimationScene (vtkSMAnimationScene *)
	Get/Set the animation scene that this writer will write. More...

virtual vtkSMAnimationScene *	GetAnimationScene ()
	Get/Set the animation scene that this writer will write. More...

virtual void	SetFileName (const char *)
	Get/Set the filename. More...

virtual char *	GetFileName ()
	Get/Set the filename. More...

virtual void	SetStartFileCount (int)
	Get/Set the start file count. More...

virtual int	GetStartFileCount ()
	Get/Set the start file count. More...

virtual void	SetPlaybackTimeWindow (double, double)
	Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...

void	SetPlaybackTimeWindow (double [2])
	Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...

virtual double *	GetPlaybackTimeWindow ()
	Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...

virtual void	GetPlaybackTimeWindow (double &, double &)
	Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...

virtual void	GetPlaybackTimeWindow (double [2])
	Get/Set time window that we want to write If PlaybackTimeWindow[0] > PlaybackTimeWindow[1] that mean that we want to export the full time range available. More...

Public Member Functions inherited from vtkSMSessionObject
void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual void	SetSession (vtkSMSession *)
	Get/Set the session on wihch this object exists. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. More...

Public Member Functions inherited from vtkSMObject
void	PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions
static pqAnimationSceneImageWriter *	New ()

static int	IsTypeOf (const char *type)

static pqAnimationSceneImageWriter *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMAnimationSceneImageWriter *	SafeDownCast (vtkObject *o)

static void	Merge (vtkImageData dest, vtkImageData src)
	Convenience method used to merge a smaller image (`src`) into a larger one (`dest`). More...

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

static vtkSMAnimationSceneWriter *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

Protected Member Functions
	pqAnimationSceneImageWriter ()

	~pqAnimationSceneImageWriter ()

virtual vtkImageData *	CaptureViewImage (vtkSMViewProxy *, int magnification)
	Captures the view from the given module and returns a new Image data object. More...

Protected Member Functions inherited from vtkSMAnimationSceneImageWriter
virtual bool	SaveInitialize (int startCount)
	Called to initialize saving. More...

virtual bool	SaveFrame (double time)
	Called to save a particular frame. More...

virtual bool	SaveFinalize ()
	Called to finalize saving. More...

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

	vtkSMAnimationSceneImageWriter ()
	Convenience method used to merge a smaller image (`src`) into a larger one (`dest`). More...

	~vtkSMAnimationSceneImageWriter ()
	Convenience method used to merge a smaller image (`src`) into a larger one (`dest`). More...

Protected Member Functions inherited from vtkSMAnimationSceneWriter
	vtkSMAnimationSceneWriter ()

	~vtkSMAnimationSceneWriter ()

void	ExecuteEvent (vtkObject caller, unsigned long eventid, void calldata)

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject ()

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject ()

Additional Inherited Members
Protected Attributes inherited from vtkSMAnimationSceneImageWriter
int	ActualSize [2]

int	Quality

bool	Compression

int	Magnification

int	FileCount

int	ErrorCode

int	Subsampling

char *	Prefix

char *	Suffix

double	BackgroundColor [3]

double	FrameRate

vtkImageWriter *	ImageWriter

vtkGenericMovieWriter *	MovieWriter

Protected Attributes inherited from vtkSMAnimationSceneWriter
unsigned long	ObserverID

vtkSMAnimationScene *	AnimationScene

bool	Saving

bool	SaveFailed

char *	FileName

double	PlaybackTimeWindow [2]

int	StartFileCount

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session

Detailed Description

pqAnimationSceneImageWriter is a subclass of vtkSMAnimationSceneImageWriter which knows how to generate images from a plot view modules.

Definition at line 42 of file pqAnimationSceneImageWriter.h.

Member Typedef Documentation

§ Superclass

typedef vtkSMAnimationSceneImageWriter pqAnimationSceneImageWriter::Superclass

Definition at line 46 of file pqAnimationSceneImageWriter.h.

Constructor & Destructor Documentation

§ pqAnimationSceneImageWriter()

pqAnimationSceneImageWriter::pqAnimationSceneImageWriter ( )

protected

§ ~pqAnimationSceneImageWriter()

pqAnimationSceneImageWriter::~pqAnimationSceneImageWriter ( )

protected

Member Function Documentation

§ New()

static pqAnimationSceneImageWriter* pqAnimationSceneImageWriter::New ( )

static

§ GetClassName()

virtual const char* pqAnimationSceneImageWriter::GetClassName ( )

virtual

Reimplemented from vtkSMAnimationSceneImageWriter.

§ IsTypeOf()

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

static

§ IsA()

virtual int pqAnimationSceneImageWriter::IsA ( const char * type )

virtual

Reimplemented from vtkSMAnimationSceneImageWriter.

§ SafeDownCast()

static pqAnimationSceneImageWriter* pqAnimationSceneImageWriter::SafeDownCast ( vtkObject * o )

static

§ PrintSelf()

void pqAnimationSceneImageWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

§ CaptureViewImage()

virtual vtkImageData* pqAnimationSceneImageWriter::CaptureViewImage	(	vtkSMViewProxy *	,
		int	magnification
	)

protectedvirtual

Captures the view from the given module and returns a new Image data object.

May return NULL. Default implementation can only handle vtkSMViewProxy subclasses. Subclassess must override to handle other types of view modules.

Reimplemented from vtkSMAnimationSceneImageWriter.

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

/builddir/build/BUILD/ParaView-v5.2.0/Qt/Core/pqAnimationSceneImageWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

§ Superclass

Constructor & Destructor Documentation

§ pqAnimationSceneImageWriter()

§ ~pqAnimationSceneImageWriter()

Member Function Documentation

§ New()

§ GetClassName()

§ IsTypeOf()

§ IsA()

§ SafeDownCast()

§ PrintSelf()

§ CaptureViewImage()