ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkWindowToImageFilter Class Reference

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

Inheritance diagram for Kitware.VTK.vtkWindowToImageFilter:
[legend]
Collaboration diagram for Kitware.VTK.vtkWindowToImageFilter:
[legend]

List of all members.

Public Member Functions

 vtkWindowToImageFilter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkWindowToImageFilter ()
 Undocumented Block.
virtual void FixBoundaryOff ()
 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 FixBoundaryOn ()
 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 GetFixBoundary ()
 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 vtkWindow GetInput ()
 Returns which renderer is being used as the source for the pixel data. Initial value is 0.
virtual int GetInputBufferType ()
 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.
virtual int GetMagnification ()
 The magnification of the current render window. Initial value is 1.
virtual int GetMagnificationMaxValue ()
 The magnification of the current render window. Initial value is 1.
virtual int GetMagnificationMinValue ()
 The magnification of the current render window. Initial value is 1.
vtkImageData GetOutput ()
 Get the output data object for a port on this algorithm.
virtual int GetReadFrontBuffer ()
 Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.
virtual int GetShouldRerender ()
 Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)
virtual double[] GetViewport ()
 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 GetViewport (IntPtr data)
 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.)
override int IsA (string type)
 Undocumented Block.
new vtkWindowToImageFilter NewInstance ()
 Undocumented Block.
virtual void ReadFrontBufferOff ()
 Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.
virtual void ReadFrontBufferOn ()
 Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.
virtual void SetFixBoundary (bool _arg)
 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.
void SetInput (vtkWindow input)
 Indicates what renderer to get the pixel data from. Initial value is 0.
virtual void SetInputBufferType (int _arg)
 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.
void SetInputBufferTypeToRGB ()
 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.
void SetInputBufferTypeToRGBA ()
 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.
void SetInputBufferTypeToZBuffer ()
 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.
virtual void SetMagnification (int _arg)
 The magnification of the current render window. Initial value is 1.
virtual void SetReadFrontBuffer (int _arg)
 Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.
virtual void SetShouldRerender (int _arg)
 Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)
virtual void SetViewport (double _arg1, double _arg2, double _arg3, double _arg4)
 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 SetViewport (IntPtr _arg)
 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 ShouldRerenderOff ()
 Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)
virtual void ShouldRerenderOn ()
 Set/get whether to re-render the input window. Initial value is true. (This option makes no difference if Magnification > 1.)

Static Public Member Functions

static new vtkWindowToImageFilter New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkWindowToImageFilter SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkWindowToImageFilter"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "22vtkWindowToImageFilter"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkWindowToImageFilter_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkWindowToImageFilter_FixBoundaryOff_01 (HandleRef pThis)
static internal void vtkWindowToImageFilter_FixBoundaryOn_02 (HandleRef pThis)
static internal byte vtkWindowToImageFilter_GetFixBoundary_03 (HandleRef pThis)
static internal IntPtr vtkWindowToImageFilter_GetInput_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkWindowToImageFilter_GetInputBufferType_05 (HandleRef pThis)
static internal int vtkWindowToImageFilter_GetMagnification_06 (HandleRef pThis)
static internal int vtkWindowToImageFilter_GetMagnificationMaxValue_07 (HandleRef pThis)
static internal int vtkWindowToImageFilter_GetMagnificationMinValue_08 (HandleRef pThis)
static internal IntPtr vtkWindowToImageFilter_GetOutput_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkWindowToImageFilter_GetReadFrontBuffer_10 (HandleRef pThis)
static internal int vtkWindowToImageFilter_GetShouldRerender_11 (HandleRef pThis)
static internal IntPtr vtkWindowToImageFilter_GetViewport_12 (HandleRef pThis)
static internal void vtkWindowToImageFilter_GetViewport_13 (HandleRef pThis, IntPtr data)
static internal int vtkWindowToImageFilter_IsA_14 (HandleRef pThis, string type)
static internal int vtkWindowToImageFilter_IsTypeOf_15 (string type)
static internal IntPtr vtkWindowToImageFilter_NewInstance_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkWindowToImageFilter_ReadFrontBufferOff_18 (HandleRef pThis)
static internal void vtkWindowToImageFilter_ReadFrontBufferOn_19 (HandleRef pThis)
static internal IntPtr vtkWindowToImageFilter_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkWindowToImageFilter_SetFixBoundary_21 (HandleRef pThis, byte _arg)
static internal void vtkWindowToImageFilter_SetInput_22 (HandleRef pThis, HandleRef input)
static internal void vtkWindowToImageFilter_SetInputBufferType_23 (HandleRef pThis, int _arg)
static internal void vtkWindowToImageFilter_SetInputBufferTypeToRGB_24 (HandleRef pThis)
static internal void vtkWindowToImageFilter_SetInputBufferTypeToRGBA_25 (HandleRef pThis)
static internal void vtkWindowToImageFilter_SetInputBufferTypeToZBuffer_26 (HandleRef pThis)
static internal void vtkWindowToImageFilter_SetMagnification_27 (HandleRef pThis, int _arg)
static internal void vtkWindowToImageFilter_SetReadFrontBuffer_28 (HandleRef pThis, int _arg)
static internal void vtkWindowToImageFilter_SetShouldRerender_29 (HandleRef pThis, int _arg)
static internal void vtkWindowToImageFilter_SetViewport_30 (HandleRef pThis, double _arg1, double _arg2, double _arg3, double _arg4)
static internal void vtkWindowToImageFilter_SetViewport_31 (HandleRef pThis, IntPtr _arg)
static internal void vtkWindowToImageFilter_ShouldRerenderOff_32 (HandleRef pThis)
static internal void vtkWindowToImageFilter_ShouldRerenderOn_33 (HandleRef pThis)

Static Private Member Functions

static vtkWindowToImageFilter ()
 Automatically generated type registration mechanics.

Detailed Description

vtkWindowToImageFilter - Use a vtkWindow as input to image pipeline

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

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


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkWindowToImageFilter.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkAlgorithm.

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.

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.

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.

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

Here is the call graph for this function:

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.

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

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

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

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

Here is the call graph for this function:

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

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

virtual double [] Kitware.VTK.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 Magnification > 1.)

virtual void Kitware.VTK.vtkWindowToImageFilter.GetViewport ( IntPtr  data) [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.)

override int Kitware.VTK.vtkWindowToImageFilter.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

static new int Kitware.VTK.vtkWindowToImageFilter.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkWindowToImageFilter.SetFixBoundary ( bool  _arg) [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.

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

virtual void Kitware.VTK.vtkWindowToImageFilter.SetInputBufferType ( int  _arg) [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.

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.

virtual void Kitware.VTK.vtkWindowToImageFilter.SetMagnification ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkWindowToImageFilter.SetReadFrontBuffer ( int  _arg) [virtual]

Set/Get the flag that determines which buffer to read from. The default is to read from the front buffer.

virtual void Kitware.VTK.vtkWindowToImageFilter.SetShouldRerender ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkWindowToImageFilter.SetViewport ( double  _arg1,
double  _arg2,
double  _arg3,
double  _arg4 
) [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 Kitware.VTK.vtkWindowToImageFilter.SetViewport ( IntPtr  _arg) [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 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.)

static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_FixBoundaryOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_FixBoundaryOn_02 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetFixBoundary_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetInput_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetInputBufferType_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetMagnification_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetOutput_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetReadFrontBuffer_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetShouldRerender_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetViewport_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_GetViewport_13 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_IsTypeOf_15 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_NewInstance_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_ReadFrontBufferOff_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_ReadFrontBufferOn_19 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetFixBoundary_21 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetInput_22 ( HandleRef  pThis,
HandleRef  input 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetInputBufferType_23 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetMagnification_27 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetReadFrontBuffer_28 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetShouldRerender_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetViewport_30 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3,
double  _arg4 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_SetViewport_31 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_ShouldRerenderOff_32 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkWindowToImageFilter.vtkWindowToImageFilter_ShouldRerenderOn_33 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkWindowToImageFilter.MRClassNameKey = "22vtkWindowToImageFilter" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAlgorithm.

new const string Kitware.VTK.vtkWindowToImageFilter.MRFullTypeName = "Kitware.VTK.vtkWindowToImageFilter"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAlgorithm.


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