VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkWindowToImageFilter Class Reference

Use a vtkWindow as input to image pipeline. More...

#include <vtkWindowToImageFilter.h>

Inheritance diagram for vtkWindowToImageFilter:
Inheritance graph
[legend]
Collaboration diagram for vtkWindowToImageFilter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkWindowToImageFilterNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void SetInput (vtkWindow *input)
vtkImageDataGetOutput ()
virtual vtkWindowGetInput ()
virtual void SetMagnification (int)
virtual int GetMagnification ()
virtual void SetFixBoundary (bool)
virtual bool GetFixBoundary ()
virtual void FixBoundaryOn ()
virtual void FixBoundaryOff ()
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 doubleGetViewport ()
virtual void GetViewport (double data[4])
virtual void SetInputBufferType (int)
virtual int GetInputBufferType ()
void SetInputBufferTypeToRGB ()
void SetInputBufferTypeToRGBA ()
void SetInputBufferTypeToZBuffer ()
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Static Public Member Functions

static vtkWindowToImageFilterNew ()
static int IsTypeOf (const char *type)
static vtkWindowToImageFilterSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkWindowToImageFilter ()
 ~vtkWindowToImageFilter ()
void RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
void Rescale2DActors ()
void Shift2DActors (int x, int y)
void Restore2DActors ()

Protected Attributes

vtkWindowInput
int Magnification
int ReadFrontBuffer
int ShouldRerender
double Viewport [4]
int InputBufferType
bool FixBoundary
vtkWTI2DHelperClass * StoredData

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. The window can be read as either RGB or RGBA pixels; in addition, the depth buffer can also be read. RGB and RGBA pixels are of type unsigned char, while Z-Buffer data is returned as floats. 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.
Reading back alpha planes is dependent on the correct operation of the render window's GetRGBACharPixelData method, which in turn is dependent on the configuration of the window's alpha planes. As of VTK 4.4+, machine-independent behavior is not automatically assured because of these dependencies.
See also:
vtkWindow vtkRenderLargeImage
Examples:
vtkWindowToImageFilter (Examples)
Tests:
vtkWindowToImageFilter (Tests)

Definition at line 75 of file vtkWindowToImageFilter.h.


Member Typedef Documentation

Reimplemented from vtkAlgorithm.

Definition at line 80 of file vtkWindowToImageFilter.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkAlgorithm.

static int vtkWindowToImageFilter::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 vtkAlgorithm.

virtual int vtkWindowToImageFilter::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 vtkAlgorithm.

Reimplemented from vtkAlgorithm.

virtual vtkObjectBase* vtkWindowToImageFilter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkAlgorithm.

Reimplemented from vtkAlgorithm.

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 vtkAlgorithm.

Indicates what renderer to get the pixel data from. Initial value is 0.

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

virtual void vtkWindowToImageFilter::SetMagnification ( int  ) [virtual]

The magnification of the current render window. Initial value is 1.

The magnification of the current render window. Initial value is 1.

virtual void vtkWindowToImageFilter::SetFixBoundary ( bool  ) [virtual]

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual bool vtkWindowToImageFilter::GetFixBoundary ( ) [virtual]

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual void vtkWindowToImageFilter::FixBoundaryOn ( ) [virtual]

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

virtual void vtkWindowToImageFilter::FixBoundaryOff ( ) [virtual]

When this->Magnification > 1, this class render the full image in tiles. Sometimes that results in artificial artifacts at internal tile seams. To overcome this issue, set this flag to true.

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.

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. Initial value is true. (This option makes no difference if Magnification > 1.)

virtual void vtkWindowToImageFilter::ShouldRerenderOff ( ) [virtual]

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

virtual void vtkWindowToImageFilter::SetShouldRerender ( int  ) [virtual]

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

Set/get whether to re-render the input window. Initial value is true. (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. Initial value is {0,0,1,1} (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. Initial value is {0,0,1,1} (This option does not work if Magnification > 1.)

Set/get the extents to be used to generate the image. Initial value is {0,0,1,1} (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. Initial value is {0,0,1,1} (This option does not work if Magnification > 1.)

virtual void vtkWindowToImageFilter::SetInputBufferType ( int  ) [virtual]

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Definition at line 138 of file vtkWindowToImageFilter.h.

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Definition at line 139 of file vtkWindowToImageFilter.h.

Set/get the window buffer from which data will be read. Choices include VTK_RGB (read the color image from the window), VTK_RGBA (same, but include the alpha channel), and VTK_ZBUFFER (depth buffer, returned as a float array). Initial value is VTK_RGB.

Definition at line 140 of file vtkWindowToImageFilter.h.

Get the output data object for a port on this algorithm.

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

virtual int vtkWindowToImageFilter::FillOutputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

void vtkWindowToImageFilter::Shift2DActors ( int  x,
int  y 
) [protected]

Member Data Documentation

Definition at line 159 of file vtkWindowToImageFilter.h.

Definition at line 160 of file vtkWindowToImageFilter.h.

Definition at line 161 of file vtkWindowToImageFilter.h.

Definition at line 162 of file vtkWindowToImageFilter.h.

Definition at line 163 of file vtkWindowToImageFilter.h.

Definition at line 164 of file vtkWindowToImageFilter.h.

Definition at line 165 of file vtkWindowToImageFilter.h.

vtkWTI2DHelperClass* vtkWindowToImageFilter::StoredData [protected]

Definition at line 181 of file vtkWindowToImageFilter.h.


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