vtkShadowMapPass.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkShadowMapPass_h
#define vtkShadowMapPass_h
 
#include "vtkOpenGLRenderPass.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO
#include <string>                      // For member variables.
#include <vector>                      // STL Header
 
VTK_ABI_NAMESPACE_BEGIN
class vtkOpenGLRenderWindow;
class vtkInformationIntegerKey;
class vtkCamera;
class vtkLight;
class vtkFrameBufferObject;
class vtkShadowMapPassTextures;     // internal
class vtkShadowMapPassLightCameras; // internal
class vtkShadowMapBakerPass;
class vtkInformationObjectBaseKey;
class vtkShaderProgram;
 
class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkShadowMapPass : public vtkOpenGLRenderPass
{
public:
  static vtkShadowMapPass* New();
  vtkTypeMacro(vtkShadowMapPass, vtkOpenGLRenderPass);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Render(const vtkRenderState* s) override;

  void ReleaseGraphicsResources(vtkWindow* w) override;


  vtkGetObjectMacro(ShadowMapBakerPass, vtkShadowMapBakerPass);
  virtual void SetShadowMapBakerPass(vtkShadowMapBakerPass* shadowMapBakerPass);

  VTK_DEPRECATED_IN_9_8_0("Useless GetDelegatePass() instead.")
  virtual vtkRenderPass* GetOpaqueSequence() { return this->GetDelegatePass(); }
 
  VTK_DEPRECATED_IN_9_8_0("Useless SetDelegatePass() instead.")
  virtual void SetOpaqueSequence(vtkRenderPass* opaqueSequence)
  {
    this->SetDelegatePass(opaqueSequence);
  }



  vtkGetObjectMacro(DelegatePass, vtkRenderPass);
  virtual void SetDelegatePass(vtkRenderPass* delegatePass);

  std::vector<double> ShadowMapTransforms() { return this->ShadowTransforms; }

  std::vector<int> GetShadowMapTextureUnits() { return this->ShadowTextureUnits; }
 
  VTK_DEPRECATED_IN_9_8_0("Useless key, do not use.")
  static vtkInformationObjectBaseKey* ShadowMapPass();

  static vtkInformationIntegerKey* RECEIVER();

  std::string GetFragmentDeclaration() { return this->FragmentDeclaration; }
  std::string GetFragmentImplementation() { return this->FragmentImplementation; }
 
  // vtkOpenGLRenderPass virtuals:
  bool PreReplaceShaderValues(std::string& vertexShader, std::string& geometryShader,
    std::string& fragmentShader, vtkAbstractMapper* mapper, vtkProp* prop) override;
  bool PostReplaceShaderValues(std::string& vertexShader, std::string& geometryShader,
    std::string& fragmentShader, vtkAbstractMapper* mapper, vtkProp* prop) override;
  bool SetShaderParameters(vtkShaderProgram* program, vtkAbstractMapper* mapper, vtkProp* prop,
    vtkOpenGLVertexArrayObject* VAO = nullptr) override;
 
protected:
  vtkShadowMapPass();

  ~vtkShadowMapPass() override;

  void CheckSupport(vtkOpenGLRenderWindow* w);
 
  vtkShadowMapBakerPass* ShadowMapBakerPass;
  vtkRenderPass* CompositeRGBAPass;

  vtkFrameBufferObject* FrameBufferObject;
 
  vtkShadowMapPassTextures* ShadowMaps;
  vtkShadowMapPassLightCameras* LightCameras;
 
  vtkTimeStamp LastRenderTime;
 
  // to store the shader code and settings
  void BuildShaderCode();
  std::string FragmentDeclaration;
  std::string FragmentImplementation;
  std::vector<int> ShadowTextureUnits;
  std::vector<double> ShadowTransforms;
  std::vector<float> ShadowAttenuation;
  std::vector<int> ShadowParallel;
 
private:
  vtkShadowMapPass(const vtkShadowMapPass&) = delete;
  void operator=(const vtkShadowMapPass&) = delete;
 
  static bool IsReceiver(vtkAbstractMapper* mapper, vtkProp* prop);
 
  vtkRenderPass* DelegatePass;
};
 
VTK_ABI_NAMESPACE_END
#endif