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

Inheritance diagram for Kitware.VTK.vtkShadowMapBakerPass:

Collaboration diagram for Kitware.VTK.vtkShadowMapBakerPass:

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.
Public Member Functions inherited from Kitware.VTK.vtkRenderPass
	vtkRenderPass (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

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.
Public Attributes inherited from Kitware.VTK.vtkRenderPass
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "21vtkShadowMapBakerPass"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkRenderPass
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

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

static Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass ( )

staticprivate

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.

Kitware.VTK.vtkShadowMapBakerPass.vtkShadowMapBakerPass ( )

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

virtual vtkRenderPass Kitware.VTK.vtkShadowMapBakerPass.GetCompositeZPass ( )

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.

Here is the call graph for this function:

bool Kitware.VTK.vtkShadowMapBakerPass.GetHasShadows ( )

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

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

bool Kitware.VTK.vtkShadowMapBakerPass.GetNeedUpdate ( )

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.

virtual vtkRenderPass Kitware.VTK.vtkShadowMapBakerPass.GetOpaquePass ( )

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.

Here is the call graph for this function:

virtual float Kitware.VTK.vtkShadowMapBakerPass.GetPolygonOffsetFactor ( )

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

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

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.

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.

bool Kitware.VTK.vtkShadowMapBakerPass.LightCreatesShadow ( vtkLight l )

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

static new vtkShadowMapBakerPass Kitware.VTK.vtkShadowMapBakerPass.New ( )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkShadowMapBakerPass Kitware.VTK.vtkShadowMapBakerPass.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkRenderPass.

static vtkInformationIntegerKey Kitware.VTK.vtkShadowMapBakerPass.OCCLUDER ( )

static

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:

static vtkInformationIntegerKey Kitware.VTK.vtkShadowMapBakerPass.RECEIVER ( )

static

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:

override void Kitware.VTK.vtkShadowMapBakerPass.ReleaseGraphicsResources ( vtkWindow w )

virtual

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

Precondition:: w_exists: w!=0

Reimplemented from Kitware.VTK.vtkRenderPass.

static new vtkShadowMapBakerPass Kitware.VTK.vtkShadowMapBakerPass.SafeDownCast ( vtkObjectBase o )

static

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

void Kitware.VTK.vtkShadowMapBakerPass.SetUpToDate ( )

INTERNAL USE ONLY. Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.

Set NeedUpate to false. Called by vtkShadowMapPass.