VTK  9.3.20241008
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWindowToImageFilter Class Reference

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

#include <vtkWindowToImageFilter.h>

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

Public Types

typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkWindowToImageFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetInput (vtkWindow *input)
 Indicates what renderer to get the pixel data from.
 
void SetScale (int scale)
 Convenience method to set same scale factors for x and y.
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
 
virtual vtkWindowGetInput ()
 Returns which renderer is being used as the source for the pixel data.
 
virtual void SetScale (int, int)
 Get/Set the scale (or magnification) factors in X and Y.
 
void SetScale (int[2])
 Get/Set the scale (or magnification) factors in X and Y.
 
virtual int * GetScale ()
 Get/Set the scale (or magnification) factors in X and Y.
 
virtual void GetScale (int &, int &)
 Get/Set the scale (or magnification) factors in X and Y.
 
virtual void GetScale (int[2])
 Get/Set the scale (or magnification) factors in X and Y.
 
virtual void SetFixBoundary (bool)
 When scale factor > 1, this class render the full image in tiles.
 
virtual bool GetFixBoundary ()
 When scale factor > 1, this class render the full image in tiles.
 
virtual void FixBoundaryOn ()
 When scale factor > 1, this class render the full image in tiles.
 
virtual void FixBoundaryOff ()
 When scale factor > 1, this class render the full image in tiles.
 
virtual void ReadFrontBufferOn ()
 Set/Get the flag that determines which buffer to read from.
 
virtual void ReadFrontBufferOff ()
 Set/Get the flag that determines which buffer to read from.
 
virtual vtkTypeBool GetReadFrontBuffer ()
 Set/Get the flag that determines which buffer to read from.
 
virtual void SetReadFrontBuffer (vtkTypeBool)
 Set/Get the flag that determines which buffer to read from.
 
virtual void ShouldRerenderOn ()
 Set/get whether to re-render the input window.
 
virtual void ShouldRerenderOff ()
 Set/get whether to re-render the input window.
 
virtual void SetShouldRerender (vtkTypeBool)
 Set/get whether to re-render the input window.
 
virtual vtkTypeBool GetShouldRerender ()
 Set/get whether to re-render the input window.
 
void SetViewport (double, double, double, double)
 Set/get the extents to be used to generate the image.
 
void SetViewport (double *)
 Set/get the extents to be used to generate the image.
 
virtual double * GetViewport ()
 Set/get the extents to be used to generate the image.
 
virtual void GetViewport (double data[4])
 Set/get the extents to be used to generate the image.
 
virtual void SetInputBufferType (int)
 Set/get the window buffer from which data will be read.
 
virtual int GetInputBufferType ()
 Set/get the window buffer from which data will be read.
 
void SetInputBufferTypeToRGB ()
 Set/get the window buffer from which data will be read.
 
void SetInputBufferTypeToRGBA ()
 Set/get the window buffer from which data will be read.
 
void SetInputBufferTypeToZBuffer ()
 Set/get the window buffer from which data will be read.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual VTK_UNBLOCKTHREADS void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkWindowToImageFilterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWindowToImageFilterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWindowToImageFilter ()
 
 ~vtkWindowToImageFilter () override
 
void RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
virtual void Render ()
 Allows subclasses to customize how a request for render is handled.
 
void Rescale2DActors ()
 
void Shift2DActors (int x, int y)
 
void Restore2DActors ()
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkWindowInput
 
int Scale [2]
 
vtkTypeBool ReadFrontBuffer
 
vtkTypeBool ShouldRerender
 
double Viewport [4]
 
int InputBufferType
 
bool FixBoundary
 
vtkWTI2DHelperClass * StoredData
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

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
vtkRendererSource vtkRendererPointCloudSource vtkWindow vtkRenderLargeImage
Examples:
vtkWindowToImageFilter (Examples)
Online Examples:

Tests:
vtkWindowToImageFilter (Tests)

Definition at line 175 of file vtkWindowToImageFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 180 of file vtkWindowToImageFilter.h.

Constructor & Destructor Documentation

◆ vtkWindowToImageFilter()

vtkWindowToImageFilter::vtkWindowToImageFilter ( )
protected

◆ ~vtkWindowToImageFilter()

vtkWindowToImageFilter::~vtkWindowToImageFilter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWindowToImageFilter * vtkWindowToImageFilter::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkWindowToImageFilter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkWindowToImageFilter * vtkWindowToImageFilter::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkWindowToImageFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAlgorithm.

◆ NewInstance()

vtkWindowToImageFilter * vtkWindowToImageFilter::NewInstance ( ) const

◆ PrintSelf()

void vtkWindowToImageFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetInput()

void vtkWindowToImageFilter::SetInput ( vtkWindow input)

Indicates what renderer to get the pixel data from.

Initial value is 0.

◆ GetInput()

virtual vtkWindow * vtkWindowToImageFilter::GetInput ( )
virtual

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

Initial value is 0.

◆ SetScale() [1/3]

virtual void vtkWindowToImageFilter::SetScale ( int  ,
int   
)
virtual

Get/Set the scale (or magnification) factors in X and Y.

◆ SetScale() [2/3]

void vtkWindowToImageFilter::SetScale ( int  [2])

Get/Set the scale (or magnification) factors in X and Y.

◆ GetScale() [1/3]

virtual int * vtkWindowToImageFilter::GetScale ( )
virtual

Get/Set the scale (or magnification) factors in X and Y.

◆ GetScale() [2/3]

virtual void vtkWindowToImageFilter::GetScale ( int &  ,
int &   
)
virtual

Get/Set the scale (or magnification) factors in X and Y.

◆ GetScale() [3/3]

virtual void vtkWindowToImageFilter::GetScale ( int  [2])
virtual

Get/Set the scale (or magnification) factors in X and Y.

◆ SetScale() [3/3]

void vtkWindowToImageFilter::SetScale ( int  scale)
inline

Convenience method to set same scale factors for x and y.

i.e. same as calling this->SetScale(scale, scale).

Definition at line 208 of file vtkWindowToImageFilter.h.

◆ SetFixBoundary()

virtual void vtkWindowToImageFilter::SetFixBoundary ( bool  )
virtual

When scale factor > 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.

◆ GetFixBoundary()

virtual bool vtkWindowToImageFilter::GetFixBoundary ( )
virtual

When scale factor > 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.

◆ FixBoundaryOn()

virtual void vtkWindowToImageFilter::FixBoundaryOn ( )
virtual

When scale factor > 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.

◆ FixBoundaryOff()

virtual void vtkWindowToImageFilter::FixBoundaryOff ( )
virtual

When scale factor > 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.

◆ ReadFrontBufferOn()

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.

◆ ReadFrontBufferOff()

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.

◆ GetReadFrontBuffer()

virtual vtkTypeBool vtkWindowToImageFilter::GetReadFrontBuffer ( )
virtual

Set/Get the flag that determines which buffer to read from.

The default is to read from the front buffer.

◆ SetReadFrontBuffer()

virtual void vtkWindowToImageFilter::SetReadFrontBuffer ( vtkTypeBool  )
virtual

Set/Get the flag that determines which buffer to read from.

The default is to read from the front buffer.

◆ ShouldRerenderOn()

virtual void vtkWindowToImageFilter::ShouldRerenderOn ( )
virtual

Set/get whether to re-render the input window.

Initial value is true. (This option makes no difference if scale factor > 1.)

◆ ShouldRerenderOff()

virtual void vtkWindowToImageFilter::ShouldRerenderOff ( )
virtual

Set/get whether to re-render the input window.

Initial value is true. (This option makes no difference if scale factor > 1.)

◆ SetShouldRerender()

virtual void vtkWindowToImageFilter::SetShouldRerender ( vtkTypeBool  )
virtual

Set/get whether to re-render the input window.

Initial value is true. (This option makes no difference if scale factor > 1.)

◆ GetShouldRerender()

virtual vtkTypeBool vtkWindowToImageFilter::GetShouldRerender ( )
virtual

Set/get whether to re-render the input window.

Initial value is true. (This option makes no difference if scale factor > 1.)

◆ SetViewport() [1/2]

void vtkWindowToImageFilter::SetViewport ( double  ,
double  ,
double  ,
double   
)

Set/get the extents to be used to generate the image.

Initial value is {0,0,1,1} (This option does not work if scale factor > 1.)

◆ SetViewport() [2/2]

void vtkWindowToImageFilter::SetViewport ( double *  )

Set/get the extents to be used to generate the image.

Initial value is {0,0,1,1} (This option does not work if scale factor > 1.)

◆ GetViewport() [1/2]

virtual double * vtkWindowToImageFilter::GetViewport ( )
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 scale factor > 1.)

◆ GetViewport() [2/2]

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 scale factor > 1.)

◆ SetInputBufferType()

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.

◆ GetInputBufferType()

virtual int vtkWindowToImageFilter::GetInputBufferType ( )
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.

◆ SetInputBufferTypeToRGB()

void vtkWindowToImageFilter::SetInputBufferTypeToRGB ( )
inline

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 260 of file vtkWindowToImageFilter.h.

◆ SetInputBufferTypeToRGBA()

void vtkWindowToImageFilter::SetInputBufferTypeToRGBA ( )
inline

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 261 of file vtkWindowToImageFilter.h.

◆ SetInputBufferTypeToZBuffer()

void vtkWindowToImageFilter::SetInputBufferTypeToZBuffer ( )
inline

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 262 of file vtkWindowToImageFilter.h.

◆ GetOutput()

vtkImageData * vtkWindowToImageFilter::GetOutput ( )

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

◆ ProcessRequest()

vtkTypeBool vtkWindowToImageFilter::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overridevirtual

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

◆ RequestData()

void vtkWindowToImageFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protected

◆ RequestInformation()

virtual void vtkWindowToImageFilter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

◆ FillOutputPortInformation()

int vtkWindowToImageFilter::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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.

◆ Render()

virtual void vtkWindowToImageFilter::Render ( )
protectedvirtual

Allows subclasses to customize how a request for render is handled.

Default implementation checks if the render window has an interactor, if so, call interactor->Render(). If not, then renderWindow->Render() is called. Note, this may be called even when this->ShouldRerender is false, e.g. when saving images Scale > 1.

◆ Rescale2DActors()

void vtkWindowToImageFilter::Rescale2DActors ( )
protected

◆ Shift2DActors()

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

◆ Restore2DActors()

void vtkWindowToImageFilter::Restore2DActors ( )
protected

Member Data Documentation

◆ Input

vtkWindow* vtkWindowToImageFilter::Input
protected

Definition at line 281 of file vtkWindowToImageFilter.h.

◆ Scale

int vtkWindowToImageFilter::Scale[2]
protected

Definition at line 282 of file vtkWindowToImageFilter.h.

◆ ReadFrontBuffer

vtkTypeBool vtkWindowToImageFilter::ReadFrontBuffer
protected

Definition at line 283 of file vtkWindowToImageFilter.h.

◆ ShouldRerender

vtkTypeBool vtkWindowToImageFilter::ShouldRerender
protected

Definition at line 284 of file vtkWindowToImageFilter.h.

◆ Viewport

double vtkWindowToImageFilter::Viewport[4]
protected

Definition at line 285 of file vtkWindowToImageFilter.h.

◆ InputBufferType

int vtkWindowToImageFilter::InputBufferType
protected

Definition at line 286 of file vtkWindowToImageFilter.h.

◆ FixBoundary

bool vtkWindowToImageFilter::FixBoundary
protected

Definition at line 287 of file vtkWindowToImageFilter.h.

◆ StoredData

vtkWTI2DHelperClass* vtkWindowToImageFilter::StoredData
protected

Definition at line 309 of file vtkWindowToImageFilter.h.


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