Implement a shadow mapping render pass. More...

#include <vtkShadowMapPass.h>

Inheritance diagram for vtkShadowMapPass:

Collaboration diagram for vtkShadowMapPass:

Public Types
typedef vtkRenderPass	Superclass

typedef vtkRenderPass	Superclass

Public Types inherited from vtkRenderPass
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkShadowMapPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Render (const vtkRenderState *s)
	Perform rendering according to a render state `s`. More...

void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources. More...

virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkShadowMapPass *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Render (const vtkRenderState *s)
	Perform rendering according to a render state `s`. More...

void	ReleaseGraphicsResources (vtkWindow *w)
	Release graphics resources and ask components to release their own resources. More...

std::vector< double >	ShadowMapTransforms ()
	get the matricies for all the shadow maps. More...

std::vector< int >	GetShadowMapTextureUnits ()
	get the texture units for the shadow maps for each light. More...

std::string	GetFragmentDeclaration ()
	Get the shader code to compute light factors based on a mappers vertexVC variable. More...

std::string	GetFragmentImplementation ()

void	SetUniforms (vtkShaderProgram *program)
	A mapper can call this to set the uniforms that this pass uses. More...


virtual vtkShadowMapBakerPass *	GetShadowMapBakerPass ()
	Pass that generates the shadow maps. More...

virtual void	SetShadowMapBakerPass (vtkShadowMapBakerPass *shadowMapBakerPass)
	Pass that generates the shadow maps. More...


virtual vtkRenderPass *	GetOpaquePass ()
	Pass that render the opaque geometry, with no camera pass (otherwise it does not work with Ice-T). More...

virtual void	SetOpaquePass (vtkRenderPass *opaquePass)
	Pass that render the opaque geometry, with no camera pass (otherwise it does not work with Ice-T). More...


virtual vtkShadowMapBakerPass *	GetShadowMapBakerPass ()
	Pass that generates the shadow maps. More...

virtual void	SetShadowMapBakerPass (vtkShadowMapBakerPass *shadowMapBakerPass)
	Pass that generates the shadow maps. More...


virtual vtkRenderPass *	GetOpaqueSequence ()
	Pass that render the lights and opaque geometry Typically a sequence pass with a light pass and opaque pass. More...

virtual void	SetOpaqueSequence (vtkRenderPass *opaqueSequence)
	Pass that render the lights and opaque geometry Typically a sequence pass with a light pass and opaque pass. More...

Public Member Functions inherited from vtkRenderPass
vtkRenderPass *	NewInstance () const

virtual int	GetNumberOfRenderedProps ()
	Number of props rendered at the last Render call. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkShadowMapPass *	New ()

static int	IsTypeOf (const char *type)

static vtkShadowMapPass *	SafeDownCast (vtkObjectBase *o)

static vtkShadowMapPass *	New ()

static int	IsTypeOf (const char *type)

static vtkShadowMapPass *	SafeDownCast (vtkObjectBase *o)

static vtkInformationObjectBaseKey *	ShadowMapPass ()
	this key will contain the shadow map pass More...

Static Public Member Functions inherited from vtkRenderPass
static int	IsTypeOf (const char *type)

static vtkRenderPass *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkShadowMapPass ()
	Default constructor. More...

virtual	~vtkShadowMapPass ()
	Destructor. More...

void	BuildSpotLightIntensityMap ()
	Build the intensity map. More...

void	CheckSupport (vtkOpenGLRenderWindow *w)
	Check if shadow mapping is supported by the current OpenGL context. More...

virtual vtkObjectBase *	NewInstanceInternal () const

	vtkShadowMapPass ()
	Default constructor. More...

virtual	~vtkShadowMapPass ()
	Destructor. More...

void	CheckSupport (vtkOpenGLRenderWindow *w)
	Check if shadow mapping is supported by the current OpenGL context. More...

void	BuildShaderCode ()

Protected Member Functions inherited from vtkRenderPass
	vtkRenderPass ()
	Default constructor. More...

virtual	~vtkRenderPass ()
	Destructor. More...

void	UpdateCamera (vtkRenderer *renderer)
	Call UpdateCamera() on Renderer. More...

void	ClearLights (vtkRenderer *renderer)
	Call ClearLights() on Renderer. More...

void	UpdateLightGeometry (vtkRenderer *renderer)
	Call UpdateLightGeometry() on Renderer. More...

void	UpdateLights (vtkRenderer *renderer)
	Call UpdateLights() on Renderer. More...

void	UpdateGeometry (vtkRenderer *renderer)
	Call UpdateGeometry() on Renderer. More...

void	SetLastRenderingUsedDepthPeeling (vtkRenderer *renderer, bool value)
	Modify protected member LastRenderingUsedDepthPeeling on Renderer. More...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkShadowMapBakerPass *	ShadowMapBakerPass

vtkRenderPass *	CompositeRGBAPass

vtkRenderPass *	OpaquePass

vtkFrameBufferObject *	FrameBufferObject
	Graphics resources. More...

vtkShadowMapPassTextures *	ShadowMaps

vtkShadowMapPassLightCameras *	LightCameras

vtkShaderProgram2 *	Program

vtkTextureObject *	IntensityMap

vtkSampleFunction *	IntensitySource

vtkImageExport *	IntensityExporter

vtkImplicitHalo *	Halo

vtkTimeStamp	LastRenderTime

vtkRenderPass *	OpaqueSequence

std::string	FragmentDeclaration

std::string	FragmentImplementation

std::vector< int >	ShadowTextureUnits

std::vector< double >	ShadowTransforms

std::vector< float >	ShadowAttenuation

Protected Attributes inherited from vtkRenderPass
int	NumberOfRenderedProps

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Implement a shadow mapping render pass.

Render the opaque polygonal geometry of a scene with shadow maps (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 OCCLUDER property keys. The second pass is to render the opaque objects with the RECEIVER keys.

See also: vtkRenderPass, vtkOpaquePass

Render the opaque polygonal geometry of a scene with shadow maps (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 OCCLUDER property keys. The second pass is to render the opaque objects with the RECEIVER keys.

See also: vtkRenderPass, vtkOpaquePass

Tests:: vtkShadowMapPass (Tests)

Definition at line 61 of file vtkShadowMapPass.h.

Member Typedef Documentation

typedef vtkRenderPass vtkShadowMapPass::Superclass

Definition at line 65 of file vtkShadowMapPass.h.

typedef vtkRenderPass vtkShadowMapPass::Superclass

Definition at line 67 of file vtkShadowMapPass.h.

Constructor & Destructor Documentation

vtkShadowMapPass::vtkShadowMapPass ( )

protected

Default constructor.

DelegatetPass is set to NULL.

virtual vtkShadowMapPass::~vtkShadowMapPass ( )

protectedvirtual

Destructor.

vtkShadowMapPass::vtkShadowMapPass ( )

protected

Default constructor.

DelegatetPass is set to NULL.

virtual vtkShadowMapPass::~vtkShadowMapPass ( )

protectedvirtual

Destructor.

Member Function Documentation

static vtkShadowMapPass* vtkShadowMapPass::New ( )

static

static int vtkShadowMapPass::IsTypeOf ( const char * type )

static

virtual int vtkShadowMapPass::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 vtkRenderPass.

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

static

virtual vtkObjectBase* vtkShadowMapPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

vtkShadowMapPass* vtkShadowMapPass::NewInstance ( ) const

void vtkShadowMapPass::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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

virtual void vtkShadowMapPass::Render ( const vtkRenderState * s )

virtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

void vtkShadowMapPass::ReleaseGraphicsResources ( vtkWindow * w )

virtual

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

Precondition: w_exists: w!=0

Reimplemented from vtkRenderPass.

virtual vtkShadowMapBakerPass* vtkShadowMapPass::GetShadowMapBakerPass ( )

virtual

Pass that generates the shadow maps.

the vtkShadowMapPass will use the Resolution ivar of this pass. Initial value is a NULL pointer.

virtual void vtkShadowMapPass::SetShadowMapBakerPass ( vtkShadowMapBakerPass * shadowMapBakerPass )

virtual

Pass that generates the shadow maps.

the vtkShadowMapPass will use the Resolution ivar of this pass. Initial value is a NULL pointer.

virtual vtkRenderPass* vtkShadowMapPass::GetOpaquePass ( )

virtual

Pass that render the opaque geometry, with no camera pass (otherwise it does not work with Ice-T).

Initial value is a NULL pointer. Typically a sequence pass with a light pass and opaque pass. This should be the Opaque pass of the vtkShadowMapBakerPass without the vtkCameraPass.

virtual void vtkShadowMapPass::SetOpaquePass ( vtkRenderPass * opaquePass )

virtual

Pass that render the opaque geometry, with no camera pass (otherwise it does not work with Ice-T).

Initial value is a NULL pointer. Typically a sequence pass with a light pass and opaque pass. This should be the Opaque pass of the vtkShadowMapBakerPass without the vtkCameraPass.

void vtkShadowMapPass::BuildSpotLightIntensityMap ( )

protected

Build the intensity map.

void vtkShadowMapPass::CheckSupport ( vtkOpenGLRenderWindow * w )

protected

Check if shadow mapping is supported by the current OpenGL context.

Precondition: w_exists: w!=0

static vtkShadowMapPass* vtkShadowMapPass::New ( )

static

static int vtkShadowMapPass::IsTypeOf ( const char * type )

static

virtual int vtkShadowMapPass::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 vtkRenderPass.

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

static

virtual vtkObjectBase* vtkShadowMapPass::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderPass.

vtkShadowMapPass* vtkShadowMapPass::NewInstance ( ) const

void vtkShadowMapPass::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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

virtual void vtkShadowMapPass::Render ( const vtkRenderState * s )

virtual

Perform rendering according to a render state s.

Precondition: s_exists: s!=0

Implements vtkRenderPass.

void vtkShadowMapPass::ReleaseGraphicsResources ( vtkWindow * w )

virtual

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

Precondition: w_exists: w!=0

Reimplemented from vtkRenderPass.

virtual vtkShadowMapBakerPass* vtkShadowMapPass::GetShadowMapBakerPass ( )

virtual

Pass that generates the shadow maps.

the vtkShadowMapPass will use the Resolution ivar of this pass. Initial value is a NULL pointer.

virtual void vtkShadowMapPass::SetShadowMapBakerPass ( vtkShadowMapBakerPass * shadowMapBakerPass )

virtual

Pass that generates the shadow maps.

the vtkShadowMapPass will use the Resolution ivar of this pass. Initial value is a NULL pointer.

virtual vtkRenderPass* vtkShadowMapPass::GetOpaqueSequence ( )

virtual

Pass that render the lights and opaque geometry Typically a sequence pass with a light pass and opaque pass.

virtual void vtkShadowMapPass::SetOpaqueSequence ( vtkRenderPass * opaqueSequence )

virtual

Pass that render the lights and opaque geometry Typically a sequence pass with a light pass and opaque pass.

std::vector<double> vtkShadowMapPass::ShadowMapTransforms ( )

inline

get the matricies for all the shadow maps.

Definition at line 108 of file vtkShadowMapPass.h.

std::vector<int> vtkShadowMapPass::GetShadowMapTextureUnits ( )

inline

get the texture units for the shadow maps for each light.

If a light does not cast a shadow it is set to -1

Definition at line 116 of file vtkShadowMapPass.h.

static vtkInformationObjectBaseKey* vtkShadowMapPass::ShadowMapPass ( )

static

this key will contain the shadow map pass

std::string vtkShadowMapPass::GetFragmentDeclaration ( )

inline

Get the shader code to compute light factors based on a mappers vertexVC variable.

Definition at line 128 of file vtkShadowMapPass.h.

std::string vtkShadowMapPass::GetFragmentImplementation ( )

inline

Definition at line 130 of file vtkShadowMapPass.h.

void vtkShadowMapPass::SetUniforms ( vtkShaderProgram * program )

A mapper can call this to set the uniforms that this pass uses.

void vtkShadowMapPass::CheckSupport ( vtkOpenGLRenderWindow * w )

protected

Check if shadow mapping is supported by the current OpenGL context.

Precondition: w_exists: w!=0

void vtkShadowMapPass::BuildShaderCode ( )

protected

Member Data Documentation

vtkShadowMapBakerPass * vtkShadowMapPass::ShadowMapBakerPass

protected

Definition at line 128 of file vtkShadowMapPass.h.

vtkRenderPass * vtkShadowMapPass::CompositeRGBAPass

protected

Definition at line 129 of file vtkShadowMapPass.h.

vtkRenderPass* vtkShadowMapPass::OpaquePass

protected

Definition at line 131 of file vtkShadowMapPass.h.

vtkFrameBufferObject * vtkShadowMapPass::FrameBufferObject

protected

Graphics resources.

Definition at line 136 of file vtkShadowMapPass.h.

vtkShadowMapPassTextures * vtkShadowMapPass::ShadowMaps

protected

Definition at line 138 of file vtkShadowMapPass.h.

vtkShadowMapPassLightCameras * vtkShadowMapPass::LightCameras

protected

Definition at line 139 of file vtkShadowMapPass.h.

vtkShaderProgram2* vtkShadowMapPass::Program

protected

Definition at line 140 of file vtkShadowMapPass.h.

vtkTextureObject* vtkShadowMapPass::IntensityMap

protected

Definition at line 142 of file vtkShadowMapPass.h.

vtkSampleFunction* vtkShadowMapPass::IntensitySource

protected

Definition at line 144 of file vtkShadowMapPass.h.

vtkImageExport* vtkShadowMapPass::IntensityExporter

protected

Definition at line 145 of file vtkShadowMapPass.h.

vtkImplicitHalo* vtkShadowMapPass::Halo

protected

Definition at line 146 of file vtkShadowMapPass.h.

vtkTimeStamp vtkShadowMapPass::LastRenderTime

protected

Definition at line 148 of file vtkShadowMapPass.h.

vtkRenderPass* vtkShadowMapPass::OpaqueSequence

protected

Definition at line 159 of file vtkShadowMapPass.h.

std::string vtkShadowMapPass::FragmentDeclaration

protected

Definition at line 173 of file vtkShadowMapPass.h.

std::string vtkShadowMapPass::FragmentImplementation

protected

Definition at line 174 of file vtkShadowMapPass.h.

std::vector<int> vtkShadowMapPass::ShadowTextureUnits

protected

Definition at line 175 of file vtkShadowMapPass.h.

std::vector<double> vtkShadowMapPass::ShadowTransforms

protected

Definition at line 176 of file vtkShadowMapPass.h.

std::vector<float> vtkShadowMapPass::ShadowAttenuation

protected

Definition at line 177 of file vtkShadowMapPass.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkShadowMapPass.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation