Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkRendererSource Class Reference

take a renderer into the pipeline. More...

#include <vtkRendererSource.h>

Inheritance diagram for vtkRendererSource:

Inheritance graph
[legend]
Collaboration diagram for vtkRendererSource:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long GetMTime ()
virtual void SetInput (vtkRenderer *)
virtual vtkRendererGetInput ()
virtual void SetWholeWindow (int)
virtual int GetWholeWindow ()
virtual void WholeWindowOn ()
virtual void WholeWindowOff ()
virtual void SetRenderFlag (int)
virtual int GetRenderFlag ()
virtual void RenderFlagOn ()
virtual void RenderFlagOff ()
virtual void SetDepthValues (int)
virtual int GetDepthValues ()
virtual void DepthValuesOn ()
virtual void DepthValuesOff ()

Static Public Methods

vtkRendererSource * New ()
int IsTypeOf (const char *type)
vtkRendererSource * SafeDownCast (vtkObject *o)

Protected Methods

 vtkRendererSource ()
 ~vtkRendererSource ()
void Execute ()
void UpdateInformation ()

Protected Attributes

vtkRendererInput
int WholeWindow
int RenderFlag
int DepthValues

Detailed Description

take a renderer into the pipeline.

Date:
2001/10/11 13:38:25
Revision:
1.35

vtkRendererSource is a source object that gets its input from a renderer and converts it to structured points. This can then be used in a visualization pipeline. You must explicitly send a Modify() to this object to get it to reload its data from the renderer. Consider using vtkWindowToImageFilter instead of this class.

The data placed into the output is the renderer's image rgb values. Optionally, you can also grab the image depth (e.g., z-buffer) values, and place then into the output (point) field data.

See also:
vtkWindowToImageFilter vtkRenderer vtkStructuredPoints
Tests:
vtkRendererSource (Tests)

Definition at line 70 of file vtkRendererSource.h.


Constructor & Destructor Documentation

vtkRendererSource::vtkRendererSource   [protected]
 

vtkRendererSource::~vtkRendererSource   [protected]
 


Member Function Documentation

vtkRendererSource* vtkRendererSource::New   [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkStructuredPointsSource.

virtual const char* vtkRendererSource::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredPointsSource.

int vtkRendererSource::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredPointsSource.

virtual int vtkRendererSource::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredPointsSource.

vtkRendererSource* vtkRendererSource::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStructuredPointsSource.

void vtkRendererSource::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 vtkSource.

unsigned long vtkRendererSource::GetMTime   [virtual]
 

Return the MTime also considering the Renderer.

Reimplemented from vtkObject.

virtual void vtkRendererSource::SetInput vtkRenderer   [virtual]
 

Indicates what renderer to get the pixel data from.

virtual vtkRenderer* vtkRendererSource::GetInput   [virtual]
 

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

virtual void vtkRendererSource::SetWholeWindow int    [virtual]
 

Use the entire RenderWindow as a data source or just the Renderer. The default is zero, just the Renderer.

virtual int vtkRendererSource::GetWholeWindow   [virtual]
 

Use the entire RenderWindow as a data source or just the Renderer. The default is zero, just the Renderer.

virtual void vtkRendererSource::WholeWindowOn   [virtual]
 

Use the entire RenderWindow as a data source or just the Renderer. The default is zero, just the Renderer.

virtual void vtkRendererSource::WholeWindowOff   [virtual]
 

Use the entire RenderWindow as a data source or just the Renderer. The default is zero, just the Renderer.

virtual void vtkRendererSource::SetRenderFlag int    [virtual]
 

If this flag is on, the Executing causes a render first.

virtual int vtkRendererSource::GetRenderFlag   [virtual]
 

If this flag is on, the Executing causes a render first.

virtual void vtkRendererSource::RenderFlagOn   [virtual]
 

If this flag is on, the Executing causes a render first.

virtual void vtkRendererSource::RenderFlagOff   [virtual]
 

If this flag is on, the Executing causes a render first.

virtual void vtkRendererSource::SetDepthValues int    [virtual]
 

A boolean value to control whether to grab z-buffer (i.e., depth values) along with the image data. The z-buffer data is placed into the field data attributes.

virtual int vtkRendererSource::GetDepthValues   [virtual]
 

A boolean value to control whether to grab z-buffer (i.e., depth values) along with the image data. The z-buffer data is placed into the field data attributes.

virtual void vtkRendererSource::DepthValuesOn   [virtual]
 

A boolean value to control whether to grab z-buffer (i.e., depth values) along with the image data. The z-buffer data is placed into the field data attributes.

virtual void vtkRendererSource::DepthValuesOff   [virtual]
 

A boolean value to control whether to grab z-buffer (i.e., depth values) along with the image data. The z-buffer data is placed into the field data attributes.

void vtkRendererSource::Execute   [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

void vtkRendererSource::UpdateInformation   [protected, virtual]
 

Updates any global information about the data (like spacing for images)

Reimplemented from vtkSource.


Member Data Documentation

vtkRenderer* vtkRendererSource::Input [protected]
 

Definition at line 123 of file vtkRendererSource.h.

int vtkRendererSource::WholeWindow [protected]
 

Definition at line 124 of file vtkRendererSource.h.

int vtkRendererSource::RenderFlag [protected]
 

Definition at line 125 of file vtkRendererSource.h.

int vtkRendererSource::DepthValues [protected]
 

Definition at line 126 of file vtkRendererSource.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:41:32 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001