helper class used to write animations. More...

#include <vtkSMAnimationSceneWriter.h>

Inheritance diagram for vtkSMAnimationSceneWriter:

[legend]

Collaboration diagram for vtkSMAnimationSceneWriter:

[legend]

Public Types
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) override

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

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

virtual void	SetWriteTimeSteps (bool)
	Enable the writing of all timesteps. More...

virtual bool	GetWriteTimeSteps ()

virtual void	WriteTimeStepsOn ()

virtual void	WriteTimeStepsOff ()

void	SetFrameExporterDelegate (vtkSMExporterProxy *exporter)
	Set an exporter to use for single frame export. 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...


void	SetFrameWindow (int window[2])
	Use window to set PlaybackTimeWindow based on AnimationScene times. More...

void	SetFrameWindow (int min, int max)
	Use window to set PlaybackTimeWindow based on AnimationScene times. More...


virtual void	SetStride (int)
	Set/Get The stride which is used to extract the next frame. More...

virtual int	GetStride ()
	Set/Get The stride which is used to extract the next frame. More...

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

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 vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
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)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

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

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMAnimationSceneWriter ()

	~vtkSMAnimationSceneWriter () override

virtual bool	SaveInitialize (int countStart)=0
	Subclasses should override this method. More...

virtual bool	SaveFrame (double time)=0
	Subclasses should override this method. More...

virtual bool	SaveFinalize ()=0
	Subclasses should override this method. More...

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

vtkSMExporterProxy *	GetFrameExporterDelegate ()
	Return the Exporter to use for a single frame export, if any. More...

bool	AnimationEnabled ()
	Return true if the current configuration allows for animation export. More...

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
unsigned long	ObserverID

vtkSMAnimationScene *	AnimationScene

bool	Saving

bool	SaveFailed

char *	FileName

double	PlaybackTimeWindow [2]

int	StartFileCount

int	Stride = 1

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

helper class used to write animations.

vtkSMAnimationSceneWriter is an abstract superclass for writers that can write animations out.

If an animation scene is provided and WriteTimeSteps is true (default), it is expected to play the animation scene and output each frames. Otherwise (no animation scene or WriteTimeSteps to false), it outputs only the current frame.

The main work for a subclass is to implement SaveFrame, that will be called sequencially for each required frame.

Definition at line 30 of file vtkSMAnimationSceneWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMSessionObject vtkSMAnimationSceneWriter::Superclass

Definition at line 33 of file vtkSMAnimationSceneWriter.h.

Constructor & Destructor Documentation

◆ vtkSMAnimationSceneWriter()

vtkSMAnimationSceneWriter::vtkSMAnimationSceneWriter ( )

protected

◆ ~vtkSMAnimationSceneWriter()

vtkSMAnimationSceneWriter::~vtkSMAnimationSceneWriter ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSMAnimationSceneWriter::GetClassName ( )

virtual

Reimplemented from vtkSMSessionObject.

Reimplemented in vtkSMAnimationSceneGeometryWriter, vtkSMAnimationSceneSeriesWriter, and vtkSMAnimationSceneWebWriter.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMSessionObject.

Reimplemented in vtkSMAnimationSceneGeometryWriter, vtkSMAnimationSceneSeriesWriter, and vtkSMAnimationSceneWebWriter.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetAnimationScene() [1/2]

virtual void vtkSMAnimationSceneWriter::SetAnimationScene ( vtkSMProxy * )

virtual

Convenience method to set the proxy.

◆ SetAnimationScene() [2/2]

virtual void vtkSMAnimationSceneWriter::SetAnimationScene ( vtkSMAnimationScene * )

virtual

Get/Set the animation scene that this writer will write.

◆ GetAnimationScene()

virtual vtkSMAnimationScene* vtkSMAnimationSceneWriter::GetAnimationScene ( )

virtual

Get/Set the animation scene that this writer will write.

◆ Save()

bool vtkSMAnimationSceneWriter::Save ( )

Begin the saving.

If WriteTimeSteps is true, this will result in playing of the animation. Otherwise it juste save the current frame.

Returns the status of the save.

◆ SetWriteTimeSteps()

virtual void vtkSMAnimationSceneWriter::SetWriteTimeSteps ( bool )

virtual

Enable the writing of all timesteps.

When false, only current scene time is considered. Default is true.

◆ GetWriteTimeSteps()

virtual bool vtkSMAnimationSceneWriter::GetWriteTimeSteps ( )

virtual

◆ WriteTimeStepsOn()

virtual void vtkSMAnimationSceneWriter::WriteTimeStepsOn ( )

virtual

◆ WriteTimeStepsOff()

virtual void vtkSMAnimationSceneWriter::WriteTimeStepsOff ( )

virtual

◆ SetFileName()

virtual void vtkSMAnimationSceneWriter::SetFileName ( const char * )

virtual

Get/Set the filename.

◆ GetFileName()

virtual char* vtkSMAnimationSceneWriter::GetFileName ( )

virtual

Get/Set the filename.

◆ SetStartFileCount()

virtual void vtkSMAnimationSceneWriter::SetStartFileCount ( int )

virtual

Get/Set the start file count.

◆ GetStartFileCount()

virtual int vtkSMAnimationSceneWriter::GetStartFileCount ( )

virtual

Get/Set the start file count.