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

vtkShadowMapBakerPass - Implement a builder of shadow map pass. More...

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

List of all members.

Public Member Functions

 vtkShadowMapBakerPass (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkShadowMapBakerPass ()
 Undocumented Block.
virtual vtkRenderPass GetCompositeZPass ()
 Delegate for compositing of the shadow maps accross processors. If it is NULL, there is no z compositing. It is usually set to a vtkCompositeZPass (Parallel package). Initial value is a NULL pointer.
bool GetHasShadows ()
 INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.
bool GetNeedUpdate ()
 INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.
virtual vtkRenderPass GetOpaquePass ()
 Delegate for rendering the opaque polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass with a sequence of vtkLightPass/vtkOpaquePass. Initial value is a NULL pointer.
virtual float GetPolygonOffsetFactor ()
 Factor used to scale the maximum depth slope of a polygon (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetUnits to solve self-shadowing. Valid values can be either positive or negative. Initial value is 1.1f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 3.1f works well with the regression test.
virtual float GetPolygonOffsetUnits ()
 Factor used to scale an implementation dependent constant that relates to the usable resolution of the depth buffer (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetFactor to solve self-shadowing. Valid values can be either positive or negative. Initial value is 4.0f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 10.0f works well with the regression test.
virtual uint GetResolution ()
 Set/Get the number of pixels in each dimension of the shadow maps (shadow maps are square). Initial value is 256. The greater the better. Resolution does not have to be a power-of-two value.
override int IsA (string type)
 Undocumented Block.
bool LightCreatesShadow (vtkLight l)
 INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.
new vtkShadowMapBakerPass NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow w)
 Release graphics resources and ask components to release their own resources.
virtual void SetCompositeZPass (vtkRenderPass compositeZPass)
 Delegate for compositing of the shadow maps accross processors. If it is NULL, there is no z compositing. It is usually set to a vtkCompositeZPass (Parallel package). Initial value is a NULL pointer.
virtual void SetOpaquePass (vtkRenderPass opaquePass)
 Delegate for rendering the opaque polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass with a sequence of vtkLightPass/vtkOpaquePass. Initial value is a NULL pointer.
virtual void SetPolygonOffsetFactor (float _arg)
 Factor used to scale the maximum depth slope of a polygon (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetUnits to solve self-shadowing. Valid values can be either positive or negative. Initial value is 1.1f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 3.1f works well with the regression test.
virtual void SetPolygonOffsetUnits (float _arg)
 Factor used to scale an implementation dependent constant that relates to the usable resolution of the depth buffer (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetFactor to solve self-shadowing. Valid values can be either positive or negative. Initial value is 4.0f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 10.0f works well with the regression test.
virtual void SetResolution (uint _arg)
 Set/Get the number of pixels in each dimension of the shadow maps (shadow maps are square). Initial value is 256. The greater the better. Resolution does not have to be a power-of-two value.
void SetUpToDate ()
 INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

Static Public Member Functions

static new vtkShadowMapBakerPass New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static vtkInformationIntegerKey OCCLUDER ()
 If this key exists on the PropertyKeys of a prop, the prop is viewed as a light occluder (ie it casts shadows). This key is not mutually exclusive with the RECEIVER() key.
static vtkInformationIntegerKey RECEIVER ()
 If this key exists on the Propertykeys of a prop, the prop is viewed as a light/shadow receiver. This key is not mutually exclusive with the OCCLUDER() key.
static new vtkShadowMapBakerPass SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkShadowMapBakerPass"
 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 vtkShadowMapBakerPass_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkShadowMapBakerPass_GetCompositeZPass_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkShadowMapBakerPass_GetHasShadows_02 (HandleRef pThis)
static internal byte vtkShadowMapBakerPass_GetNeedUpdate_03 (HandleRef pThis)
static internal IntPtr vtkShadowMapBakerPass_GetOpaquePass_04 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal float vtkShadowMapBakerPass_GetPolygonOffsetFactor_05 (HandleRef pThis)
static internal float vtkShadowMapBakerPass_GetPolygonOffsetUnits_06 (HandleRef pThis)
static internal uint vtkShadowMapBakerPass_GetResolution_07 (HandleRef pThis)
static internal int vtkShadowMapBakerPass_IsA_08 (HandleRef pThis, string type)
static internal int vtkShadowMapBakerPass_IsTypeOf_09 (string type)
static internal byte vtkShadowMapBakerPass_LightCreatesShadow_10 (HandleRef pThis, HandleRef l)
static internal IntPtr vtkShadowMapBakerPass_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkShadowMapBakerPass_OCCLUDER_13 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkShadowMapBakerPass_RECEIVER_14 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkShadowMapBakerPass_ReleaseGraphicsResources_15 (HandleRef pThis, HandleRef w)
static internal IntPtr vtkShadowMapBakerPass_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkShadowMapBakerPass_SetCompositeZPass_17 (HandleRef pThis, HandleRef compositeZPass)
static internal void vtkShadowMapBakerPass_SetOpaquePass_18 (HandleRef pThis, HandleRef opaquePass)
static internal void vtkShadowMapBakerPass_SetPolygonOffsetFactor_19 (HandleRef pThis, float _arg)
static internal void vtkShadowMapBakerPass_SetPolygonOffsetUnits_20 (HandleRef pThis, float _arg)
static internal void vtkShadowMapBakerPass_SetResolution_21 (HandleRef pThis, uint _arg)
static internal void vtkShadowMapBakerPass_SetUpToDate_22 (HandleRef pThis)

Static Private Member Functions

static vtkShadowMapBakerPass ()
 Automatically generated type registration mechanics.

Detailed Description

vtkShadowMapBakerPass - Implement a builder of shadow map pass.

Description Bake a list of shadow maps, once per spot light. It work in conjunction with the vtkShadowMapPass, which uses the shadow maps for rendering the opaque geometry (a technique to render hard shadows in hardware).

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.

Its delegate is usually set to a vtkOpaquePass.

Implementation The first pass of the algorithm is to generate a shadow map per light (depth map from the light point of view) by rendering the opaque objects with the vtkShadowMapBakerPass::OCCLUDER property keys. The second pass is to render the opaque objects with the vtkShadowMap::RECEIVER keys.

vtkRenderPass, vtkOpaquePass, vtkShadowMapPass


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

Delegate for compositing of the shadow maps accross processors. If it is NULL, there is no z compositing. It is usually set to a vtkCompositeZPass (Parallel package). Initial value is a NULL pointer.

Here is the call graph for this function:

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

Tell if there is at least one shadow. Initial value is false.

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

Do the shadows need to be updated? Value changed by vtkShadowMapBakerPass and used by vtkShadowMapPass. Initial value is true.

Delegate for rendering the opaque polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass with a sequence of vtkLightPass/vtkOpaquePass. Initial value is a NULL pointer.

Here is the call graph for this function:

Factor used to scale the maximum depth slope of a polygon (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetUnits to solve self-shadowing. Valid values can be either positive or negative. Initial value is 1.1f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 3.1f works well with the regression test.

Factor used to scale an implementation dependent constant that relates to the usable resolution of the depth buffer (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetFactor to solve self-shadowing. Valid values can be either positive or negative. Initial value is 4.0f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 10.0f works well with the regression test.

Set/Get the number of pixels in each dimension of the shadow maps (shadow maps are square). Initial value is 256. The greater the better. Resolution does not have to be a power-of-two value.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

Tell if the light `l' can create shadows. The light has to not be a head light and to be directional or positional with an angle less than 180 degrees.

Precondition:
l_exists: l!=0

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkRenderPass.

If this key exists on the PropertyKeys of a prop, the prop is viewed as a light occluder (ie it casts shadows). This key is not mutually exclusive with the RECEIVER() key.

Here is the call graph for this function:

If this key exists on the Propertykeys of a prop, the prop is viewed as a light/shadow receiver. This key is not mutually exclusive with the OCCLUDER() key.

Here is the call graph for this function:

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.vtkShadowMapBakerPass.SetCompositeZPass ( vtkRenderPass  compositeZPass) [virtual]

Delegate for compositing of the shadow maps accross processors. If it is NULL, there is no z compositing. It is usually set to a vtkCompositeZPass (Parallel package). Initial value is a NULL pointer.

virtual void Kitware.VTK.vtkShadowMapBakerPass.SetOpaquePass ( vtkRenderPass  opaquePass) [virtual]

Delegate for rendering the opaque polygonal geometry. If it is NULL, nothing will be rendered and a warning will be emitted. It is usually set to a vtkCameraPass with a sequence of vtkLightPass/vtkOpaquePass. Initial value is a NULL pointer.

virtual void Kitware.VTK.vtkShadowMapBakerPass.SetPolygonOffsetFactor ( float  _arg) [virtual]

Factor used to scale the maximum depth slope of a polygon (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetUnits to solve self-shadowing. Valid values can be either positive or negative. Initial value is 1.1f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 3.1f works well with the regression test.

virtual void Kitware.VTK.vtkShadowMapBakerPass.SetPolygonOffsetUnits ( float  _arg) [virtual]

Factor used to scale an implementation dependent constant that relates to the usable resolution of the depth buffer (definition from OpenGL 2.1 spec section 3.5.5 "Depth Offset" page 112). This is used during the creation the shadow maps (not during mapping of the shadow maps onto the geometry) Play with this value and PolygonOffsetFactor to solve self-shadowing. Valid values can be either positive or negative. Initial value is 4.0f (recommended by the nVidia presentation about Shadow Mapping by Cass Everitt). 10.0f works well with the regression test.

virtual void Kitware.VTK.vtkShadowMapBakerPass.SetResolution ( uint  _arg) [virtual]

Set/Get the number of pixels in each dimension of the shadow maps (shadow maps are square). Initial value is 256. The greater the better. Resolution does not have to be a power-of-two value.

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

Set NeedUpate to false. Called by vtkShadowMapPass.

static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetCompositeZPass_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetHasShadows_02 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetNeedUpdate_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetOpaquePass_04 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal float Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetPolygonOffsetFactor_05 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetPolygonOffsetUnits_06 ( HandleRef  pThis) [private]
static internal uint Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_GetResolution_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_IsTypeOf_09 ( string  type) [private]
static internal byte Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_LightCreatesShadow_10 ( HandleRef  pThis,
HandleRef  l 
) [private]
static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_NewInstance_12 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_OCCLUDER_13 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_RECEIVER_14 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_ReleaseGraphicsResources_15 ( HandleRef  pThis,
HandleRef  w 
) [private]
static internal IntPtr Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SetCompositeZPass_17 ( HandleRef  pThis,
HandleRef  compositeZPass 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SetOpaquePass_18 ( HandleRef  pThis,
HandleRef  opaquePass 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SetPolygonOffsetFactor_19 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SetPolygonOffsetUnits_20 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SetResolution_21 ( HandleRef  pThis,
uint  _arg 
) [private]
static internal void Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass_SetUpToDate_22 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkShadowMapBakerPass.MRClassNameKey = "21vtkShadowMapBakerPass" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRenderPass.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkRenderPass.


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