vtkExporter Class Reference

#include <vtkExporter.h>

Inheritance diagram for vtkExporter:

Inheritance graph
[legend]
Collaboration diagram for vtkExporter:

Collaboration graph
[legend]

List of all members.


Detailed Description

abstract class to write a scene to a file

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.

Warning:
Every subclass of vtkExporter must implement a WriteData() method.
See also:
vtkOBJExporter vtkRenderWindow vtkWriter

Definition at line 44 of file vtkExporter.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Write ()
void Update ()
void SetStartWrite (void(*f)(void *), void *arg)
void SetEndWrite (void(*f)(void *), void *arg)
void SetStartWriteArgDelete (void(*f)(void *))
void SetEndWriteArgDelete (void(*f)(void *))
unsigned long GetMTime ()
virtual void SetRenderWindow (vtkRenderWindow *)
virtual vtkRenderWindowGetRenderWindow ()
void SetInput (vtkRenderWindow *renWin)
vtkRenderWindowGetInput ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkExporterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkExporter ()
 ~vtkExporter ()
virtual void WriteData ()=0

Protected Attributes

vtkRenderWindowRenderWindow
void(* StartWrite )(void *)
void(* StartWriteArgDelete )(void *)
void * StartWriteArg
void(* EndWrite )(void *)
void(* EndWriteArgDelete )(void *)
void * EndWriteArg

Member Typedef Documentation


Constructor & Destructor Documentation

vtkExporter::vtkExporter (  )  [protected]

vtkExporter::~vtkExporter (  )  [protected]


Member Function Documentation

virtual const char* vtkExporter::GetClassName (  )  [virtual]

static int vtkExporter::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkRIBExporter, vtkX3DExporter, vtkGL2PSExporter, vtkIVExporter, vtkOBJExporter, vtkOOGLExporter, vtkPOVExporter, and vtkVRMLExporter.

virtual int vtkExporter::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkRIBExporter, vtkX3DExporter, vtkGL2PSExporter, vtkIVExporter, vtkOBJExporter, vtkOOGLExporter, vtkPOVExporter, and vtkVRMLExporter.

static vtkExporter* vtkExporter::SafeDownCast ( vtkObject o  )  [static]

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkRIBExporter, vtkX3DExporter, vtkGL2PSExporter, vtkIVExporter, vtkOBJExporter, vtkOOGLExporter, vtkPOVExporter, and vtkVRMLExporter.

virtual void vtkExporter::Write (  )  [virtual]

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

void vtkExporter::Update (  ) 

Convenient alias for Write() method.

virtual void vtkExporter::SetRenderWindow ( vtkRenderWindow  )  [virtual]

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

virtual vtkRenderWindow* vtkExporter::GetRenderWindow (  )  [virtual]

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

void vtkExporter::SetInput ( vtkRenderWindow renWin  )  [inline]

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

Definition at line 66 of file vtkExporter.h.

vtkRenderWindow* vtkExporter::GetInput (  )  [inline]

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

Definition at line 67 of file vtkExporter.h.

void vtkExporter::SetStartWrite ( void(*)(void *)  f,
void *  arg 
)

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

void vtkExporter::SetEndWrite ( void(*)(void *)  f,
void *  arg 
)

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

void vtkExporter::SetStartWriteArgDelete ( void(*)(void *)  f  ) 

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

void vtkExporter::SetEndWriteArgDelete ( void(*)(void *)  f  ) 

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

unsigned long vtkExporter::GetMTime (  )  [virtual]

Returns the MTime also considering the RenderWindow.

Reimplemented from vtkObject.

virtual void vtkExporter::WriteData (  )  [protected, pure virtual]


Member Data Documentation

Definition at line 91 of file vtkExporter.h.

void(* vtkExporter::StartWrite)(void *) [protected]

void(* vtkExporter::StartWriteArgDelete)(void *) [protected]

void* vtkExporter::StartWriteArg [protected]

Definition at line 96 of file vtkExporter.h.

void(* vtkExporter::EndWrite)(void *) [protected]

void(* vtkExporter::EndWriteArgDelete)(void *) [protected]

void* vtkExporter::EndWriteArg [protected]

Definition at line 99 of file vtkExporter.h.


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

Generated on Wed Aug 24 11:35:31 2011 for VTK by  doxygen 1.5.6