vtkSMAnimationSceneWriter Class Reference

helper class used to write animations. More...

#include <vtkSMAnimationSceneWriter.h>

Inheritance diagram for vtkSMAnimationSceneWriter:

Collaboration diagram for vtkSMAnimationSceneWriter:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetAnimationScene (vtkSMProxy *)
bool	Save ()
virtual void	SetAnimationScene (vtkSMAnimationScene *)
virtual vtkSMAnimationScene *	GetAnimationScene ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSMAnimationSceneWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMAnimationSceneWriter ()
	~vtkSMAnimationSceneWriter ()
virtual bool	SaveInitialize ()=0
virtual bool	SaveFrame (double time)=0
virtual bool	SaveFinalize ()=0
void	ExecuteEvent (vtkObject *caller, unsigned long eventid, void *calldata)
Protected Attributes
unsigned long	ObserverID
vtkSMAnimationScene *	AnimationScene
bool	Saving
bool	SaveFailed
char *	FileName

---

Detailed Description

helper class used to write animations.

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

Definition at line 31 of file vtkSMAnimationSceneWriter.h.

---

Constructor & Destructor Documentation

vtkSMAnimationSceneWriter::vtkSMAnimationSceneWriter

(

)

[protected]

vtkSMAnimationSceneWriter::~vtkSMAnimationSceneWriter

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkSMAnimationSceneWriter::GetClassName

(

)

[virtual]

Reimplemented from vtkSMSessionObject.

Reimplemented in pqAnimationSceneImageWriter, vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

static int vtkSMAnimationSceneWriter::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkSMSessionObject.

Reimplemented in pqAnimationSceneImageWriter, vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

virtual int vtkSMAnimationSceneWriter::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkSMSessionObject.

Reimplemented in pqAnimationSceneImageWriter, vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

static vtkSMAnimationSceneWriter* vtkSMAnimationSceneWriter::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkSMSessionObject.

Reimplemented in pqAnimationSceneImageWriter, vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

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

Reimplemented from vtkSMSessionObject.

Reimplemented in pqAnimationSceneImageWriter, vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

virtual void vtkSMAnimationSceneWriter::SetAnimationScene

(

vtkSMProxy *

)

[virtual]

Convenience method to set the proxy.

virtual void vtkSMAnimationSceneWriter::SetAnimationScene

(

vtkSMAnimationScene *

)

[virtual]

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

virtual vtkSMAnimationScene* vtkSMAnimationSceneWriter::GetAnimationScene

(

)

[virtual]

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

bool vtkSMAnimationSceneWriter::Save

(

)

Begin the saving. This will result in playing of the animation. Returns the status of the save.

virtual void vtkSMAnimationSceneWriter::SetFileName

(

const char *

)

[virtual]

Get/Set the filename.

virtual char* vtkSMAnimationSceneWriter::GetFileName

(

)

[virtual]

Get/Set the filename.

virtual bool vtkSMAnimationSceneWriter::SaveInitialize

(

)

[protected, pure virtual]

Subclasses should override this method. Called to initialize saving.

Implemented in vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

virtual bool vtkSMAnimationSceneWriter::SaveFrame

(

double

time

)

[protected, pure virtual]

Subclasses should override this method. Called to save a particular frame.

Implemented in vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

virtual bool vtkSMAnimationSceneWriter::SaveFinalize

(

)

[protected, pure virtual]

Subclasses should override this method. Called to finalize saving.

Implemented in vtkSMAnimationSceneImageWriter, and vtkSMAnimationSceneGeometryWriter.

void vtkSMAnimationSceneWriter::ExecuteEvent	(	vtkObject *	caller,
		unsigned long	eventid,
		void *	calldata
	)		[protected]

---

Member Data Documentation

unsigned long vtkSMAnimationSceneWriter::ObserverID [protected]

Definition at line 60 of file vtkSMAnimationSceneWriter.h.

vtkSMAnimationScene* vtkSMAnimationSceneWriter::AnimationScene [protected]

Definition at line 61 of file vtkSMAnimationSceneWriter.h.

bool vtkSMAnimationSceneWriter::Saving [protected]

Definition at line 77 of file vtkSMAnimationSceneWriter.h.

bool vtkSMAnimationSceneWriter::SaveFailed [protected]

Definition at line 78 of file vtkSMAnimationSceneWriter.h.

char* vtkSMAnimationSceneWriter::FileName [protected]

Definition at line 79 of file vtkSMAnimationSceneWriter.h.

---

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

• dox/ParaViewCore/ServerManager/vtkSMAnimationSceneWriter.h