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

take a renderer into the pipeline More...

#include <vtkRendererSource.h>

Inheritance diagram for vtkRendererSource:
[legend]
Collaboration diagram for vtkRendererSource:
[legend]

List of all members.

Public Types

typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

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 *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkRendererSourceNew ()
static int IsTypeOf (const char *type)
static vtkRendererSourceSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkAlgorithm
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKeyINPUT_PORT ()
static vtkInformationIntegerKeyINPUT_CONNECTION ()
static vtkInformationIntegerKeyPRESERVES_DATASET ()
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
static vtkInformationIntegerKeyPRESERVES_RANGES ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

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 Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkRendererInput
int WholeWindow
int RenderFlag
int DepthValues
int DepthValuesInScalars
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype

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.


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 vtkTypeMacro 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 vtkTypeMacro 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  
)
protectedvirtual
virtual int vtkRendererSource::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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

vtkRenderer* vtkRendererSource::Input
protected

Definition at line 118 of file vtkRendererSource.h.

int vtkRendererSource::WholeWindow
protected

Definition at line 119 of file vtkRendererSource.h.

int vtkRendererSource::RenderFlag
protected

Definition at line 120 of file vtkRendererSource.h.

int vtkRendererSource::DepthValues
protected

Definition at line 121 of file vtkRendererSource.h.

int vtkRendererSource::DepthValuesInScalars
protected

Definition at line 122 of file vtkRendererSource.h.


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