vtkShadowMapBakerPass.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 vtkShadowMapBakerPass_h
#define vtkShadowMapBakerPass_h

#include "vtkOpenGLRenderPass.h"
#include "vtkRenderingOpenGL2Module.h" // For export macro
#include "vtkSmartPointer.h"           // for ivars
#include "vtkWrappingHints.h"          // For VTK_MARSHALAUTO
#include <vector>                      // STL Header

VTK_ABI_NAMESPACE_BEGIN
class vtkOpenGLRenderWindow;
class vtkInformationIntegerKey;
class vtkCamera;
class vtkLight;
class vtkOpenGLFramebufferObject;
class vtkTextureObject;

class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkShadowMapBakerPass : public vtkOpenGLRenderPass
{
public:
  static vtkShadowMapBakerPass* New();
  vtkTypeMacro(vtkShadowMapBakerPass, vtkOpenGLRenderPass);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Render(const vtkRenderState* s) override;

  void ReleaseGraphicsResources(vtkWindow* w) override;


  vtkGetObjectMacro(OpaqueSequence, vtkRenderPass);
  virtual void SetOpaqueSequence(vtkRenderPass* opaqueSequence);


  vtkGetObjectMacro(CompositeZPass, vtkRenderPass);
  virtual void SetCompositeZPass(vtkRenderPass* compositeZPass);


  vtkSetMacro(Resolution, unsigned int);
  vtkGetMacro(Resolution, unsigned int);


  vtkSetMacro(ExponentialConstant, float);
  vtkGetMacro(ExponentialConstant, float);

  bool GetHasShadows();

  bool LightCreatesShadow(vtkLight* l);

  std::vector<vtkSmartPointer<vtkTextureObject>>* GetShadowMaps();

  std::vector<vtkSmartPointer<vtkCamera>>* GetLightCameras();

  bool GetNeedUpdate();

  // // Description:
  // INTERNAL USE ONLY.
  // Internally used by vtkShadowMapBakerPass and vtkShadowMapPass.
  //
  // Set NeedUpate to false. Called by vtkShadowMapPass.
  void SetUpToDate();

protected:
  vtkShadowMapBakerPass();

  ~vtkShadowMapBakerPass() override;

  // vtkOpenGLRenderPass virtuals:
  bool PreReplaceShaderValues(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;

  void PointNearFar(
    double* v, double* pt, double* dir, double& mNear, double& mFar, bool initialized);

  void BoxNearFar(double* bb, double* pt, double* dir, double& mNear, double& mFar);

  void BuildCameraLight(vtkLight* light, double* boundingBox, vtkCamera* lcamera);

  void CheckSupport(vtkOpenGLRenderWindow* w);

  vtkRenderPass* OpaqueSequence;

  vtkRenderPass* CompositeZPass;

  unsigned int Resolution;
  float ExponentialConstant{ 11.0f };

  bool HasShadows;

  vtkOpenGLFramebufferObject* FrameBufferObject;

  std::vector<vtkSmartPointer<vtkTextureObject>>* ShadowMaps;
  std::vector<vtkSmartPointer<vtkCamera>>* LightCameras;

  vtkTimeStamp LastRenderTime;
  bool NeedUpdate;
  size_t CurrentLightIndex;

private:
  vtkShadowMapBakerPass(const vtkShadowMapBakerPass&) = delete;
  void operator=(const vtkShadowMapBakerPass&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif