vtkRendererSource Class Reference

#include <vtkRendererSource.h>

Inheritance diagram for vtkRendererSource:

Inheritance graph
[legend]
Collaboration diagram for vtkRendererSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

take a renderer into the pipeline

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 44 of file vtkRendererSource.h.


Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long GetMTime ()
void SetInput (vtkRenderer *)
vtkImageDataGetOutput ()
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 ()
virtual void SetDepthValuesInScalars (int)
virtual int GetDepthValuesInScalars ()
virtual void DepthValuesInScalarsOn ()
virtual void DepthValuesInScalarsOff ()
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Static Public Member Functions

static vtkRendererSourceNew ()
static int IsTypeOf (const char *type)
static vtkRendererSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkRendererSource ()
 ~vtkRendererSource ()
void RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillOutputPortInformation (int port, vtkInformation *info)

Protected Attributes

vtkRendererInput
int WholeWindow
int RenderFlag
int DepthValues
int DepthValuesInScalars

Member Typedef Documentation

Reimplemented from vtkAlgorithm.

Definition at line 48 of file vtkRendererSource.h.


Constructor & Destructor Documentation

vtkRendererSource::vtkRendererSource (  )  [protected]

vtkRendererSource::~vtkRendererSource (  )  [protected]


Member Function Documentation

static vtkRendererSource* vtkRendererSource::New (  )  [static]

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkAlgorithm.

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

unsigned long vtkRendererSource::GetMTime (  )  [virtual]

Return the MTime also considering the Renderer.

Reimplemented from vtkObject.

void vtkRendererSource::SetInput ( vtkRenderer  ) 

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 a field data attributes named "ZBuffer" .

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 a field data attributes named "ZBuffer" .

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 a field data attributes named "ZBuffer" .

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 a field data attributes named "ZBuffer" .

virtual void vtkRendererSource::SetDepthValuesInScalars ( 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 in the scalars as a fourth Z component (shift and scaled to map the full 0..255 range).

virtual int vtkRendererSource::GetDepthValuesInScalars (  )  [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 in the scalars as a fourth Z component (shift and scaled to map the full 0..255 range).

virtual void vtkRendererSource::DepthValuesInScalarsOn (  )  [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 in the scalars as a fourth Z component (shift and scaled to map the full 0..255 range).

virtual void vtkRendererSource::DepthValuesInScalarsOff (  )  [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 in the scalars as a fourth Z component (shift and scaled to map the full 0..255 range).

vtkImageData* vtkRendererSource::GetOutput (  ) 

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

virtual int vtkRendererSource::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [virtual]

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

void vtkRendererSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected]

virtual void vtkRendererSource::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

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


Member Data Documentation

Definition at line 118 of file vtkRendererSource.h.

Definition at line 119 of file vtkRendererSource.h.

Definition at line 120 of file vtkRendererSource.h.

Definition at line 121 of file vtkRendererSource.h.

Definition at line 122 of file vtkRendererSource.h.


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

Generated on Wed Jun 3 19:31:23 2009 for VTK by  doxygen 1.5.6