VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkShadowMapPass Class Reference

Implement a shadow mapping render pass. More...

#include <vtkShadowMapPass.h>

Inheritance diagram for vtkShadowMapPass:
[legend]
Collaboration diagram for vtkShadowMapPass:
[legend]

Public Types

typedef vtkOpenGLRenderPass Superclass
 
- Public Types inherited from vtkOpenGLRenderPass
typedef vtkRenderPass Superclass
 
- Public Types inherited from vtkRenderPass
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkShadowMapPassNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Render (const vtkRenderState *s) override
 Perform rendering according to a render state s. More...
 
void ReleaseGraphicsResources (vtkWindow *w) override
 Release graphics resources and ask components to release their own resources. More...
 
virtual vtkShadowMapBakerPassGetShadowMapBakerPass ()
 Pass that generates the shadow maps. More...
 
virtual void SetShadowMapBakerPass (vtkShadowMapBakerPass *shadowMapBakerPass)
 
virtual vtkRenderPassGetOpaqueSequence ()
 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)
 
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 ()
 
bool PreReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
bool PostReplaceShaderValues (std::string &vertexShader, std::string &geometryShader, std::string &fragmentShader, vtkAbstractMapper *mapper, vtkProp *prop) override
 Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources. More...
 
bool SetShaderParameters (vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr) override
 Update the uniforms of the shader program. More...
 
- Public Member Functions inherited from vtkOpenGLRenderPass
vtkOpenGLRenderPassNewInstance () const
 
virtual vtkMTimeType GetShaderStageMTime ()
 For multi-stage render passes that need to change shader code during a single pass, use this method to notify a mapper that the shader needs to be rebuilt (rather than reuse the last cached shader. More...
 
virtual void SetActiveDrawBuffers (unsigned int)
 Number of active draw buffers. More...
 
virtual unsigned int GetActiveDrawBuffers ()
 
- Public Member Functions inherited from vtkRenderPass
vtkRenderPassNewInstance () 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkShadowMapPassNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkShadowMapPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseKeyShadowMapPass ()
 this key will contain the shadow map pass More...
 
- Static Public Member Functions inherited from vtkOpenGLRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderPassSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseVectorKeyRenderPasses ()
 Key containing information about the current pass. More...
 
- Static Public Member Functions inherited from vtkRenderPass
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderPassSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkShadowMapPass ()
 Default constructor. More...
 
 ~vtkShadowMapPass () override
 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 vtkOpenGLRenderPass
 vtkOpenGLRenderPass ()
 
 ~vtkOpenGLRenderPass () override
 
void PreRender (const vtkRenderState *s)
 Call before rendering to update the actors' information keys. More...
 
void PostRender (const vtkRenderState *s)
 Call after rendering to clean up the actors' information keys. More...
 
- Protected Member Functions inherited from vtkRenderPass
 vtkRenderPass ()
 Default constructor. More...
 
 ~vtkRenderPass () override
 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, vtkFrameBufferObjectBase *fbo=nullptr)
 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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

vtkShadowMapBakerPassShadowMapBakerPass
 
vtkRenderPassCompositeRGBAPass
 
vtkRenderPassOpaqueSequence
 
vtkFrameBufferObject * FrameBufferObject
 Graphics resources. More...
 
vtkShadowMapPassTextures * ShadowMaps
 
vtkShadowMapPassLightCameras * LightCameras
 
vtkTimeStamp LastRenderTime
 
std::string FragmentDeclaration
 
std::string FragmentImplementation
 
std::vector< int > ShadowTextureUnits
 
std::vector< double > ShadowTransforms
 
std::vector< float > ShadowAttenuation
 
std::vector< int > ShadowParallel
 
- Protected Attributes inherited from vtkOpenGLRenderPass
unsigned int ActiveDrawBuffers = 0
 
- Protected Attributes inherited from vtkRenderPass
int NumberOfRenderedProps
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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

Definition at line 60 of file vtkShadowMapPass.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkShadowMapPass.h.

Constructor & Destructor Documentation

◆ vtkShadowMapPass()

vtkShadowMapPass::vtkShadowMapPass ( )
protected

Default constructor.

DelegatetPass is set to NULL.

◆ ~vtkShadowMapPass()

vtkShadowMapPass::~vtkShadowMapPass ( )
overrideprotected

Destructor.

Member Function Documentation

◆ New()

static vtkShadowMapPass* vtkShadowMapPass::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkOpenGLRenderPass.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkShadowMapPass::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLRenderPass.

◆ NewInstance()

vtkShadowMapPass* vtkShadowMapPass::NewInstance ( ) const

◆ PrintSelf()

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

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

◆ Render()

void vtkShadowMapPass::Render ( const vtkRenderState s)
overridevirtual

Perform rendering according to a render state s.

Precondition
s_exists: s!=0

Implements vtkRenderPass.

◆ ReleaseGraphicsResources()

void vtkShadowMapPass::ReleaseGraphicsResources ( vtkWindow w)
overridevirtual

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

Precondition
w_exists: w!=0

Reimplemented from vtkRenderPass.

◆ GetShadowMapBakerPass()

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.

◆ SetShadowMapBakerPass()

virtual void vtkShadowMapPass::SetShadowMapBakerPass ( vtkShadowMapBakerPass shadowMapBakerPass)
virtual

◆ GetOpaqueSequence()

virtual vtkRenderPass* vtkShadowMapPass::GetOpaqueSequence ( )
virtual

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

◆ SetOpaqueSequence()

virtual void vtkShadowMapPass::SetOpaqueSequence ( vtkRenderPass opaqueSequence)
virtual

◆ ShadowMapTransforms()

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

get the matricies for all the shadow maps.

Definition at line 104 of file vtkShadowMapPass.h.

◆ GetShadowMapTextureUnits()

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 111 of file vtkShadowMapPass.h.

◆ ShadowMapPass()

static vtkInformationObjectBaseKey* vtkShadowMapPass::ShadowMapPass ( )
static

this key will contain the shadow map pass

◆ GetFragmentDeclaration()

std::string vtkShadowMapPass::GetFragmentDeclaration ( )
inline

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

Definition at line 122 of file vtkShadowMapPass.h.

◆ GetFragmentImplementation()

std::string vtkShadowMapPass::GetFragmentImplementation ( )
inline

Definition at line 123 of file vtkShadowMapPass.h.

◆ PreReplaceShaderValues()

bool vtkShadowMapPass::PreReplaceShaderValues ( std::string &  vertexShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkProp prop 
)
overridevirtual

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources.

Gets called before other mapper shader replacements Return false on error.

Reimplemented from vtkOpenGLRenderPass.

◆ PostReplaceShaderValues()

bool vtkShadowMapPass::PostReplaceShaderValues ( std::string &  vertexShader,
std::string &  geometryShader,
std::string &  fragmentShader,
vtkAbstractMapper mapper,
vtkProp prop 
)
overridevirtual

Use vtkShaderProgram::Substitute to replace //VTK::XXX:YYY declarations in the shader sources.

Gets called after other mapper shader replacements. Return false on error.

Reimplemented from vtkOpenGLRenderPass.

◆ SetShaderParameters()

bool vtkShadowMapPass::SetShaderParameters ( vtkShaderProgram program,
vtkAbstractMapper mapper,
vtkProp prop,
vtkOpenGLVertexArrayObject VAO = nullptr 
)
overridevirtual

Update the uniforms of the shader program.

Return false on error.

Reimplemented from vtkOpenGLRenderPass.

◆ CheckSupport()

void vtkShadowMapPass::CheckSupport ( vtkOpenGLRenderWindow w)
protected

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

Precondition
w_exists: w!=0

◆ BuildShaderCode()

void vtkShadowMapPass::BuildShaderCode ( )
protected

Member Data Documentation

◆ ShadowMapBakerPass

vtkShadowMapBakerPass* vtkShadowMapPass::ShadowMapBakerPass
protected

Definition at line 150 of file vtkShadowMapPass.h.

◆ CompositeRGBAPass

vtkRenderPass* vtkShadowMapPass::CompositeRGBAPass
protected

Definition at line 151 of file vtkShadowMapPass.h.

◆ OpaqueSequence

vtkRenderPass* vtkShadowMapPass::OpaqueSequence
protected

Definition at line 153 of file vtkShadowMapPass.h.

◆ FrameBufferObject

vtkFrameBufferObject* vtkShadowMapPass::FrameBufferObject
protected

Graphics resources.

Definition at line 158 of file vtkShadowMapPass.h.

◆ ShadowMaps

vtkShadowMapPassTextures* vtkShadowMapPass::ShadowMaps
protected

Definition at line 160 of file vtkShadowMapPass.h.

◆ LightCameras

vtkShadowMapPassLightCameras* vtkShadowMapPass::LightCameras
protected

Definition at line 161 of file vtkShadowMapPass.h.

◆ LastRenderTime

vtkTimeStamp vtkShadowMapPass::LastRenderTime
protected

Definition at line 163 of file vtkShadowMapPass.h.

◆ FragmentDeclaration

std::string vtkShadowMapPass::FragmentDeclaration
protected

Definition at line 167 of file vtkShadowMapPass.h.

◆ FragmentImplementation

std::string vtkShadowMapPass::FragmentImplementation
protected

Definition at line 168 of file vtkShadowMapPass.h.

◆ ShadowTextureUnits

std::vector<int> vtkShadowMapPass::ShadowTextureUnits
protected

Definition at line 169 of file vtkShadowMapPass.h.

◆ ShadowTransforms

std::vector<double> vtkShadowMapPass::ShadowTransforms
protected

Definition at line 170 of file vtkShadowMapPass.h.

◆ ShadowAttenuation

std::vector<float> vtkShadowMapPass::ShadowAttenuation
protected

Definition at line 171 of file vtkShadowMapPass.h.

◆ ShadowParallel

std::vector<int> vtkShadowMapPass::ShadowParallel
protected

Definition at line 172 of file vtkShadowMapPass.h.


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