Documentation for vtkExporter

vtkExporter - abstract class to write a scene to a file

Super Class: vtkObject

Description:

vtkExporter is an abstract class that exports a scene to a file. It is very similar to vtkWriter except that a writer only writes out the geometric and topological data for an object, where an exporter can write out material properties, lighting, camera parameters etc. The concrete subclasses of this class may not write out all of this information. For example vtkOBJExporter writes out Wavefront obj files which do not include support for camera parameters. vtkExporter provides the convenience methods StartWrite() and EndWrite(). These methods are executed before and after execution of the Write() method. You can also specify arguments to these methods. This class defines SetInput and GetInput methods which take or return a vtkRenderWindow.

 

Caveats:

Every subclass of vtkExporter must implement a WriteData() method.

 

See Also:

vtkOBJExporter vtkRenderWindow vtkWriter

 

Methods:

void vtkExporter ()
void vtkExporter ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
void Write ()
void Update ()
void SetRenderWindow (vtkRenderWindow *)
vtkRenderWindow *GetRenderWindow ()
void SetInput (vtkRenderWindow *)
vtkRenderWindow *GetInput ()
void SetStartWrite (const )
void SetEndWrite (const )
void SetStartWriteArgDelete (const )
void SetEndWriteArgDelete (const )
unsigned long GetMTime ()
void WriteData ()

 

Detailed Method Descriptions:

Write data to output. Method executes subclasses WriteData() method, as well as StartWrite() and EndWrite() methods.

void Write ()

Convenient alias for Write() method.

void Update ()

Set/Get the rendering window that contains the scene to be written.

void SetRenderWindow (vtkRenderWindow *)
vtkRenderWindow *GetRenderWindow ()

These methods are provided for backward compatibility. Will disappear soon.

void SetInput (vtkRenderWindow *)
vtkRenderWindow *GetInput ()

Specify a function to be called before data is written. Function will be called with argument provided.

void SetStartWrite (const )

Specify a function to be called after data is written. Function will be called with argument provided.

void SetEndWrite (const )

Set the arg delete method. This is used to free user memory.

void SetStartWriteArgDelete (const )
void SetEndWriteArgDelete (const )

Returns the MTime also considering the RenderWindow.

unsigned long GetMTime ()