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.vtkDepthPeelingPass Class Reference

vtkDepthPeelingPass - Implement an Order Independent Transparency render pass. More...

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

List of all members.

Public Member Functions

 vtkDepthPeelingPass (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDepthPeelingPass ()
 Undocumented Block.
virtual bool GetLastRenderingUsedDepthPeeling ()
 Tells if the last time this pass was executed, the depth peeling algorithm was actually used. Initial value is false.
virtual int GetMaximumNumberOfPeels ()
 In case of depth peeling, define the maximum number of peeling layers. Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.
virtual double GetOcclusionRatio ()
 In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.
virtual double GetOcclusionRatioMaxValue ()
 In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.
virtual double GetOcclusionRatioMinValue ()
 In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.
virtual vtkRenderPass GetTranslucentPass ()
 Delegate for rendering the translucent polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.
override int IsA (string type)
 Undocumented Block.
new vtkDepthPeelingPass NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow w)
 Release graphics resources and ask components to release their own resources.
virtual void SetMaximumNumberOfPeels (int _arg)
 In case of depth peeling, define the maximum number of peeling layers. Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.
virtual void SetOcclusionRatio (double _arg)
 In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.
virtual void SetTranslucentPass (vtkRenderPass translucentPass)
 Delegate for rendering the translucent polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "19vtkDepthPeelingPass"
 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 vtkDepthPeelingPass_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkDepthPeelingPass_GetLastRenderingUsedDepthPeeling_01 (HandleRef pThis)
static internal int vtkDepthPeelingPass_GetMaximumNumberOfPeels_02 (HandleRef pThis)
static internal double vtkDepthPeelingPass_GetOcclusionRatio_03 (HandleRef pThis)
static internal double vtkDepthPeelingPass_GetOcclusionRatioMaxValue_04 (HandleRef pThis)
static internal double vtkDepthPeelingPass_GetOcclusionRatioMinValue_05 (HandleRef pThis)
static internal IntPtr vtkDepthPeelingPass_GetTranslucentPass_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkDepthPeelingPass_IsA_07 (HandleRef pThis, string type)
static internal int vtkDepthPeelingPass_IsTypeOf_08 (string type)
static internal IntPtr vtkDepthPeelingPass_NewInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDepthPeelingPass_ReleaseGraphicsResources_11 (HandleRef pThis, HandleRef w)
static internal IntPtr vtkDepthPeelingPass_SafeDownCast_12 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDepthPeelingPass_SetMaximumNumberOfPeels_13 (HandleRef pThis, int _arg)
static internal void vtkDepthPeelingPass_SetOcclusionRatio_14 (HandleRef pThis, double _arg)
static internal void vtkDepthPeelingPass_SetTranslucentPass_15 (HandleRef pThis, HandleRef translucentPass)

Static Private Member Functions

static vtkDepthPeelingPass ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDepthPeelingPass - Implement an Order Independent Transparency render pass.

Description Render the translucent polygonal geometry of a scene without sorting polygons in the view direction.

This pass expects an initialized depth buffer and color buffer. Initialized buffers means they have been cleared with farest z-value and background color/gradient/transparent color. An opaque pass may have been performed right after the initialization.

The depth peeling algorithm works by rendering the translucent polygonal geometry multiple times (once for each peel). The actually rendering of the translucent polygonal geometry is peformed by its delegate TranslucentPass. This delegate is therefore used multiple times.

Its delegate is usually set to a vtkTranslucentPass.

vtkRenderPass, vtkTranslucentPass


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass ( 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.vtkDepthPeelingPass.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.vtkRenderPass.

Tells if the last time this pass was executed, the depth peeling algorithm was actually used. Initial value is false.

In case of depth peeling, define the maximum number of peeling layers. Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

Delegate for rendering the translucent polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.

Here is the call graph for this function:

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

Release graphics resources and ask components to release their own resources.

Precondition:
w_exists: w!=0

Reimplemented from Kitware.VTK.vtkRenderPass.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDepthPeelingPass.SetMaximumNumberOfPeels ( int  _arg) [virtual]

In case of depth peeling, define the maximum number of peeling layers. Initial value is 4. A special value of 0 means no maximum limit. It has to be a positive value.

virtual void Kitware.VTK.vtkDepthPeelingPass.SetOcclusionRatio ( double  _arg) [virtual]

In case of use of depth peeling technique for rendering translucent material, define the threshold under which the algorithm stops to iterate over peel layers. This is the ratio of the number of pixels that have been touched by the last layer over the total number of pixels of the viewport area. Initial value is 0.0, meaning rendering have to be exact. Greater values may speed-up the rendering with small impact on the quality.

virtual void Kitware.VTK.vtkDepthPeelingPass.SetTranslucentPass ( vtkRenderPass  translucentPass) [virtual]

Delegate for rendering the translucent polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkTranslucentPass. Initial value is a NULL pointer.

static internal int Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_GetMaximumNumberOfPeels_02 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_GetOcclusionRatio_03 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_GetOcclusionRatioMaxValue_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_GetOcclusionRatioMinValue_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_GetTranslucentPass_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_IsA_07 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_IsTypeOf_08 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_NewInstance_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_ReleaseGraphicsResources_11 ( HandleRef  pThis,
HandleRef  w 
) [private]
static internal IntPtr Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_SafeDownCast_12 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_SetMaximumNumberOfPeels_13 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_SetOcclusionRatio_14 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkDepthPeelingPass.vtkDepthPeelingPass_SetTranslucentPass_15 ( HandleRef  pThis,
HandleRef  translucentPass 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDepthPeelingPass.MRClassNameKey = "19vtkDepthPeelingPass" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRenderPass.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRenderPass.


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