Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkWindowToImageFilter Class Reference

#include <vtkWindowToImageFilter.h>

Inheritance diagram for vtkWindowToImageFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkWindowToImageFilter:

Collaboration graph
[legend]
List of all members.

Detailed Description

Use a vtkWindow as input to image pipeline.

vtkWindowToImageFilter provides methods needed to read the data in a vtkWindow and use it as input to the imaging pipeline. This is useful for saving an image to a file for example. Use this filter to convert RenderWindows or ImageWindows to an image format.

Warning:
A vtkWindow doesn't behave like other parts of the VTK pipeline: its modification time doesn't get updated when an image is rendered. As a result, naive use of vtkWindowToImageFilter will produce an image of the first image that the window rendered, but which is never updated on subsequent window updates. This behavior is unexpected and in general undesirable.

To force an update of the output image, call vtkWindowToImageFilter's Modified method after rendering to the window.

In VTK versions 4 and later, this filter is part of the canonical way to output an image of a window to a file (replacing the obsolete SaveImageAsPPM method for vtkRenderWindows that existed in 3.2 and earlier). Connect this filter to the output of the window, and filter's output to a writer such as vtkPNGWriter.

See also:
vtkWindow
Created by:
  • Martin, Ken
CVS contributions (if > 5%):
  • Martin, Ken (69%)
  • Ayachit, Utkarsh (10%)
  • Cedilnik, Andy (5%)
CVS logs (CVSweb):
  • .h (/Rendering/vtkWindowToImageFilter.h)
  • .cxx (/Rendering/vtkWindowToImageFilter.cxx)
Examples:
vtkWindowToImageFilter (Examples)
Tests:
vtkWindowToImageFilter (Tests)

Definition at line 71 of file vtkWindowToImageFilter.h.

Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetInput (vtkWindow *input)
virtual vtkWindowGetInput ()
virtual void SetMagnification (int)
virtual int GetMagnification ()
virtual void ReadFrontBufferOn ()
virtual void ReadFrontBufferOff ()
virtual int GetReadFrontBuffer ()
virtual void SetReadFrontBuffer (int)
virtual void ShouldRerenderOn ()
virtual void ShouldRerenderOff ()
virtual void SetShouldRerender (int)
virtual int GetShouldRerender ()
virtual void SetViewport (double, double, double, double)
virtual void SetViewport (double[4])
virtual double * GetViewport ()
virtual void GetViewport (double data[4])

Static Public Member Functions

vtkWindowToImageFilterNew ()
int IsTypeOf (const char *type)
vtkWindowToImageFilterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkWindowToImageFilter ()
 ~vtkWindowToImageFilter ()
virtual void ExecuteInformation (vtkInformation *, vtkInformationVector *, vtkInformationVector *)
void ExecuteData (vtkDataObject *data)

Protected Attributes

vtkWindowInput
int Magnification
int ReadFrontBuffer
int ShouldRerender
double Viewport [4]


Member Typedef Documentation

typedef vtkImageAlgorithm vtkWindowToImageFilter::Superclass
 

Reimplemented from vtkImageAlgorithm.

Definition at line 76 of file vtkWindowToImageFilter.h.


Constructor & Destructor Documentation

vtkWindowToImageFilter::vtkWindowToImageFilter  )  [protected]
 

vtkWindowToImageFilter::~vtkWindowToImageFilter  )  [protected]
 


Member Function Documentation

vtkWindowToImageFilter* vtkWindowToImageFilter::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkWindowToImageFilter::GetClassName  )  [virtual]
 

Reimplemented from vtkImageAlgorithm.

int vtkWindowToImageFilter::IsTypeOf const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

virtual int vtkWindowToImageFilter::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

vtkWindowToImageFilter* vtkWindowToImageFilter::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkImageAlgorithm.

void vtkWindowToImageFilter::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 vtkImageAlgorithm.

void vtkWindowToImageFilter::SetInput vtkWindow input  ) 
 

Indicates what renderer to get the pixel data from.

virtual vtkWindow* vtkWindowToImageFilter::GetInput  )  [virtual]
 

Returns which renderer is being used as the source for the pixel data.

virtual void vtkWindowToImageFilter::SetMagnification int   )  [virtual]
 

The magnification of the current render window

virtual int vtkWindowToImageFilter::GetMagnification  )  [virtual]
 

The magnification of the current render window

virtual void vtkWindowToImageFilter::ReadFrontBufferOn  )  [virtual]
 

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void vtkWindowToImageFilter::ReadFrontBufferOff  )  [virtual]
 

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual int vtkWindowToImageFilter::GetReadFrontBuffer  )  [virtual]
 

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void vtkWindowToImageFilter::SetReadFrontBuffer int   )  [virtual]
 

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void vtkWindowToImageFilter::ShouldRerenderOn  )  [virtual]
 

Set/get whether to re-render the input window. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::ShouldRerenderOff  )  [virtual]
 

Set/get whether to re-render the input window. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetShouldRerender int   )  [virtual]
 

Set/get whether to re-render the input window. (This option makes no difference if Magnification > 1.)

virtual int vtkWindowToImageFilter::GetShouldRerender  )  [virtual]
 

Set/get whether to re-render the input window. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetViewport double  ,
double  ,
double  ,
double 
[virtual]
 

Set/get the extents to be used to generate the image. (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetViewport double  [4]  )  [virtual]
 

Set/get the extents to be used to generate the image. (This option does not work if Magnification > 1.)

virtual double* vtkWindowToImageFilter::GetViewport  )  [virtual]
 

Set/get the extents to be used to generate the image. (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::GetViewport double  data[4]  )  [virtual]
 

Set/get the extents to be used to generate the image. (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::ExecuteInformation vtkInformation ,
vtkInformationVector ,
vtkInformationVector
[protected, virtual]
 

Reimplemented from vtkImageAlgorithm.

void vtkWindowToImageFilter::ExecuteData vtkDataObject data  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

vtkWindow* vtkWindowToImageFilter::Input [protected]
 

Definition at line 122 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::Magnification [protected]
 

Definition at line 123 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::ReadFrontBuffer [protected]
 

Definition at line 124 of file vtkWindowToImageFilter.h.

int vtkWindowToImageFilter::ShouldRerender [protected]
 

Definition at line 125 of file vtkWindowToImageFilter.h.

double vtkWindowToImageFilter::Viewport[4] [protected]
 

Definition at line 126 of file vtkWindowToImageFilter.h.


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