VTK
vtkShadowMapPass.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkShadowMapPass.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
44 #ifndef vtkShadowMapPass_h
45 #define vtkShadowMapPass_h
46 
47 #include "vtkRenderingOpenGL2Module.h" // For export macro
48 #include "vtkOpenGLRenderPass.h"
49 #include <vector> // STL Header
50 #include <string> // For member variables.
51 
54 class vtkCamera;
55 class vtkLight;
56 class vtkFrameBufferObject;
57 class vtkShadowMapPassTextures; // internal
58 class vtkShadowMapPassLightCameras; // internal
61 class vtkShaderProgram;
62 
63 class VTKRENDERINGOPENGL2_EXPORT vtkShadowMapPass : public vtkOpenGLRenderPass
64 {
65 public:
66  static vtkShadowMapPass *New();
68  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
74  void Render(const vtkRenderState *s) override;
75 
82 
84 
90  vtkGetObjectMacro(ShadowMapBakerPass,vtkShadowMapBakerPass);
91  virtual void SetShadowMapBakerPass(
92  vtkShadowMapBakerPass *shadowMapBakerPass);
94 
96 
100  vtkGetObjectMacro(OpaqueSequence,vtkRenderPass);
101  virtual void SetOpaqueSequence(vtkRenderPass *opaqueSequence);
103 
108  std::vector<double> ShadowMapTransforms() {
109  return this->ShadowTransforms; }
110 
116  std::vector<int> GetShadowMapTextureUnits() {
117  return this->ShadowTextureUnits; }
118 
123 
129  return this->FragmentDeclaration; }
131  return this->FragmentImplementation; }
132 
133  // vtkOpenGLRenderPass virtuals:
135  std::string &geometryShader,
136  std::string &fragmentShader,
137  vtkAbstractMapper *mapper,
138  vtkProp *prop) override;
140  std::string &geometryShader,
141  std::string &fragmentShader,
142  vtkAbstractMapper *mapper,
143  vtkProp *prop) override;
145  vtkAbstractMapper *mapper, vtkProp *prop,
146  vtkOpenGLVertexArrayObject* VAO = nullptr) override;
147 
148  protected:
153 
157  ~vtkShadowMapPass() override;
158 
164 
167 
169 
173  vtkFrameBufferObject *FrameBufferObject;
174 
175  vtkShadowMapPassTextures *ShadowMaps;
176  vtkShadowMapPassLightCameras *LightCameras;
177 
179 
180  // to store the shader code and settings
184  std::vector<int> ShadowTextureUnits;
185  std::vector<double> ShadowTransforms;
186  std::vector<float> ShadowAttenuation;
187  std::vector<int> ShadowParallel;
188 
189 private:
190  vtkShadowMapPass(const vtkShadowMapPass&) = delete;
191  void operator=(const vtkShadowMapPass&) = delete;
192 };
193 
194 #endif
vtkShadowMapPass::OpaqueSequence
vtkRenderPass * OpaqueSequence
Definition: vtkShadowMapPass.h:168
vtkShadowMapPass::ShadowMapPass
static vtkInformationObjectBaseKey * ShadowMapPass()
this key will contain the shadow map pass
vtkLight
a virtual light for 3D rendering
Definition: vtkLight.h:63
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkShadowMapPass::ShadowMaps
vtkShadowMapPassTextures * ShadowMaps
Definition: vtkShadowMapPass.h:175
vtkShadowMapPass::ShadowTextureUnits
std::vector< int > ShadowTextureUnits
Definition: vtkShadowMapPass.h:184
vtkShadowMapPass::FragmentImplementation
std::string FragmentImplementation
Definition: vtkShadowMapPass.h:183
vtkShadowMapPass::CheckSupport
void CheckSupport(vtkOpenGLRenderWindow *w)
Check if shadow mapping is supported by the current OpenGL context.
vtkShadowMapPass::SetShaderParameters
bool SetShaderParameters(vtkShaderProgram *program, vtkAbstractMapper *mapper, vtkProp *prop, vtkOpenGLVertexArrayObject *VAO=nullptr) override
Update the uniforms of the shader program.
vtkShadowMapPass::ShadowMapTransforms
std::vector< double > ShadowMapTransforms()
get the matricies for all the shadow maps.
Definition: vtkShadowMapPass.h:108
vtkShadowMapPass::GetFragmentImplementation
std::string GetFragmentImplementation()
Definition: vtkShadowMapPass.h:130
vtkShadowMapPass::Render
void Render(const vtkRenderState *s) override
Perform rendering according to a render state s.
vtkShadowMapPass::SetShadowMapBakerPass
virtual void SetShadowMapBakerPass(vtkShadowMapBakerPass *shadowMapBakerPass)
vtkShadowMapPass::~vtkShadowMapPass
~vtkShadowMapPass() override
Destructor.
vtkShadowMapPass
Implement a shadow mapping render pass.
Definition: vtkShadowMapPass.h:64
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
vtkShadowMapPass::FragmentDeclaration
std::string FragmentDeclaration
Definition: vtkShadowMapPass.h:182
vtkShadowMapPass::LastRenderTime
vtkTimeStamp LastRenderTime
Definition: vtkShadowMapPass.h:178
vtkShaderProgram
The ShaderProgram uses one or more Shader objects.
Definition: vtkShaderProgram.h:48
vtkInformationObjectBaseKey
Key for vtkObjectBase values.
Definition: vtkInformationObjectBaseKey.h:37
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:35
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkCamera
a virtual camera for 3D rendering
Definition: vtkCamera.h:51
vtkShadowMapPass::ShadowMapBakerPass
vtkShadowMapBakerPass * ShadowMapBakerPass
Definition: vtkShadowMapPass.h:165
vtkShadowMapPass::CompositeRGBAPass
vtkRenderPass * CompositeRGBAPass
Definition: vtkShadowMapPass.h:166
vtkShadowMapPass::New
static vtkShadowMapPass * New()
vtkShadowMapPass::GetFragmentDeclaration
std::string GetFragmentDeclaration()
Get the shader code to compute light factors based on a mappers vertexVC variable.
Definition: vtkShadowMapPass.h:128
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkX3D::string
@ string
Definition: vtkX3D.h:490
vtkShadowMapPass::PreReplaceShaderValues
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.
vtkShadowMapPass::BuildShaderCode
void BuildShaderCode()
vtkShadowMapPass::ShadowParallel
std::vector< int > ShadowParallel
Definition: vtkShadowMapPass.h:187
vtkOpenGLRenderPass
Abstract render pass with shader modifications.
Definition: vtkOpenGLRenderPass.h:39
vtkShadowMapPass::PostReplaceShaderValues
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.
vtkOpenGLRenderPass.h
vtkOpenGLRenderWindow
OpenGL rendering window.
Definition: vtkOpenGLRenderWindow.h:54
vtkShadowMapPass::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkShadowMapPass::LightCameras
vtkShadowMapPassLightCameras * LightCameras
Definition: vtkShadowMapPass.h:176
vtkShadowMapPass::FrameBufferObject
vtkFrameBufferObject * FrameBufferObject
Graphics resources.
Definition: vtkShadowMapPass.h:173
vtkRenderState
Context in which a vtkRenderPass will render.
Definition: vtkRenderState.h:41
vtkShadowMapPass::ShadowAttenuation
std::vector< float > ShadowAttenuation
Definition: vtkShadowMapPass.h:186
vtkShadowMapPass::GetShadowMapTextureUnits
std::vector< int > GetShadowMapTextureUnits()
get the texture units for the shadow maps for each light.
Definition: vtkShadowMapPass.h:116
vtkShadowMapPass::ShadowTransforms
std::vector< double > ShadowTransforms
Definition: vtkShadowMapPass.h:185
vtkOpenGLVertexArrayObject
The VertexArrayObject class uses, or emulates, vertex array objects.
Definition: vtkOpenGLVertexArrayObject.h:37
vtkShadowMapPass::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *w) override
Release graphics resources and ask components to release their own resources.
vtkShadowMapBakerPass
Implement a builder of shadow map pass.
Definition: vtkShadowMapBakerPass.h:60
vtkShadowMapPass::SetOpaqueSequence
virtual void SetOpaqueSequence(vtkRenderPass *opaqueSequence)
vtkShadowMapPass::vtkShadowMapPass
vtkShadowMapPass()
Default constructor.
vtkAbstractMapper
abstract class specifies interface to map data
Definition: vtkAbstractMapper.h:56
vtkRenderPass
Perform part of the rendering of a vtkRenderer.
Definition: vtkRenderPass.h:59