ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMAnimationSceneImageWriter Class Reference

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

#include <vtkSMAnimationSceneImageWriter.h>

Inheritance diagram for vtkSMAnimationSceneImageWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkSMAnimationSceneImageWriter:
Collaboration graph
[legend]

Public Types

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)
 
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 vtkSMAnimationSceneGetAnimationScene ()
 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 vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual void SetSession (vtkSMSession *)
 Get/Set the session on wihch this object exists. More...
 
virtual vtkSMSessionGetSession ()
 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 vtkSMAnimationSceneImageWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMAnimationSceneImageWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMAnimationSceneWriter
static int IsTypeOf (const char *type)
 
static vtkSMAnimationSceneWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

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 ()
 
virtual vtkImageData * CaptureViewImage (vtkSMViewProxy *, int magnification)
 Captures the view from the given module and returns a new Image data object. More...
 
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 *)
 
- 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 ()
 

Protected Attributes

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
 
vtkSMAnimationSceneAnimationScene
 
bool Saving
 
bool SaveFailed
 
char * FileName
 
double PlaybackTimeWindow [2]
 
int StartFileCount
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 
static void Merge (vtkImageData *dest, vtkImageData *src)
 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...
 
 ~vtkSMAnimationSceneImageWriter ()
 Convenience method used to merge a smaller image (src) into a larger one (dest). More...
 

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 42 of file vtkSMAnimationSceneImageWriter.h.

Member Typedef Documentation

§ Superclass

Definition at line 46 of file vtkSMAnimationSceneImageWriter.h.

Constructor & Destructor Documentation

§ vtkSMAnimationSceneImageWriter()

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::~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

§ New()

static vtkSMAnimationSceneImageWriter* vtkSMAnimationSceneImageWriter::New ( )
static

§ GetClassName()

virtual const char* vtkSMAnimationSceneImageWriter::GetClassName ( )
virtual

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMAnimationSceneWriter.

Reimplemented in pqAnimationSceneImageWriter.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetMagnification()

virtual void vtkSMAnimationSceneImageWriter::SetMagnification ( int  )
virtual

Set the magnification factor to use for the saved animation.

§ GetMagnification()

virtual int vtkSMAnimationSceneImageWriter::GetMagnification ( )
virtual

Set the magnification factor to use for the saved animation.

§ SetQuality()

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

§ GetQuality()

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

§ SetCompression()

virtual void vtkSMAnimationSceneImageWriter::SetCompression ( bool  )
virtual

Turns on(the default) or off compression.

Turning off compression overrides quality setting. NOTE: This only affects the FFMPEG backend.

§ GetCompression()

virtual bool vtkSMAnimationSceneImageWriter::GetCompression ( )
virtual

Turns on(the default) or off compression.

Turning off compression overrides quality setting. NOTE: This only affects the FFMPEG backend.

§ CompressionOn()

virtual void vtkSMAnimationSceneImageWriter::CompressionOn ( )
virtual

Turns on(the default) or off compression.

Turning off compression overrides quality setting. NOTE: This only affects the FFMPEG backend.

§ CompressionOff()

virtual void vtkSMAnimationSceneImageWriter::CompressionOff ( )
virtual

Turns on(the default) or off compression.

Turning off compression overrides quality setting. NOTE: This only affects the FFMPEG backend.

§ SetSubsampling()

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.

§ GetSubsampling()

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.

§ SubsamplingOn()

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.

§ SubsamplingOff()

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.

§ GetErrorCode()

virtual int vtkSMAnimationSceneImageWriter::GetErrorCode ( )
virtual

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

§ SetBackgroundColor() [1/2]

virtual void vtkSMAnimationSceneImageWriter::SetBackgroundColor ( double  ,
double  ,
double   
)
virtual

Get/Set the RGB background color to use to fill empty spaces in the image.

RGB components are in the range [0,1].

§ SetBackgroundColor() [2/2]

virtual void vtkSMAnimationSceneImageWriter::SetBackgroundColor ( double  [3])
virtual

Get/Set the RGB background color to use to fill empty spaces in the image.

RGB components are in the range [0,1].

§ GetBackgroundColor() [1/3]

virtual double* vtkSMAnimationSceneImageWriter::GetBackgroundColor ( )
virtual

Get/Set the RGB background color to use to fill empty spaces in the image.

RGB components are in the range [0,1].

§ GetBackgroundColor() [2/3]

virtual void vtkSMAnimationSceneImageWriter::GetBackgroundColor ( double &  ,
double &  ,
double &   
)
virtual

Get/Set the RGB background color to use to fill empty spaces in the image.

RGB components are in the range [0,1].

§ GetBackgroundColor() [3/3]

virtual void vtkSMAnimationSceneImageWriter::GetBackgroundColor ( double  [3])
virtual

Get/Set the RGB background color to use to fill empty spaces in the image.

RGB components are in the range [0,1].

§ SetFrameRate()

virtual void vtkSMAnimationSceneImageWriter::SetFrameRate ( double  )
virtual

§ GetFrameRate()

virtual double vtkSMAnimationSceneImageWriter::GetFrameRate ( )
virtual

§ Merge()

static void vtkSMAnimationSceneImageWriter::Merge ( vtkImageData *  dest,
vtkImageData *  src 
)
static

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.

§ SaveInitialize()

virtual bool vtkSMAnimationSceneImageWriter::SaveInitialize ( int  startCount)
protectedvirtual

Called to initialize saving.

Implements vtkSMAnimationSceneWriter.

§ SaveFrame()

virtual bool vtkSMAnimationSceneImageWriter::SaveFrame ( double  time)
protectedvirtual

Called to save a particular frame.

Implements vtkSMAnimationSceneWriter.

§ SaveFinalize()

virtual bool vtkSMAnimationSceneImageWriter::SaveFinalize ( )
protectedvirtual

Called to finalize saving.

Implements vtkSMAnimationSceneWriter.

§ CreateWriter()

bool vtkSMAnimationSceneImageWriter::CreateWriter ( )
protected

§ UpdateImageSize()

void vtkSMAnimationSceneImageWriter::UpdateImageSize ( )
protected

§ CaptureViewImage()

virtual vtkImageData* vtkSMAnimationSceneImageWriter::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 in pqAnimationSceneImageWriter.

§ NewFrame()

vtkImageData* vtkSMAnimationSceneImageWriter::NewFrame ( )
protected

§ SetActualSize() [1/2]

virtual void vtkSMAnimationSceneImageWriter::SetActualSize ( int  ,
int   
)
protectedvirtual

§ SetActualSize() [2/2]

void vtkSMAnimationSceneImageWriter::SetActualSize ( int  [2])
protected

§ SetPrefix()

virtual void vtkSMAnimationSceneImageWriter::SetPrefix ( const char *  )
protectedvirtual

§ SetSuffix()

virtual void vtkSMAnimationSceneImageWriter::SetSuffix ( const char *  )
protectedvirtual

§ SetImageWriter()

void vtkSMAnimationSceneImageWriter::SetImageWriter ( vtkImageWriter *  )
protected

§ SetMovieWriter()

void vtkSMAnimationSceneImageWriter::SetMovieWriter ( vtkGenericMovieWriter *  )
protected

Member Data Documentation

§ ActualSize

int vtkSMAnimationSceneImageWriter::ActualSize[2]
protected

Definition at line 162 of file vtkSMAnimationSceneImageWriter.h.

§ Quality

int vtkSMAnimationSceneImageWriter::Quality
protected

Definition at line 164 of file vtkSMAnimationSceneImageWriter.h.

§ Compression

bool vtkSMAnimationSceneImageWriter::Compression
protected

Definition at line 165 of file vtkSMAnimationSceneImageWriter.h.

§ Magnification

int vtkSMAnimationSceneImageWriter::Magnification
protected

Definition at line 166 of file vtkSMAnimationSceneImageWriter.h.

§ FileCount

int vtkSMAnimationSceneImageWriter::FileCount
protected

Definition at line 167 of file vtkSMAnimationSceneImageWriter.h.

§ ErrorCode

int vtkSMAnimationSceneImageWriter::ErrorCode
protected

Definition at line 168 of file vtkSMAnimationSceneImageWriter.h.

§ Subsampling

int vtkSMAnimationSceneImageWriter::Subsampling
protected

Definition at line 169 of file vtkSMAnimationSceneImageWriter.h.

§ Prefix

char* vtkSMAnimationSceneImageWriter::Prefix
protected

Definition at line 171 of file vtkSMAnimationSceneImageWriter.h.

§ Suffix

char* vtkSMAnimationSceneImageWriter::Suffix
protected

Definition at line 172 of file vtkSMAnimationSceneImageWriter.h.

§ BackgroundColor

double vtkSMAnimationSceneImageWriter::BackgroundColor[3]
protected

Definition at line 174 of file vtkSMAnimationSceneImageWriter.h.

§ FrameRate

double vtkSMAnimationSceneImageWriter::FrameRate
protected

Definition at line 177 of file vtkSMAnimationSceneImageWriter.h.

§ ImageWriter

vtkImageWriter* vtkSMAnimationSceneImageWriter::ImageWriter
protected

Definition at line 179 of file vtkSMAnimationSceneImageWriter.h.

§ MovieWriter

vtkGenericMovieWriter* vtkSMAnimationSceneImageWriter::MovieWriter
protected

Definition at line 180 of file vtkSMAnimationSceneImageWriter.h.


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