vtkSkybox.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 vtkSkybox_h
#define vtkSkybox_h

#include "vtkActor.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkSkybox : public vtkActor
{
public:
  static vtkSkybox* New();
  vtkTypeMacro(vtkSkybox, vtkActor);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  using Superclass::GetBounds;
  double* GetBounds() override;


  enum Projection
  {
    Cube,
    Sphere,
    Floor,
    StereoSphere
  };
  vtkGetMacro(Projection, int);
  vtkSetMacro(Projection, int);
  void SetProjectionToCube() { this->SetProjection(vtkSkybox::Cube); }
  void SetProjectionToSphere() { this->SetProjection(vtkSkybox::Sphere); }
  void SetProjectionToStereoSphere() { this->SetProjection(vtkSkybox::StereoSphere); }
  void SetProjectionToFloor() { this->SetProjection(vtkSkybox::Floor); }


  vtkSetVector4Macro(FloorPlane, float);
  vtkGetVector4Macro(FloorPlane, float);
  vtkSetVector3Macro(FloorRight, float);
  vtkGetVector3Macro(FloorRight, float);


  vtkGetVector2Macro(FloorTexCoordScale, float);
  vtkSetVector2Macro(FloorTexCoordScale, float);


  vtkGetMacro(GammaCorrect, bool);
  vtkSetMacro(GammaCorrect, bool);
  vtkBooleanMacro(GammaCorrect, bool);

protected:
  vtkSkybox();
  ~vtkSkybox() override;

  int Projection;
  float FloorPlane[4];
  float FloorRight[3];
  float FloorTexCoordScale[2];

  bool GammaCorrect = false;

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

VTK_ABI_NAMESPACE_END
#endif // vtkSkybox_h